API Tokens

API tokens authenticate requests from your server to the Syllable REST API and SDKs. The Console calls the credential an API token; your application sends that token in the Syllable-API-Key request header.

Each user can have one API token per organization. You need a Syllable account with access to the organization whose API you want to use.

Create a token

1. Open API Tokens in the Syllable Console, or select your profile in the upper-right corner of the Console and choose API tokens.
2. Find the organization you want to access and select Generate.
3. Select Copy and save the token in a secure location. The Console displays the token only once.

Use the token

Keep the token server-side and load it from an environment variable or secret manager. Never commit it to source control, expose it in browser code, or write it to logs.

export SYLLABLE_API_KEY="your-api-token"

Send the value in the Syllable-API-Key header when calling the REST API:

curl --request GET \
  --url "https://api.syllable.cloud/api/v1/agents/?page=0&limit=25" \
  --header "Syllable-API-Key: ${SYLLABLE_API_KEY}"

For client configuration examples, see the SDK overview.

Rotate or revoke a token

The API Tokens page shows when the current token was created and when it expires. Select Revoke to invalidate it. Because each user can have only one token per organization, coordinate the change with anyone who maintains services that use your token, then generate and securely distribute the replacement.