Integration scenarios

We invite you to choose one of three possible scenarios that best suits your needs.

I. System as user

In this scenario, the users of your system are not differentiated. When your end-user uploads a file, it will be treated as a file uploaded by your system. If it is necessary for your use case to separate users, then you should either implement user management on your side or select another integration scenario.

A simplified possible usage scenario:

1. You configure the connection between GoSpeech and your system.
2. Your system uploads the file.
3. Your system gets a list of all Records.
4. Your system gets a record status update.
5. Your system gets the Transcript in JSON (see 🔍Transcript reference), DOCX, TXT, PDF formats.
6. Your system deletes the record.

II. Integration with user management and access to GoSpeech interface

Your end-user have their own Managed User GoSpeech accounts. These accounts are created through API by your system. Managed userd can't login to GoSpeech as a regular user with a login form as there is no username-password pair for them. Yet, managed users can still access GoSpeech Client interface.

A simplified possible usage scenario:

1. You configure the connection between GoSpeech and your system.
2. You add your end-users with Create managed user API.
3. Your end-user initiates file upload from your system.
4. The file is sent to GoSpeech.
5. This file is displayed in your system interface and its status is being updated (see Notifications to learn how to handle status updating).
6. If the file is recognized, the end-user can open the Record in GoSpeech interface. See Record Statuses to learn about the record lifecycle.
7. Your end-user also is able to open their Worklist in GoSpeech and use other features of the GoSpeech Client.
8. The Developer is able to remove their end-users from GoSpeech.

III. Integration with self-sufficient users

To upload a Record from your system to GoSpeech, the user must be authorized. If that prerequisite is not met, your system redirects them to GoSpeech Login page.

A simplified possible usage scenario:

1. You configure the connection between GoSpeech and your system.
2. End-user registers in GoSpeech directly on their own with username-password pair or with SSO.
3. Your end-user initiates file upload from your system.
4. Your system redirects end-user to GoSpeech Login page.
5. End-user logs into GoSpeech, is redirected and the upload starts.

IV. API Key Authentication

As an alternative to OAuth authentication, users may generate an API Key in their GoSpeech account and use it to authenticate requests to GoSpeech services. Recommended for Server-to-Server Integrations.

Key characteristics:

• An API Key consists of a private key that is displayed only once when generated.
• The private key must be stored securely by the integrating system.
• GoSpeech does not store the private key and cannot display it again.
• If the private key is lost, a new key must be generated.
• Regenerating an API Key immediately invalidates the previously generated key.

Typical use cases:

• Server-to-server integrations.
• Background processing services.
• Internal automation tools.
• Trusted backend applications.