Soniox
Docs

Create temporary API key

Create a temporary API key.

POST
/v1/auth/temporary-api-key

Authorization

AuthorizationRequiredBearer <token>

In: header

Request body

application/jsonRequired
usage_typeRequiredstring

The intended usage of the temporary API key. Valid options: "transcribe_websocket"

expires_in_secondsRequiredinteger

The expiration time of the temporary API key. The maximum expiration time is 3600 seconds.

Maximum: 3600
client_reference_idstring

A string provided by the client to identify the future API call (that uses the returned temporary API key) in API logs. It can be an ID, a JSON string, or any other text. The value does not have to be unique. If not provided, it will remain unspecified.

Response body

201

Created temporary API key.

api_keyRequiredstring

The created temporary API key.

expires_atRequiredstring

The expiration datetime of the API key.

Format: "date-time"

Errors

Created temporary API key.

{
  "api_key": "temp:WYJ67RBEFUWQXXPKYPD2UGXKWB",
  "expires_at": "2025-02-22T22:47:37.150Z"
}