# Airframe

> Airframe is live motion graphics in the browser: design compositions on a timeline, publish them as versions, play them on outputs loaded into switchers such as OBS and vMix, and run them from a control room or the REST API and control WebSocket.

The API's base URL is https://api.airframe.tv/v1. Authenticate with a workspace API key as `Authorization: Bearer afk_…`. Its OpenAPI 3.1 spec is at https://api.airframe.tv/v1/openapi.json. Each link below is a page as Markdown; the same page is on the site without `/md` and `.md`. https://docs.airframe.tv/llms-full.txt has every page in one file.

## API reference

- [API overview](https://docs.airframe.tv/md/api.md): Base URL, resources and commands, and the OpenAPI spec
- [Authentication](https://docs.airframe.tv/md/api/authentication.md): Workspace API keys, scoped to all outputs or chosen ones
- [Errors and rate limits](https://docs.airframe.tv/md/api/errors.md): Error codes, failed commands and Retry-After
- [Commands](https://docs.airframe.tv/md/api/commands.md): in, out, update, invoke and timer
- [Run commands](https://docs.airframe.tv/md/api/run-commands.md): POST a batch of commands, all or nothing
- [Get the output's state](https://docs.airframe.tv/md/api/state.md): What's on air, its data, timers and live instances
- [Control WebSocket](https://docs.airframe.tv/md/api/websocket.md): Live state and patches, and commands with acks
- [Get the output's composition](https://docs.airframe.tv/md/api/get-composition.md): The composition and version an output plays
- [List instances](https://docs.airframe.tv/md/api/list-instances.md): The instances prepared for an output
- [Create an instance](https://docs.airframe.tv/md/api/create-instance.md): Prepare a component with saved data
- [Update an instance](https://docs.airframe.tv/md/api/update-instance.md): Rename it or change its data
- [Delete an instance](https://docs.airframe.tv/md/api/delete-instance.md): Remove an instance you no longer need

## Guides

- [What Airframe is](https://docs.airframe.tv/md/guides.md): Compositions, versions, outputs and the control room
- [Your first graphic on air](https://docs.airframe.tv/md/guides/first-graphic.md): Build, publish, add an output and take it
- [Layers, components and data](https://docs.airframe.tv/md/guides/compositions.md): How a composition is put together, and where data goes
- [Versions and publishing](https://docs.airframe.tv/md/guides/versions.md): Publish immutable versions and choose which one an output plays
- [Assets: images and fonts](https://docs.airframe.tv/md/guides/assets.md): Upload to the library, sort into folders and use them by key
- [Add an output to OBS Studio](https://docs.airframe.tv/md/guides/obs.md): Browser source settings for a transparent, live output
- [The control room](https://docs.airframe.tv/md/guides/control-room.md): Take, Clear, instances, timers and keyboard shortcuts
- [Build a control panel in Retool](https://docs.airframe.tv/md/guides/retool.md): Take, clear and watch an output from your own Retool app
- [Roles: who can do what](https://docs.airframe.tv/md/guides/roles.md): Owners, Admins, Editors and Operators

## Optional

- [OpenAPI spec](https://api.airframe.tv/v1/openapi.json): The API's machine-readable schema