Orbit Preview API

Render an app's live design-time state to a PNG screenshot

GitHub OpenAPI

Operations 3

GET /api/v1/apps/{app_id}/audit Audit an app page for accessibility #
GET /api/v1/apps/{app_id}/preview.png Render an app to a PNG screenshot #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/orbitapps-io:orbitapps-io-preview-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

orbitapps-io-preview-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Orbit Apps Preview API
  version: 1.0.0
  description: Public REST API for Orbit Apps.
servers:
- url: https://api.orbitapps.io
  description: Production
security:
- bearerAuth: []
tags:
- name: Preview
  description: Render an app's live design-time state to a PNG screenshot
paths:
  /api/v1/apps/{app_id}/audit:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
      - in: query
        name: page
        required: false
        schema:
          type: string
        description: Page path to audit (e.g. "/pricing"). Defaults to the app's home page.
      - in: query
        name: width
        required: false
        schema:
          type: integer
          minimum: 320
          maximum: 1920
        description: Viewport width in CSS px (default 1280).
      - in: query
        name: height
        required: false
        schema:
          type: integer
          minimum: 240
          maximum: 1200
        description: Viewport height in CSS px (default 800).
      responses:
        '200':
          description: The audit.
          content:
            application/json:
              schema:
                title: Audit
                description: An accessibility audit of one page as a visitor opens it.
                type: object
                properties:
                  status:
                    description: passed when every check passed, else failed.
                    type: string
                    enum:
                    - passed
                    - failed
                  checks:
                    description: axe, keyboard-reach and focus-visible, in that order.
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          enum:
                          - axe
                          - keyboard-reach
                          - focus-visible
                        passed:
                          type: boolean
                        message:
                          description: What failed.
                          type: string
                      required:
                      - name
                      - passed
                      additionalProperties: false
                  violations:
                    description: 'axe-core''s WCAG 2.0, 2.1 and 2.2 A and AA rules that failed: at most 50, each with at most 5 targets.'
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          description: The axe rule id, e.g. image-alt.
                          type: string
                        impact:
                          description: minor | moderate | serious | critical.
                          oneOf:
                          - type: string
                          - type: 'null'
                        help:
                          type: string
                        url:
                          description: The rule's documentation.
                          type: string
                        count:
                          description: How many elements fail the rule.
                          type: integer
                        targets:
                          description: CSS selectors of the first elements that fail.
                          type: array
                          items:
                            type: string
                      required:
                      - id
                      - impact
                      - help
                      - url
                      - count
                      - targets
                      additionalProperties: false
                  tab_order:
                    description: Each stop Tab reaches from the top of the page, in order.
                    type: array
                    items:
                      type: object
                      properties:
                        tag:
                          description: The element's tag name.
                          type: string
                        role:
                          description: Its ARIA role, or null when it has none.
                          oneOf:
                          - type: string
                          - type: 'null'
                        name:
                          description: Its accessible name, at most 80 characters.
                          type: string
                        focus_visible:
                          description: Whether focus changes how the stop, or a wrapper around it, looks.
                          type: boolean
                      required:
                      - tag
                      - role
                      - name
                      - focus_visible
                      additionalProperties: false
                  unreachable:
                    description: Controls a person can operate that no Tab reached.
                    type: array
                    items:
                      type: object
                      properties:
                        tag:
                          description: The element's tag name.
                          type: string
                        role:
                          description: Its ARIA role, or null when it has none.
                          oneOf:
                          - type: string
                          - type: 'null'
                        name:
                          description: Its accessible name, at most 80 characters.
                          type: string
                      required:
                      - tag
                      - role
                      - name
                      additionalProperties: false
                  skip_link:
                    description: Whether the first stop is a link to an element on the page.
                    type: boolean
                  focus_hidden:
                    description: Each stop in tab-order that shows no focus, with its 1-based position there.
                    type: array
                    items:
                      type: object
                      properties:
                        position:
                          type: integer
                        tag:
                          description: The element's tag name.
                          type: string
                        role:
                          description: Its ARIA role, or null when it has none.
                          oneOf:
                          - type: string
                          - type: 'null'
                        name:
                          description: Its accessible name, at most 80 characters.
                          type: string
                      required:
                      - position
                      - tag
                      - role
                      - name
                      additionalProperties: false
                  composition:
                    description: 'How the screen is arranged, read from its nodes: what to rearrange. Advice, which changes no check and not the status. Empty when nothing is found.'
                    type: array
                    items:
                      type: object
                      properties:
                        rule:
                          description: 'form-only: fields and no picture. long-form: over six fields in one view. same-arrangement: three sections in a row arranged alike.'
                          type: string
                          enum:
                          - form-only
                          - long-form
                          - same-arrangement
                        message:
                          description: What is wrong and what to do.
                          type: string
                      required:
                      - rule
                      - message
                      additionalProperties: false
                required:
                - status
                - checks
                - violations
                - tab_order
                - unreachable
                - skip_link
                - focus_hidden
                - composition
                additionalProperties: false
        '404':
          description: App not found, or no page at that path.
        '422':
          description: The page's HTML is too large to audit.
        '502':
          description: The auditor returned an invalid audit.
        '503':
          description: The auditor is not configured, not answering, or busy.
      tags:
      - Preview
      summary: Audit an app page for accessibility
      description: 'Audits one page of the app''s LIVE design-time state as a visitor opens it, in a browser: axe-core''s WCAG 2.0, 2.1 and 2.2 A and AA rules, and a keyboard walk that presses Tab from the top of the page until focus leaves it. The walk reports each stop, whether focus shows on it, the controls no Tab reached, and whether the first stop is a skip link.


        The page renders as the preview renders it, without scripts, so the audit cannot test Enter or Space on a stop, or focus after a route change. An image the app does not store does not load: the audit reads its alt text.'
      operationId: getApiV1AppsByAppIdAudit
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/preview-link:
    post:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '201':
          description: The link, its home workspace, and when its token expires.
          content:
            application/json:
              schema:
                title: PreviewLink
                type: object
                properties:
                  url:
                    type: string
                  workspace_id:
                    type: string
                  expires_at:
                    type: string
                required:
                - url
                - workspace_id
                - expires_at
                additionalProperties: false
        '404':
          description: App not found, or no page to preview yet.
      tags:
      - Preview
      summary: Open an app's live preview on the Orbit phone app
      description: Mints a short-lived token and returns the `orbit://preview` link the Orbit phone app opens to render the app's LIVE design-time state natively, following each edit as it lands. Nothing is deployed. The link opens the home page and carries a token valid for eight hours, so treat it as a secret.
      operationId: postApiV1AppsByAppIdPreviewLink
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/preview.png:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
      - in: query
        name: page
        required: false
        schema:
          type: string
        description: Page slug to render (e.g. "/pricing"). Defaults to the app's home page.
      - in: query
        name: node
        required: false
        schema:
          type: string
          format: uuid
        description: 'A node id: capture that element alone, on the page it stands on, instead of the viewport. `page` and `full_page` are not read. A node a list repeats shows its first row.'
      - in: query
        name: width
        required: false
        schema:
          type: integer
          minimum: 200
          maximum: 3840
        description: Viewport width in CSS px (default 1280).
      - in: query
        name: height
        required: false
        schema:
          type: integer
          minimum: 200
          maximum: 3840
        description: Viewport height in CSS px (default 800).
      - in: query
        name: dpr
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 3
        description: Device scale factor / retina multiplier (default 1).
      - in: query
        name: full_page
        required: false
        schema:
          type: boolean
        description: Capture a layout overview of the whole page (default false). Bounded to 1280x8000 at DPR 1.
      responses:
        '200':
          description: PNG screenshot (image/png).
        '404':
          description: App not found, or no renderable page or node.
        '422':
          description: The node is on its page but draws nothing.
        '502':
          description: Screenshot service returned an invalid image.
        '503':
          description: Screenshot service not configured, or not answering.
      tags:
      - Preview
      summary: Render an app to a PNG screenshot
      description: 'Renders the app''s LIVE design-time state (the pages as currently authored — not the last deployed bundle) to a PNG so an agent can SEE how it looks. Returns `image/png` bytes.


        Pass `?page=` to pick a page (defaults to the home page) and `?width=&height=&dpr=` to control the viewport. Pass `?full_page=true` for a layout overview capped at width 1280 and height 8000 — a capture that tall is downscaled hard before a model reads it, so use the default first-fold shot to read text. Pass `?node=` to capture one element alone — a card, a form, a section — on the page it stands on. The image always reflects the current state.'
      operationId: getApiV1AppsByAppIdPreviewPng
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: 'An Orbit api token, sent as `Authorization: Bearer <token>`.


        Mint one with the RFC 8628 device-authorization grant (`POST /api/v1/device/code`, then poll `POST /api/v1/device/token`), or from Studio.


        Every token carries a scope set from the `[verb resource]` RBAC catalog — `read:app`, `write:deployment`, `manage:secret`, and so on. The full vocabulary is published as `scopes_supported` at `/.well-known/oauth-protected-resource` (RFC 9728) and `/.well-known/oauth-authorization-server` (RFC 8414). Grant an agent the narrowest set that does its job.'
externalDocs:
  description: Full documentation
  url: https://docs.orbitapps.io
x-id:
- reitit.openapi/default