Skip to main content
The Synthra API provides programmatic access to all platform capabilities. Built on REST principles with JSON request/response format.

Base URL

Authentication

All API requests require authentication via Bearer token:

Request Format

Response Format

All responses follow a consistent structure:

Error Responses

Rate Limits

Rate limit headers included in every response:

Pagination

List endpoints support cursor-based pagination:
Response includes pagination metadata:

Versioning

The API is versioned via URL path. Current version: v1 Breaking changes will be released as new versions (v2, v3, etc.)

SDKs

Official SDKs available:
  • TypeScript/JavaScript: npm install @synthra/agent
  • Python: pip install synthra-sdk
API keys can be generated from the Developer Dashboard. Store keys securely and never expose them in client-side code.