> ## Documentation Index > Fetch the complete documentation index at: https://docs.reactor.inc/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > To build and serve your own model, start at /deploy/development/quickstart and /deploy/development/overview. Deploying is the default path: reactor init scaffolds a workspace, reactor auth login authenticates, and reactor model deploy registers the model, publishes the release with the weights/ folder, and activates it on Reactor's GPUs, in one command from that workspace. Docker must be running, because the publish step builds the image locally. Bump model.version in reactor.yaml before redeploying a change, because a release that already has an image is reactivated as it is. Deployment access is granted per account, so contact team@reactor.inc if a deploy is refused. Every key in reactor.yaml is documented at /deploy/platform/reactor-yaml. Model code imports reactor_runtime; Python client code imports reactor_sdk. The runtime overview explains the model interface. Running the model on your own machine with reactor run is optional and needs a GPU you attach with --gpus; /deploy/development/local-testing covers that loop and pairs a complete brightness model with a Python client test in a separate brightness-test workspace. > Reactor hosts multiple models, each with its own connect slug (modelName) and command/event schema. The video model catalog — slug, typed SDK package, and links to its schema — is at /model-api-reference/overview. Robotics policy documentation starts at /robotics/overview; The launch policies are Cosmos Nano DROID (/robotics/cosmos/nano-policy-droid/), DreamZero DROID (/robotics/dreamzero/droid/), and FLUX Action DROID (/robotics/flux-action/droid/), organized by model family and embodiment. Some models expose one slug per experience (e.g. HappyOyster); always take the slug from the model's own pages, never guess it. > Fastest path to a working app: `npx create-reactor-app my-app --model=` scaffolds a complete app with secure auth wired up. Typed TypeScript SDKs are published as @reactor-models/; Python uses the base reactor-sdk package. > Auth: exchange an API key (rk_...) for a JWT via POST https://api.reactor.inc/tokens from your server. Never put the API key in client-side code. > Append .md to any docs URL for clean Markdown. Search these docs via the MCP server at https://docs.reactor.inc/mcp. # List a model's instances > Lists the instances serving a model you own, grouped by cluster. Only the `production` environment's instances are listed. The CLI equivalent is `reactor model instances`. By default only live instances are returned. With `alive_only=false`, the response also includes instances that served a session in a time window of at most 7 days, paged with `limit` and `cursor`. Live instances and their `counts` appear on the first page only. An instance from history can appear on more than one page: merge pods by `(cluster_id, machine_id)` and keep the newest `last_session_at`. Callable by an `account_admin` or `developer` of the owning account. Another account's model returns `403`, or `404` if it is public. ## OpenAPI ````yaml /openapi.yaml get /models/{id}/instances openapi: 3.1.0 info: title: Reactor Platform API version: '1' description: > The Reactor Platform API mints session tokens, starts and operates sessions, negotiates media transport, and manages your account, models, and deployments. Every path is relative to `https://api.reactor.inc`. See the [Introduction](/platform-api/introduction) and [Authentication](/platform-api/authentication) pages for credentials, versioning, and errors. contact: name: Reactor support url: https://docs.reactor.inc/resources/support servers: - url: https://api.reactor.inc description: Production security: - apiKey: [] tags: - name: Status description: >- Public, unauthenticated endpoints for service health, pricing, and the values the API accepts. - name: Tokens description: > Exchange a long-lived API key for a short-lived, session-scoped token that a client can use to create and operate sessions without holding the key. - name: Users description: > Read your own user record, your account's roster, and account memberships, and manage member roles as an account admin. - name: API Keys description: >- Revoke API keys. Use the [Dashboard](https://reactor.inc/dashboard) to list or create keys. The CLI can also create a key with `reactor auth login`. - name: Sessions description: > Create, inspect, and end sessions. A session holds one running model for one client application; media and messages flow over a transport you attach to it afterwards. - name: Transport description: > Attach a client to a session. WebRTC signaling carries ICE servers, SDP, and ICE candidates; a LiveKit room connection lets the session join a room you host. - name: Files description: > Upload files a model reads, either for one running session or ahead of time for sessions you have not started yet. - name: Recordings description: > Fetch the recorded video of a session as an HLS playlist, during the session or after it ends. - name: Accounts description: > Read and manage the account your credential acts in: its name and slug, its credit balance, its effective quotas, and its accelerator capacity. - name: Invitations description: > Invite people to your account by email, and manage pending invitations. The recipient accepts from the emailed link while signed in to the dashboard. - name: Usage description: > List the sessions your account has run, filter them by status, date, model, or API key, and read exact session totals for a date window. - name: Models description: > Register, read, update, and delete the models your account serves, and list the models you can use. The `reactor model` CLI commands are built on these endpoints. - name: Releases description: > Register a model's versioned releases, push their container image, and deploy a release with a per-region instance plan. - name: Model Weights description: > Upload and inspect the weights bundle of a release: single-request uploads, multipart uploads for large files, and the server-side finalize that marks a bundle complete. - name: Model Schemas description: > Attach an OpenAPI schema to a release that describes the model's commands, messages, and tracks. Schemas of public models are readable without credentials. - name: Model Access description: | Share a private model with other accounts, one environment at a time. - name: Projects description: > A project is the deploy identity of a model you serve on Reactor. Each model is one project, with its own UUID. Creating a project also creates its `production` environment. - name: Environments description: > An environment is a named deploy target of a project, such as `production` or `staging`. Each write to an environment creates its next revision, and the newest revision is what the environment runs. Environment access grants let another account start sessions on one environment. - name: Revisions description: > A revision is an immutable, numbered snapshot of one environment: its model image, weights, resources, instances, and variables. An environment's revisions, newest first, are its change log. - name: Images description: > Model images are the container images pushed to your model's repository, named by digest. Experimental: this API can change without notice. - name: Weight Sets description: > A weight set is a version-2 weights bundle, named by its set digest. Push the files, then put the manifest. Available when weight sets are enabled for your account. Experimental: this API can change without notice. - name: Tags description: > A tag is a movable name on one model image or one weight set of a project. A release of the model is a read-only tag. Experimental: this API can change without notice. paths: /models/{id}/instances: parameters: - $ref: '#/components/parameters/ModelId' get: tags: - Models summary: List a model's instances description: > Lists the instances serving a model you own, grouped by cluster. Only the `production` environment's instances are listed. The CLI equivalent is `reactor model instances`. By default only live instances are returned. With `alive_only=false`, the response also includes instances that served a session in a time window of at most 7 days, paged with `limit` and `cursor`. Live instances and their `counts` appear on the first page only. An instance from history can appear on more than one page: merge pods by `(cluster_id, machine_id)` and keep the newest `last_session_at`. Callable by an `account_admin` or `developer` of the owning account. Another account's model returns `403`, or `404` if it is public. operationId: listModelInstances parameters: - $ref: '#/components/parameters/ModelAliveOnly' - $ref: '#/components/parameters/ModelWindowStart' - $ref: '#/components/parameters/ModelWindowEnd' - $ref: '#/components/parameters/ModelWindowSince' - $ref: '#/components/parameters/ModelHistoryLimit' - $ref: '#/components/parameters/ModelHistoryCursor' responses: '200': description: The model's instances. content: application/json: schema: $ref: '#/components/schemas/ModelInstancesResponse' example: model_id: 7b3f1bc2-a4e5-4d78-b9c1-0e6c2f9a1d34 model: your-org/your-model instances: - cluster_id: d2c3911b-6acc-4fe5-81eb-b06235963615 cluster: us-east-2.prod.reactor.inc zone: us-east-2a region: us-east counts: desired: 2 running: 2 healthy: 2 initializing: 0 idle: 1 pods: - machine_id: your-model-7f9c-x2k alive: true status: healthy last_session_at: '2026-11-03T22:01:10Z' - machine_id: your-model-5d2a-p8q alive: true status: healthy count: 2 '400': description: >- An `id`, `alive_only`, window, `limit`, or `cursor` value is invalid, or the window exceeds 7 days. content: application/json: schema: $ref: '#/components/schemas/Error' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: The model is public but not yours. content: application/json: schema: $ref: '#/components/schemas/Error' '503': $ref: '#/components/responses/ServiceUnavailable' components: parameters: ModelId: name: id in: path required: true description: >- The model's ID (not its project ID). Find it with `GET /models?name=your-org/your-model`. schema: type: string format: uuid ModelAliveOnly: name: alive_only in: query required: false description: >- `true` returns live instances only and ignores the window and paging parameters. `false` adds instances that served a session in the window. schema: type: boolean default: true ModelWindowStart: name: start in: query required: false description: >- Inclusive start of the history window, RFC 3339. Defaults to 24 hours before `end`. Only with `alive_only=false`. schema: type: string format: date-time ModelWindowEnd: name: end in: query required: false description: >- Exclusive end of the history window, RFC 3339. Defaults to now. Only with `alive_only=false`. schema: type: string format: date-time ModelWindowSince: name: since in: query required: false description: >- A window ending now, as a duration such as `24h` or `7d`. Cannot be combined with `start` or `end`. Only with `alive_only=false`. schema: type: string example: 24h ModelHistoryLimit: name: limit in: query required: false description: >- Maximum session-history rows read for the page (not the number of instances returned). Only with `alive_only=false`. schema: type: integer minimum: 1 maximum: 200 default: 200 ModelHistoryCursor: name: cursor in: query required: false description: The `next_cursor` of the previous page. Only with `alive_only=false`. schema: type: string schemas: ModelInstancesResponse: type: object required: - model_id - model - instances - count properties: model_id: type: string format: uuid model: type: string example: your-org/your-model instances: type: array items: $ref: '#/components/schemas/ModelInstanceCluster' count: type: integer description: Instances in this response, not a total across pages. next_cursor: type: string description: Present when another history page exists. Error: type: object required: - error properties: error: type: string description: >- A stable error code (for example `not_found`) on newer routes, or a sentence on older ones. When `message` is present, branch on `error`. message: type: string description: >- A human-readable explanation. Do not parse it; its wording may change. resource: type: string description: The type of the resource a `not_found` refers to. reason: type: string description: >- A more specific cause for `failed_precondition`, `aborted`, and some `invalid_request` errors. ModelInstanceCluster: type: object required: - cluster_id - cluster - pods properties: cluster_id: type: string format: uuid cluster: type: string description: The cluster's host name. zone: type: string example: us-east-2a region: type: string description: The Reactor region of the zone. example: us-east counts: type: object description: >- Live counts for the cluster. Omitted for a cluster known only from history; a field is omitted when unknown. properties: desired: type: integer description: Instances requested on this cluster. running: type: integer description: Instances running, including those still starting. healthy: type: integer description: Instances idle or serving a session. initializing: type: integer description: Instances still starting. idle: type: integer description: Healthy instances ready for a new session. pods: type: array items: $ref: '#/components/schemas/ModelInstancePod' ModelInstancePod: type: object required: - machine_id - alive properties: machine_id: type: string description: The instance's ID. alive: type: boolean description: >- `true` when the instance is running now; `false` when it is known only from recent session history. status: type: string description: > `healthy`, `initializing` (starting, loading weights or the image), `unhealthy`, or `terminated` (seen only in history and no longer running). Omitted when unknown. Treat an unrecognized value as unknown. example: healthy last_session_at: type: string format: date-time description: When the instance last served a session. Omitted if it never did. units: type: array items: type: string description: >- For a multi-session instance, the IDs of its per-session workers seen in history. responses: Unauthorized: description: The credential is missing, invalid, or expired. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: >- The credential is valid but may not perform this action, or the resource is outside the caller's permission boundary. A resource you cannot see returns `403` whether or not it exists. content: application/json: schema: $ref: '#/components/schemas/Error' ServiceUnavailable: description: A dependency is temporarily unavailable. Retry with backoff. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: apiKey: type: http scheme: bearer description: >- A Reactor API key (`rk_...`), sent as `Authorization: Bearer rk_...`. Keep it on a server. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.