# TRaX Developer Docs

> TRaX is a cloud live-streaming production platform (multi-source studio, cloud encoder, multi-destination egress, chat, recording). This file is the machine-readable map of the PUBLIC developer documentation and API for building clients and integrations.

The public REST API is OpenAPI 3.0 and is served, unauthenticated, at [https://api.traxstreaming.live/v1/openapi.json](https://api.traxstreaming.live/v1/openapi.json). Authenticate calls with a user API key (`Authorization: Bearer sk_live_...`). Each link below points to the raw Markdown of a doc; drop the `.md` for the human page.

## Guides

- [Our API philosophy](https://docs.traxstreaming.live/guides/api-philosophy.md)
- [Getting started](https://docs.traxstreaming.live/guides/getting-started.md)
- [Build a client](https://docs.traxstreaming.live/guides/build-a-client.md)
- [Quickstart: push a feed with OBS or ffmpeg](https://docs.traxstreaming.live/guides/obs-ffmpeg-quickstart.md)
- [Contribute a camera from a phone (SRT)](https://docs.traxstreaming.live/guides/contribute-from-a-phone.md)
- [Go live from a phone over /v1](https://docs.traxstreaming.live/guides/go-live-from-a-phone.md)
- [SDK quickstart: TypeScript / JavaScript](https://docs.traxstreaming.live/guides/sdk-typescript.md)
- [Stream to a live input from your app](https://docs.traxstreaming.live/guides/stream-to-a-live-input.md)
- [Control the canvas over /v1](https://docs.traxstreaming.live/guides/control-the-canvas.md)
- [Control the mixer from your app](https://docs.traxstreaming.live/guides/control-the-mixer.md)
- [Drive the studio canvas](https://docs.traxstreaming.live/guides/drive-the-canvas.md)
- [Monitor the program output (WHEP)](https://docs.traxstreaming.live/guides/monitor-the-program.md)
- [SDK quickstart: Swift (iOS / macOS)](https://docs.traxstreaming.live/guides/sdk-swift.md)
- [Set the program resolution and frame rate](https://docs.traxstreaming.live/guides/set-the-output-format.md)
- [SDK quickstart: Kotlin (Android)](https://docs.traxstreaming.live/guides/sdk-kotlin.md)
- [Use the media library from your app](https://docs.traxstreaming.live/guides/media-library.md)
- [Bring your own storage: setup](https://docs.traxstreaming.live/guides/byo-storage-setup.md)
- [Bring your own storage: provider recipes](https://docs.traxstreaming.live/guides/byo-storage-providers.md)
- [Cloud recording to your bucket](https://docs.traxstreaming.live/guides/cloud-recording.md)
- [Connect an AI agent (hosted MCP)](https://docs.traxstreaming.live/guides/connect-ai-agent.md)
- [Put TRaX chat on your own site](https://docs.traxstreaming.live/guides/embed-chat.md)
- [Set YouTube broadcast settings](https://docs.traxstreaming.live/guides/youtube-broadcast-settings.md)
- [Account & API keys over the API](https://docs.traxstreaming.live/guides/account-and-api-keys.md)
- [Link a platform account from a mobile app](https://docs.traxstreaming.live/guides/link-a-platform-account.md)
- [Manual stream-key connections](https://docs.traxstreaming.live/guides/manual-connections.md)
- [Delete your account or remove your data](https://docs.traxstreaming.live/guides/delete-your-account.md)

## API Reference

- [Developer API](https://docs.traxstreaming.live/reference/public-api.md)
- [API console (Try it)](https://docs.traxstreaming.live/reference/api-console.md)
- [Authentication & session tokens](https://docs.traxstreaming.live/reference/authentication.md)
- [SRT: the streamid contract](https://docs.traxstreaming.live/reference/srt-streamid.md)
- [RTMP / RTMPS: query-string credentials](https://docs.traxstreaming.live/reference/rtmp.md)
- [WHIP / WHEP: WebRTC publish & play](https://docs.traxstreaming.live/reference/whip-whep.md)
- [API reference (/v1)](https://docs.traxstreaming.live/reference/api/v1.md)
- [Stream paths](https://docs.traxstreaming.live/reference/path-grammar.md)
- [Errors & status codes](https://docs.traxstreaming.live/reference/errors.md)
- [Pagination](https://docs.traxstreaming.live/reference/pagination.md)
- [Rate limits](https://docs.traxstreaming.live/reference/rate-limits.md)
- [Versioning & compatibility](https://docs.traxstreaming.live/reference/versioning.md)
- [Webhooks](https://docs.traxstreaming.live/reference/webhooks.md)
- [Embed chat](https://docs.traxstreaming.live/reference/embed-chat.md)
- [Roadmap & status](https://docs.traxstreaming.live/reference/roadmap.md)

## API

- [OpenAPI 3.0 spec (JSON)](https://api.traxstreaming.live/v1/openapi.json)
- [Full docs, single file](https://docs.traxstreaming.live/llms-full.txt)