Orbit Admin API

A deployed app's own data — read its tables and rows through the app's admin panel

GitHub OpenAPI

Operations 16

GET /api/v1/apps/{app_id}/admin/dashboards List a deployed app's dashboards #
GET /api/v1/apps/{app_id}/admin/tables/{table}/rows/{id} Get one row of a deployed app's table #
DELETE /api/v1/apps/{app_id}/admin/tables/{table}/rows/{id} Delete a row of a deployed app's table #
PATCH /api/v1/apps/{app_id}/admin/tables/{table}/rows/{id} Change a row of a deployed app's table #
POST /api/v1/apps/{app_id}/admin/operator/stop Stop the turn a deployed app's Operator is at #
PUT /api/v1/apps/{app_id}/admin/operator/paused Pause a deployed app's Operator, or let it work again #
GET /api/v1/apps/{app_id}/admin/tables List a deployed app's tables #
POST /api/v1/apps/{app_id}/admin/operator/messages Ask a deployed app's Operator #
GET /api/v1/apps/{app_id}/admin/dashboards/{key}/reads/{read} Read one number of a deployed app's dashboard #
GET /api/v1/apps/{app_id}/admin/tables/{table}/rows List rows of a deployed app's table #
POST /api/v1/apps/{app_id}/admin/tables/{table}/rows Add a row to a deployed app's table #
GET /api/v1/apps/{app_id}/admin/access List who reached a deployed app's data #
GET /api/v1/apps/{app_id}/admin/operator/conversation Get the conversation with a deployed app's Operator #
GET /api/v1/apps/{app_id}/admin/operator/runs/{run_id} Get one run of a deployed app's Operator #
GET /api/v1/apps/{app_id}/admin/operator Get a deployed app's Operator #
GET /api/v1/apps/{app_id}/admin/dashboards/{key} Get one dashboard of a deployed app #

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-admin-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-admin-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Orbit Apps Admin API
  version: 1.0.0
  description: Public REST API for Orbit Apps.
servers:
- url: https://api.orbitapps.io
  description: Production
security:
- bearerAuth: []
tags:
- name: Admin
  description: A deployed app's own data — read its tables and rows through the app's admin panel
paths:
  /api/v1/apps/{app_id}/admin/dashboards:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: {}
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: List a deployed app's dashboards
      description: The newest version of each dashboard the app keeps, without its spec.
      operationId: getApiV1AppsByAppIdAdminDashboards
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/tables/{table}/rows/{id}:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: path
        name: table
        required: true
        schema:
          type: string
          pattern: ^[a-z][a-z0-9_-]{0,63}$
      - in: path
        name: id
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 64
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: {}
                  links:
                    type: array
                    items:
                      type: object
                      additionalProperties: {}
                required:
                - data
                - links
                additionalProperties: false
      tags:
      - Admin
      summary: Get one row of a deployed app's table
      description: The row, and for each table that references it, how many rows point at it.
      operationId: getApiV1AppsByAppIdAdminTablesByTableRowsById
      x-operation-id-source: derived
    delete:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: path
        name: table
        required: true
        schema:
          type: string
          pattern: ^[a-z][a-z0-9_-]{0,63}$
      - in: path
        name: id
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 64
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      responses:
        '204': {}
      tags:
      - Admin
      summary: Delete a row of a deployed app's table
      description: 'Deletes one row. A deleted row cannot be restored, so this needs the `runtime:manage` scope on a scoped token. The app''s own access rules still apply, and the table checks each value. Each write is recorded: who, which table and row, never the values.'
      operationId: deleteApiV1AppsByAppIdAdminTablesByTableRowsById
      x-operation-id-source: derived
    patch:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: path
        name: table
        required: true
        schema:
          type: string
          pattern: ^[a-z][a-z0-9_-]{0,63}$
      - in: path
        name: id
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 64
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                values:
                  description: Column names to values. On an update, only the columns to change.
                  type: object
                  additionalProperties: {}
                  minProperties: 1
                  maxProperties: 200
              required:
              - values
              additionalProperties: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                    required:
                    - id
                    additionalProperties: false
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: Change a row of a deployed app's table
      description: 'Changes only the columns the body carries. Needs the `runtime:write` scope on a scoped token. The app''s own access rules still apply, and the table checks each value. Each write is recorded: who, which table and row, never the values.'
      operationId: patchApiV1AppsByAppIdAdminTablesByTableRowsById
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/operator/stop:
    post:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: {}
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: Stop the turn a deployed app's Operator is at
      description: 'Answers `stopped: false` when no turn was at work.'
      operationId: postApiV1AppsByAppIdAdminOperatorStop
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/operator/paused:
    put:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                paused:
                  type: boolean
              required:
              - paused
              additionalProperties: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: {}
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: Pause a deployed app's Operator, or let it work again
      description: A pause stops the run at work too, and no run starts while it holds.
      operationId: putApiV1AppsByAppIdAdminOperatorPaused
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/tables:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: {}
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: List a deployed app's tables
      description: The tables of the app's own database that the caller may read, each with its columns. Needs the owner or admin role, and the `runtime:read` scope on a scoped token. The app must run its admin service in `env`.
      operationId: getApiV1AppsByAppIdAdminTables
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/operator/messages:
    post:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  description: What to ask, 1-8000 characters.
                  allOf:
                  - type: string
                    minLength: 1
                    maxLength: 8000
                  - {}
              required:
              - text
              additionalProperties: false
      responses:
        '202':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: {}
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: Ask a deployed app's Operator
      description: 'Gives the Operator one message and answers at once with the run it started; read the conversation for what it said. The Operator proposes changes and a person applies them in the app''s admin panel: no route here applies one. Needs the `runtime:write` scope on a scoped token.'
      operationId: postApiV1AppsByAppIdAdminOperatorMessages
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/dashboards/{key}/reads/{read}:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: path
        name: key
        required: true
        schema:
          type: string
          pattern: ^[a-z][a-z0-9_-]{0,63}$
      - in: path
        name: read
        required: true
        schema:
          type: string
          pattern: ^[a-z][a-z0-9_-]{0,63}$
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: {}
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: Read one number of a deployed app's dashboard
      description: The value of one read of the dashboard, by the read's id in its spec.
      operationId: getApiV1AppsByAppIdAdminDashboardsByKeyReadsByRead
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/tables/{table}/rows:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: path
        name: table
        required: true
        schema:
          type: string
          pattern: ^[a-z][a-z0-9_-]{0,63}$
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      - in: query
        name: limit
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 200
        description: Max rows (1-200, default 50).
      - in: query
        name: offset
        required: false
        schema:
          type: integer
          minimum: 0
        description: Result offset (default 0).
      - in: query
        name: order_by
        required: false
        schema:
          type: string
          pattern: ^[a-z][a-z0-9_-]{0,63}$
        description: A column of the table to sort by.
      - in: query
        name: direction
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
        description: Sort direction (default asc).
      - in: query
        name: where
        required: false
        schema:
          type: string
          maxLength: 2000
        description: A JSON object of column = value filters, e.g. {"status":"live"}.
      - in: query
        name: q
        required: false
        schema:
          type: string
          maxLength: 100
        description: Words to find rows by, where the table has a search index or text columns.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: {}
                  count:
                    oneOf:
                    - type: integer
                    - type: 'null'
                  limit:
                    type: integer
                  offset:
                    type: integer
                required:
                - data
                - count
                - limit
                - offset
                additionalProperties: false
      tags:
      - Admin
      summary: List rows of a deployed app's table
      description: 'One page of the table''s rows, and how many match. The app''s own access rules still apply: a column the data model marks private is never returned.'
      operationId: getApiV1AppsByAppIdAdminTablesByTableRows
      x-operation-id-source: derived
    post:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: path
        name: table
        required: true
        schema:
          type: string
          pattern: ^[a-z][a-z0-9_-]{0,63}$
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                values:
                  description: Column names to values. On an update, only the columns to change.
                  type: object
                  additionalProperties: {}
                  minProperties: 1
                  maxProperties: 200
              required:
              - values
              additionalProperties: false
      responses:
        '201':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                    required:
                    - id
                    additionalProperties: false
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: Add a row to a deployed app's table
      description: 'Adds one row and answers with its id. Needs the `runtime:write` scope on a scoped token. Send an `Idempotency-Key` header so a retry adds no second row. The app''s own access rules still apply, and the table checks each value. Each write is recorded: who, which table and row, never the values.'
      operationId: postApiV1AppsByAppIdAdminTablesByTableRows
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/access:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: query
        name: env
        required: false
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: Only this environment.
      - in: query
        name: limit
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 200
        description: Max records (1-200, default 50).
      - in: query
        name: offset
        required: false
        schema:
          type: integer
          minimum: 0
        description: Result offset (default 0).
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      title: AppAccess
                      description: One request the API made to a deployed app's data. It names the row, never a value.
                      type: object
                      properties:
                        table:
                          oneOf:
                          - type: string
                          - type: 'null'
                        token_id:
                          oneOf:
                          - type: string
                            format: uuid
                          - type: 'null'
                        outcome:
                          description: ok, the problem's slug, or pending when the request did not end.
                          type: string
                        op:
                          description: model | rows | row | create | update | delete.
                          type: string
                        env:
                          description: dev | uat | prod.
                          type: string
                        row_id:
                          oneOf:
                          - type: string
                          - type: 'null'
                        member_id:
                          description: The agent that asked, when an agent did.
                          oneOf:
                          - type: string
                            format: uuid
                          - type: 'null'
                        id:
                          type: string
                          format: uuid
                        profile_id:
                          description: The person who asked, when a person did.
                          oneOf:
                          - type: string
                            format: uuid
                          - type: 'null'
                        created_at:
                          type: string
                      required:
                      - id
                      - env
                      - op
                      - table
                      - row_id
                      - profile_id
                      - member_id
                      - token_id
                      - outcome
                      - created_at
                      additionalProperties: false
                  limit:
                    type: integer
                  offset:
                    type: integer
                required:
                - data
                - limit
                - offset
                additionalProperties: false
      tags:
      - Admin
      summary: List who reached a deployed app's data
      description: 'Each request this API made to the app''s data, newest first: who asked, which table and row, and how it ended. It holds no value of any row. Needs the owner or admin role, and the `runtime:read` scope on a scoped token.'
      operationId: getApiV1AppsByAppIdAdminAccess
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/operator/conversation:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: {}
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: Get the conversation with a deployed app's Operator
      description: The messages, how the last turn ended, and the changes the Operator proposed.
      operationId: getApiV1AppsByAppIdAdminOperatorConversation
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/operator/runs/{run_id}:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: path
        name: run_id
        required: true
        schema:
          type: string
          format: uuid
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: {}
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: Get one run of a deployed app's Operator
      description: What the run said, which tools answered, and what it asks the owner.
      operationId: getApiV1AppsByAppIdAdminOperatorRunsByRunId
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/operator:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: {}
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: Get a deployed app's Operator
      description: Whether the app's Operator is paused, and each goal with its key results and newest runs. Needs the `runtime:read` scope on a scoped token.
      operationId: getApiV1AppsByAppIdAdminOperator
      x-operation-id-source: derived
  /api/v1/apps/{app_id}/admin/dashboards/{key}:
    get:
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          type: string
          format: uuid
        description: App id from GET /api/v1/apps.
      - in: path
        name: key
        required: true
        schema:
          type: string
          pattern: ^[a-z][a-z0-9_-]{0,63}$
      - in: query
        name: env
        required: true
        schema:
          type: string
          enum:
          - dev
          - uat
          - prod
        description: The environment whose data to read. It has no default.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: {}
                required:
                - data
                additionalProperties: false
      tags:
      - Admin
      summary: Get one dashboard of a deployed app
      description: 'The dashboard with its spec: each read it makes, and how it is drawn.'
      operationId: getApiV1AppsByAppIdAdminDashboardsByKey
      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