The Speak AI API exposes 2 authentication endpoints under the base URL https://api.speakai.co/v1. Every request needs the x-speakai-key and x-access-token headers described in Authentication.
All Speak AI API operations require two headers:
x-speakai-key: your_speak_ai_api_key_here
x-access-token: generated_access_token
Authentication Flow
-
Get Access Token: Call
POST /v1/auth/accessTokenwith yourx-speakai-keyandContent-Type: application/jsonheaders. The request body should be{}(empty JSON) when using API key authentication. On success, the response returns youraccessTokenandrefreshTokeninside thedataobject. -
Use Access Token: Include the access token in the
x-access-tokenheader for all subsequent API calls, alongside yourx-speakai-key. -
Refresh Token: When the access token expires, call
POST /v1/auth/refreshTokenwith bothx-speakai-keyandx-access-tokenheaders (include the expired access token), and pass{"refreshToken": "..."}in the request body. You will receive a newaccessTokenandrefreshTokenpair.
Example Response
{
"data": {
"email": "you@example.com",
"accessToken": "eyJhbG...",
"refreshToken": "eyJhbG..."
}
}Token Expiry
| Token | Expiry | Action on Expiry |
|---|---|---|
| Access Token | 80 minutes | Call Refresh Token endpoint |
| Refresh Token | 24 hours | Re-authenticate via Get Access Token |
Rate Limits
Both /v1/auth/accessToken and /v1/auth/refreshToken are limited to 5 requests per 60 seconds. Exceeding this returns 429 Too Many Requests.
Error Handling
- Expired Access Token: Returns
401 Unauthorized. Use the Refresh Token endpoint to obtain a new token pair. - Expired Refresh Token: Returns an error response. Re-authenticate from scratch via the Get Access Token endpoint.
- Rate Limited: Returns
429. Wait and retry, implement exponential backoff for automated clients.
What can you do with the authentication endpoints?
Speak AI groups these 2 endpoints under the authentication resource. Each entry below links to the full reference for that endpoint further down this page.
Get Access Token
/auth/accessTokenThis endpoint allows you to obtain an access token by providing the necessary authentication credentials.
The request body for this endpoint should include the your authentication credentials. Upon successful authentication, the server will respond with a status of “success” and provide the your email, access token, and refresh token in the response data.
Request body
Send an empty JSON object, {}, with Content-Type: application/json.
curl -X POST 'https://api.speakai.co/v1/auth/accessToken' \
-H 'x-speakai-key: sk_test_speak_0000000000000000' \
-H 'Content-Type: application/json' \
-d '{}'200 OK
Response body, application/json.
| Field | Type |
|---|---|
status |
string |
data |
object |
data.email |
string |
data.accessToken |
string |
data.refreshToken |
string |
Example response (Get Access Token), application/json.
{
"status": "success",
"data": {
"email": "your_email_id",
"accessToken": "access_token",
"refreshToken": "refresh_token"
}
}404 Not Found
Response body, application/json.
| Field | Type |
|---|---|
status |
string |
requestId |
string |
code |
integer |
message |
string |
hints |
string[] |
Example response (Get Access Token - Failure (No value found for Speak AI Key)), application/json.
{
"status": "failed",
"requestId": "ca665625-645e-438a-867d-366a6e3f133a",
"code": 401,
"message": "The authorization api key provided for the request is invalid.",
"hints": [
"The authorization api key provided for the request is invalid."
]
}Example response (Get Access Token - Failure - Invalid API Key), application/json.
{
"status": "failed",
"requestId": "358bc130-e798-41c2-9864-2cd2ce9b766d",
"code": 401,
"message": "The authorization api key provided for the request is invalid.",
"hints": [
"The authorization api key provided for the request is invalid."
]
}Refresh Token
/auth/refreshTokenThis endpoint is used to refresh the access token by providing the refresh token in the request body.
The refreshToken expires in 24 hour.
Request Body
- refreshToken (string, required): The refresh token used to obtain a new access token.
Response
- status (string): Indicates the status of the request, where “success” means the request was successful.
- data (object): Contains the new access token and refresh token.
- accessToken (string): The new access token.
- refreshToken (string): The new refresh token.
Request body
Field types and names come from the request body the spec records. The spec does not mark request body fields as required, so read this as the shape the endpoint accepts rather than a required field list.
| Field | Type |
|---|---|
refreshToken |
string |
curl -X POST 'https://api.speakai.co/v1/auth/refreshToken' \
-H 'x-speakai-key: sk_test_speak_0000000000000000' \
-H 'x-access-token: eyJhbGciOiJIUzI1NiJ9.test-access-token.0000000000' \
-H 'Content-Type: application/json' \
-d '{
"refreshToken": "refreshToken"
}'200 OK
Response body, application/json.
| Field | Type |
|---|---|
status |
string |
data |
object |
data.accessToken |
string |
data.refreshToken |
string |
Example response (Refresh Token), application/json.
{
"status": "success",
"data": {
"accessToken": "new_access_token",
"refreshToken": "new_refresh_token"
}
}404 Not Found
Response body, application/json.
| Field | Type |
|---|---|
status |
string |
requestId |
string |
code |
integer |
message |
string |
Example response (Refresh Token - Failure - Invalid / Expired Token), application/json.
{
"status": "failed",
"requestId": "3fcf7e0c-a977-4c37-bae5-a72485206cd0",
"code": 404,
"message": "We were unable to find a valid token. Your token may have expired or invalid. Please contact development team."
}Related pages
- API reference for the base URL, authentication, and the error format.
- Upload audio and video to Speak AI and read insights
- Create and update live transcription sessions in Speak AI
- Analyze text notes with the Speak AI text endpoints
- Export Speak AI transcripts and insights to a file
Get an API key on the Speak AI developer page.