Realtime

Create client secret

Changed on

Create a Realtime client secret with an associated session configuration.

Client secrets are short-lived tokens that can be passed to a client app, such as a web frontend or mobile client, which grants access to the Realtime API without leaking your main API key. You can configure a custom TTL for each client secret.

You can also attach session configuration options to the client secret, which will be applied to any sessions created using that client secret, but these can also be overridden by the client connection.

Learn more about authentication with client secrets over WebRTC.

Returns the created client secret and the effective session object. The client secret is a string that looks like ek_1234.

post/realtime/client_secrets

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/realtime/client_secrets
  • Auth
    HTTP bearer

Request body

RealtimeCreateClientSecretRequest required(unresolved $ref)

Response

Client secret created successfully.

valuestring required

The generated client secret value.

expires_atinteger required

Expiration timestamp for the client secret, in seconds since epoch.

Changes

  • 6f5c52c2ff04Revision changes
    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status