Skip to content

API ReferenceView as MarkdownView this page as plain textOpen in ClaudeAsk questions about this pageOpen in ChatGPTAsk questions about this page

This section documents the Reson8 API endpoints. All endpoints are available at api.reson8.dev.

Endpoints

  • Auth - OAuth2 token endpoint for obtaining access tokens.
  • Speech to Text - Realtime, prerecorded, and turn-level transcription. See Documentation → Speech to Text for guidance on which to use.

Page Structure

Each endpoint page follows a consistent layout:

  • Request - Headers, query parameters, and example usage.
  • Response - Field descriptions and example payloads. Some fields are included only depending on query parameters.
  • Sending / Receiving Messages - For WebSocket endpoints, the messages that can be sent to and received from the server.
  • Errors - HTTP status codes and error codes returned by the endpoint.