v2

latestOpenAPI 3.1.02026-08-0513206146.6 KB

Auth

Create a Session Token

<Callout intent="warning"> The endpoints exposed here are currently in **Beta**! As we continue to build our initial offering, these endpoints may implement breaking changes. Be sure to check back for our change log regularly as a precaution. </Callout>

Exchange your API key for a short-lived bearer JWT. Send the API key as Authorization: Bearer <api_key>; no request body is needed. The returned sessionJwt is valid for 15 minutes (the TTL is not echoed in the response) and must be sent in the Authorization header on every subsequent authenticated request. Refresh by calling this endpoint again before expiry.

See Authentication for more details.

post/v0/auth/token

Headers

Authorizationstring required

Agora access key (cleartext), sent as Authorization: Bearer <accessKey>. Used only by POST /v0/auth/token to mint a session JWT.

Response

sessionJwtstring required

Short-lived session JWT. Send it as Authorization: Bearer <sessionJwt> on every authenticated endpoint.

All 13 operations