Orbit Agents API
Agent + integration members — create, list, revoke; mint org-scoped tokens
Agent + integration members — create, list, revoke; mint org-scoped tokens
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/orbitapps-io:orbitapps-io-agents-api"
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.
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: 3.2.0
info:
title: Orbit Apps Agents API
version: 1.0.0
description: Public REST API for Orbit Apps.
servers:
- url: https://api.orbitapps.io
description: Production
security:
- bearerAuth: []
tags:
- name: Agents
description: Agent + integration members — create, list, revoke; mint org-scoped tokens
paths:
/api/v1/orgs/{id}/agents:
get:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Org id from GET /api/v1/orgs
responses:
'200':
content:
application/json:
schema:
title: AgentList
type: object
properties:
data:
type: array
items:
title: Agent
description: One non-human (agent / integration) member.
type: object
properties:
role:
type: string
name:
description: Display name, as supplied on create.
oneOf:
- type: string
- type: 'null'
org_id:
type: string
format: uuid
owner_member_id:
description: The human member that owns this agent.
oneOf:
- type: string
format: uuid
- type: 'null'
updated_at:
oneOf:
- type: string
- type: 'null'
status:
description: active | revoked.
type: string
id:
type: string
format: uuid
kind:
description: agent | integration.
type: string
created_at:
oneOf:
- type: string
- type: 'null'
required:
- id
- org_id
- kind
- owner_member_id
- name
- role
- status
additionalProperties: false
required:
- data
additionalProperties: false
'404':
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Agents
summary: List the org's agents
description: 'Every agent / integration member in the org. Authorization: `[:read :member]`.'
operationId: getApiV1OrgsByIdAgents
x-operation-id-source: derived
post:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Org id from GET /api/v1/orgs
requestBody:
content:
application/json:
schema:
title: AgentCreate
description: Request body for POST /api/v1/orgs/{id}/agents.
type: object
properties:
name:
description: Agent + token display name.
allOf:
- type: string
- {}
role:
description: Membership role bounding the agent's max authority. `owner` is reserved.
type: string
enum:
- admin
- member
- viewer
scopes:
description: Token scopes as [verb resource] pairs, e.g. [["write" "deployment"]]. Defaults to the narrow-autonomous set (read + build apps). Grant billable/sensitive capabilities explicitly here.
oneOf:
- type: array
items:
type: array
items:
type: string
- type: 'null'
required:
- name
additionalProperties: false
responses:
'201':
content:
application/json:
schema:
title: Agent
description: One non-human (agent / integration) member.
type: object
properties:
role:
type: string
token_prefix:
type: string
name:
description: Display name, as supplied on create.
oneOf:
- type: string
- type: 'null'
org_id:
type: string
format: uuid
token_id:
type: string
format: uuid
owner_member_id:
description: The human member that owns this agent.
oneOf:
- type: string
format: uuid
- type: 'null'
updated_at:
oneOf:
- type: string
- type: 'null'
token:
description: The token plaintext — shown only in this response. Store it now.
type: string
status:
description: active | revoked.
type: string
id:
type: string
format: uuid
kind:
description: agent | integration.
type: string
created_at:
oneOf:
- type: string
- type: 'null'
required:
- id
- org_id
- kind
- owner_member_id
- name
- role
- status
- token
- token_id
- token_prefix
additionalProperties: false
'403':
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'404':
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Agents
summary: Create an agent member and mint its token
description: 'Creates an `agent`-kind member owned by the caller and mints an org-scoped token bound to it. The token plaintext is returned exactly once — store it immediately (e.g. as `ORBIT_TOKEN`).
Authorization: `[:manage :member]` + `[:manage :token]` (owner/admin).'
operationId: postApiV1OrgsByIdAgents
x-operation-id-source: derived
/api/v1/orgs/{id}/agents/{agent_id}:
delete:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Org id from GET /api/v1/orgs
- in: path
name: agent_id
required: true
schema:
type: string
format: uuid
description: Agent member id from GET /api/v1/orgs/{id}/agents
responses:
'204':
description: Agent revoked.
'403':
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'404':
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Agents
summary: Revoke an agent
description: 'Sets the agent member''s status to `revoked`; its token stops authenticating immediately. Authorization: `[:manage :member]` + `[:manage :token]` (owner/admin).'
operationId: deleteApiV1OrgsByIdAgentsByAgentId
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