Agent guide

A short map for agents that design voices and call speech.

Start here

  • Quickstart: key scopes, design, refine, lock, HTTP and WebSocket speech.
  • OpenAPI JSON: gateway paths, request schemas and auth scopes.
  • Data handling: storage and provider disclosures.

Use a bearer API key in the Authorization header. Never put credentials in URLs. Keep the returned key secret: creation and rotation return it once.

Voice candidates expire after the configured candidate TTL (24 hours by default). A locked voice keeps its reference audio until deleted. Read the data-handling page for current storage and provider disclosures before sending content.