> ## Documentation Index
> Fetch the complete documentation index at: https://offstage.cloud/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> To set up offstage cloud from a coding agent, read https://api.offstage.cloud/SKILL.md and follow it. The whole API guide is one file at https://api.offstage.cloud/llms.txt.

# Get a recording

> The timeline so far, or all of it once it has ended. To follow one live, use `GET /v1/recordings/{recordingId}/live`.



## OpenAPI

````yaml /openapi.json get /v1/recordings/{recordingId}
openapi: 3.1.0
info:
  title: offstage cloud API
  version: 0.1.0
  summary: Real Macs for AI agents and CI, over HTTP.
  description: >-
    macOS sandboxes driven one call at a time, and fire-and-forget CI tasks, on
    Apple silicon Macs running macOS 27.


    - **Auth.** `Authorization: Bearer sk_offstage_…` (a team API key; one made
    before 2026-10-29 starts with `oc_live_` and still works), or the console's
    `oc_session` cookie. Operations marked `x-console-only: true` take only the
    cookie; an API key gets 403 `console-only`. A cookie request that changes
    something must come from this origin.

    - **Errors.** Every failure is `{"error": {"code", "message", "fix"?,
    "requestId"}}`. Switch on `code`; `fix`, when present, says what to do. Any
    operation can also answer 500 `internal` (a bug; quote the `requestId`), and
    an unknown route is 404 `no-such-route`.

    - **Request ids.** Every response carries an `x-request-id` header, repeated
    as `requestId` in error bodies.

    - **Units.** Times are Unix milliseconds, and durations end in `Ms`. Money
    is US dollars as numbers, exact to the micro-dollar (`costUsd`).

    - **Ids** are prefixed: `sbx_` sandbox, `cmd_` command, `run_` agent run,
    `task_` task, `key_` API key, `req_` request, `team_`, `usr_`, `box_` (a
    fleet Mac), `inv_`.

    - **Lists** are newest first. Pass the previous page's `nextCursor` as
    `cursor`; it is null on the last page.

    - **Bodies.** JSON, except file writes, which send raw bytes. Request
    schemas with `additionalProperties: false` refuse an unknown field with 400
    `unknown-field`.

    - **Limits.** A team may send 120 requests a minute, whatever key or session
    it uses. Every request also counts against its client address: 600 a minute,
    and far fewer on the routes that need no credential (5 sign-ups an hour, 20
    sign-ins and 20 verifications a minute). Over a window is 429 `rate-limit`
    with a `Retry-After` header.

    - **Verification.** A new account's team can sign in and look around, but
    cannot create sandboxes, tasks or API keys (403 `email-unverified`) until
    its owner opens the link emailed at signup.

    - **Holds.** No request is held longer than about 50 s, so default client
    timeouts and 60 s proxy idle timeouts are fine, except large files: a write
    answers once its upload is done, and a read streams for as long as the Mac
    takes to send it.


    The prose reference, with examples, is
    `https://api.offstage.cloud/llms.txt`. The agent setup guide is
    `https://api.offstage.cloud/SKILL.md`.
servers:
  - url: https://api.offstage.cloud
security:
  - apiKey: []
  - consoleSession: []
tags:
  - name: Sandboxes
    description: >-
      A Mac slot (a macOS user account) held for you: run commands, move files,
      take screenshots.
  - name: Tasks
    description: >-
      Fire-and-forget macOS work: clone a public repo, run a command, collect
      artifacts.
  - name: Recordings
    description: >-
      What a gui sandbox or gui task showed and did, kept by the plane: live
      while it runs, a replay after. Open one in the console at `/r/{id}`.
  - name: Capacity
    description: What the fleet can take right now, and whether the plane is up.
  - name: Billing
    description: The price, usage, the bill, the budget and the card.
  - name: Account
    description: Signing in, the team, its members and its API keys.
  - name: GitHub
    description: >-
      GitHub Actions jobs on offstage Macs: connect an organization in the
      console, then `runs-on: offstage-macos`.
  - name: Secrets
    description: Write-only team credentials selected by workload name.
paths:
  /v1/recordings/{recordingId}:
    get:
      tags:
        - Recordings
      summary: Get a recording
      description: >-
        The timeline so far, or all of it once it has ended. To follow one live,
        use `GET /v1/recordings/{recordingId}/live`.
      operationId: getRecording
      parameters:
        - $ref: '#/components/parameters/RecordingId'
      responses:
        '200':
          description: The recording.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recording'
        '401':
          description: >-
            `unauthorized`: no credential, an `Authorization` header that is not
            `Bearer …`, a value that is not an `sk_offstage_` (or older
            `oc_live_`) key, a revoked or unknown key, or a box token. The
            message says which.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            `recording-not-found`: no recording by that id for this team. A
            sandbox made with `record: false`, a headless one, and another
            team's have none.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - apiKey: []
        - consoleSession: []
components:
  parameters:
    RecordingId:
      name: recordingId
      in: path
      required: true
      description: >-
        The sandbox's or task's id (`sbx_…` or `task_…`): its recording is named
        after it.
      schema:
        type: string
  headers:
    RequestId:
      description: This request's id, `req_…`. Quote it when asking for help.
      required: true
      schema:
        type: string
        pattern: ^req_
  schemas:
    Recording:
      type: object
      description: >-
        A gui sandbox's or gui task's timeline, kept by the plane so it plays
        back after the slot is reset. Private to the team; deleted with its
        other artifacts.
      properties:
        id:
          type: string
          description: >-
            The sandbox's or task's id: a recording is named after what it
            recorded.
        kind:
          type: string
          enum:
            - sandbox
            - task
        name:
          type: string
        state:
          type: string
          enum:
            - recording
            - ended
        startedAt:
          $ref: '#/components/schemas/Millis'
        endedAt:
          $ref: '#/components/schemas/Millis'
        frames:
          type: integer
          minimum: 0
          description: Pictures the plane kept for it, not counting an agent run's own.
        truncated:
          type: boolean
          description: >-
            A cap stopped it keeping more: pictures, entries, or the team's
            artifact share.
        replayUrl:
          type: string
        entries:
          type: array
          items:
            $ref: '#/components/schemas/RecordingEntry'
      required:
        - id
        - kind
        - state
        - startedAt
        - frames
        - truncated
        - replayUrl
        - entries
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Stable and machine-readable, like `sandbox-closed`. Switch on
                this, not on the message.
            message:
              type: string
              description: What went wrong, for a person.
            fix:
              type: string
              description: What to do about it, when there is something to do.
            requestId:
              type: string
              description: >-
                The same as the `x-request-id` header. Quote it when asking for
                help.
              pattern: ^req_
          required:
            - code
            - message
            - requestId
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        The one error envelope: every 4xx and 5xx the plane itself sends. A
        proxy in front of it may send a 5xx whose body is not JSON.
      examples:
        - error:
            code: sandbox-closed
            message: sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)
            fix: create a new sandbox
            requestId: req_mh3k2f9aQ1xYz0aBcDeFgHiJ
    Millis:
      type: integer
      minimum: 0
      description: A time, in Unix milliseconds.
    RecordingEntry:
      type: object
      description: >-
        One thing on a recording's timeline. `type` says which fields it has:
        `frame` (a picture the plane took: `frame`, `width`, `height`,
        `source`), `step` (an agent run's step, as in AgentStep, with its
        picture's name in this recording and `space`, the pixel space its
        coordinates are in), `run` (an agent run `started` with its `goal` and
        `model`, or `finished` with its `verdict`), `command` (a command a
        customer ran, with its exit and the tail of its output), `input` (an
        input call: its `actions`, how many were `performed`, and its `error` if
        it failed), `log` (a gui task's log lines) and `end` (why it ended).
      properties:
        seq:
          type: integer
          minimum: 1
          description: 'Its place on the timeline, from 1: what `live` resumes after.'
        at:
          $ref: '#/components/schemas/Millis'
        type:
          type: string
          enum:
            - frame
            - step
            - run
            - command
            - input
            - log
            - end
        frame:
          type: string
          description: 'A picture: `GET /v1/recordings/{recordingId}/frames/{frame}`.'
        width:
          type: integer
          minimum: 1
        height:
          type: integer
          minimum: 1
        source:
          type: string
          enum:
            - start
            - command
            - background
            - task
          description: >-
            Why the plane took the picture: the slot became ready, a command
            ended, a run was going, or a gui task's box sent it.
        runId:
          type: string
          pattern: ^run_
        action:
          type: string
        input:
          type: object
        ok:
          type: boolean
        error:
          oneOf:
            - type: string
            - type: object
              properties:
                code:
                  type: string
                message:
                  type: string
              required:
                - code
                - message
        note:
          type: string
        space:
          type: object
          properties:
            width:
              type: integer
            height:
              type: integer
          required:
            - width
            - height
          additionalProperties: false
        event:
          type: string
          enum:
            - started
            - finished
        goal:
          type: string
        model:
          type: string
        verdict:
          type: string
          enum:
            - done
            - failed
            - incomplete
        reason:
          type: string
        command:
          type: string
          description: >-
            The command line, cut to 2,000 characters. Its environment is never
            recorded.
        exitCode:
          type:
            - integer
            - 'null'
        timedOut:
          type: boolean
        durationMs:
          type: integer
          minimum: 0
        output:
          type: string
          description: The last 8 KiB of its output.
        truncated:
          type: boolean
        lines:
          type: array
          items:
            type: string
        actions:
          type: array
          items:
            type: string
          description: >-
            An input call's actions, one line each, like `click (640, 400)` or
            `type 5 characters`. Typed text is never recorded.
        performed:
          type: integer
          minimum: 0
      required:
        - seq
        - at
        - type
      additionalProperties: false
  responses:
    RateLimited:
      description: >-
        `rate-limit`: this team has sent more than 120 requests in the last 60
        s, or this client address more than 600 (fewer on the routes that need
        no credential). The `Retry-After` header gives the seconds left in the
        window.
      headers:
        x-request-id:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          schema:
            type: string
          description: Seconds until the window opens again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A team API key, `sk_offstage_…`, created in the console. Everything it
        touches belongs to its team.
    consoleSession:
      type: apiKey
      in: cookie
      name: oc_session
      description: >-
        The console's session cookie (httpOnly, SameSite=Lax, 30 days), set by
        `signup` and `login`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.