Skip to main content

API Reference

The Turnix API is organized around REST principles. It features predictable, resource-oriented URLs, uses standard HTTP methods (like GET, POST, DELETE), returns JSON-encoded responses, and supports form-encoded request bodies where appropriate.

πŸ” Authentication​

All API requests must be authenticated using a Bearer Token provided in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Each token is associated with a specific organization and project, so you don’t need to pass them explicitly in every request. The token also defines the scope of access:

  • Project-level tokens grant access to endpoints scoped to a specific project (e.g., ICE credentials, rooms).
  • Organization-level tokens may be used to access shared or administrative APIs (if supported).

πŸ“š What to Expect​

  • Base URL: https://turnix.io/api/v1/
  • Format: All requests and responses are in JSON unless otherwise noted
  • Errors: Standard HTTP status codes are used to indicate success or failure

Refer to each endpoint's documentation for example requests, responses, and optional parameters.