TypeScript client
Provider gateway
Open provider socket
Open a bounded vendor WebSocket session using a customer key. Returns a session handle immediately; the published proxy request and byte fees apply.
POST
TypeScript client
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Organization id (UUID). Discover ids via the list organizations endpoint or the agent context.
AI vendor to access using this organisation connection: OpenRouter or ElevenLabs.
Available options:
openrouter, elevenlabs Body
application/json
Response
Success
a Universally Unique Identifier
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Available options:
reserved, queued, preparing, dispatched, completed, uncertain, failed, billing_hold