Syllable API reference

Use the Syllable API to create and manage agents, conversations, sessions, channels, campaigns, Insights workflows, and other platform resources. Choose a resource in the left navigation to see its endpoints.

Base URL

All API requests use this base URL:

https://api.syllable.cloud

Paths shown on endpoint pages are relative to this URL.

Authentication

Create an API token in the Syllable Console, then send its value with every request in the Syllable-API-Key header. The Console calls this credential an API token, while the HTTP header retains the API-key name. Keep the token server-side and load it from an environment variable or secret manager.

export SYLLABLE_API_KEY="your-api-key"

Make your first request

List the agents available to your organization:

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

See Agent List for every parameter and response schema.

Use an SDK

The endpoint pages include copyable examples for TypeScript, Python, and cURL. Install the SDK for your language, set your API key, and select the matching language above the code example.

npm install syllable-sdk

pip install syllable-sdk

Pagination

List endpoints generally accept a zero-based page and a limit. Start with page=0, keep the limit reasonable, and request subsequent pages until the response contains no more results. Endpoint pages document any resource-specific filters and ordering options alongside each parameter.

Responses and errors

Each endpoint page groups responses by HTTP status and keeps nested response fields with their parent schema. A 2xx status indicates success. A 4xx status means the request or credentials need attention; a 5xx status indicates a server-side failure. Use the response body and request identifiers when troubleshooting.

Versioning and deprecated endpoints

The current API is served under /api/v1. Existing deprecated endpoint URLs remain available and redirect to their supported replacements, so integrations and bookmarked links do not land on missing pages.