Skip to main content

Authentication

To ensure secure access to the Talkscriber API, API Key based authentication is implemented. This section provides details on obtaining and using an API Key for secure communication.

Obtaining an API Key​

To get an API Key, follow these steps:

  1. Sign Up: Create an account on the Talkscriber dashboard.
  2. Navigate to API Keys: Go to your account and find the API section.
  3. Generate API Keys: Generate a new API key from the API settings page.

Using the API Key​

Include the API Key in the initial message when establishing a WebSocket connection. The API Key should be passed in the auth field.

Example Initial Message with Authentication​

{
    "language": "en",
    "task": "transcribe",
    "auth": "<Your API Key Here>"
}

Error Handling​

If the API Key is invalid, the server will respond with an error message, and the connection will be terminated.

Example Error Response​

{
    "uid": "2c0b8c68-c708-4d44-9c0e-01b7871458a7",
    "message": "UNAUTHORIZED"
}

Best Practices​

  • Secure Storage: Store your API keys securely. Avoid hardcoding them in your application's source code.
  • Rotate API Keys: Regularly rotate your API Keys to minimize security risks.