Documentation

API Reference

Authentication

All API requests require a Bearer token:

Authorization: Bearer YOUR_API_KEY

Endpoints

POST /v1/sessions

Create a new voice session.

// Request
{
  "backendUrl": "https://your-server.com/voice",  // REQUIRED - we POST transcripts here
  "backendToken": "your-token",                   // optional auth for your backend
  "responseMode": "audio",                        // optional: "text" | "audio" | "both"
  "tts": {
    "voice": "nova",                              // optional
    "speed": 1.0                                  // optional
  }
}

// Response
{
  "sessionId": "...",
  "websocketUrl": "wss://talkwire.io/v1/stream/...",
  "expiresAt": "..."
}

// We POST to your backendUrl:
// { "transcript": "user's speech", "sessionId": "..." }
// You return: { "response": "AI's reply" }
// We TTS it and stream audio back to client

GET /v1/sessions/:id

Get session information.

DELETE /v1/sessions/:id

End a session.

GET /v1/me

Get your API key information.

GET /v1/usage

Get your usage statistics.