Developer resources

API and Realtime Documentation

Machine and operator APIs use /api/v1, enterprise provisioning uses /scim/v2, and realtime channels terminate at /socket. Health probes, metrics, and provider webhooks use the top-level routes shown below.

232 endpoints / v1 + WS WebSocket guide

Robots Center now has a WebSocket layer for agents and operators.

realtime

01 Mint a socket token with /api/v1/socket_tokens 02 Connect to /socket with socket_token 03 Join a topic and handle command.dispatch and trace.created Open guide Auth endpoints

Recently shipped

changelog

2026-08 Marketplace partner integration Any marketplace that rents out agents can provision workspaces for its users, open one engagement per job, and hand the rented runtime an append-only credential scoped to that single job. Runtime events are deny-by-default: payload bodies are refused at ingest, sequence is server-assigned, and closing a job revokes its credential on the next request. Open partner guide
2026-08 Fleet operations core Cohorts (groups, sites, tags) now target robots and service agents together, zero-touch provisioning claims pre-registered units from one reusable token, telemetry arrives in idempotent batches behind minute and hour rollups, and bulk operations act on up to 5,000 filtered targets with live progress and per-target retry. Open cohort guide
2026-08 Batched telemetry, rollups, and trend charts POST /api/v1/robots/me/telemetry accepts up to 500 readings per batch, deduplicates on a client-supplied batch_id, and backfills up to seven days. Minute and hour rollups feed 1h to 30d trend charts and outlive raw retention. Open telemetry guide
2026-08 Bulk operations with audited batch jobs Select robots explicitly or by filter, apply one of seven action kinds, and watch queued, succeeded, failed, and skipped counts stream in. Failures never abort the batch, failed targets can be retried into a child batch, and every batch is audited. Open bulk operations guide
2026-08 Emergency freeze and enforced workspace status Freezes scoped to a workspace, a connector, or one service agent short-circuit authorization with decision_path frozen and an audited denial. Workspace paused and archived are now enforced on all machine traffic, and approvals granted before a freeze no longer execute after it. Open freeze guide
2026-08 Zero-touch provisioning and the claim flow Fleet claim tokens carry max_claims, an expiry, an optional serial allowlist, a cohort binding, and default tags. Each claim binds to a pre-registered serial and mints a credential unique to that robot; the claim token itself never authenticates an API request. Open provisioning guide
2026-08 Password reset for operators Self-serve account recovery at /users/forgot-password, throttled per IP and per address, with an enumeration-safe response, a single-use link that expires in 60 minutes, and full session invalidation on reset. Open authentication guide
2026-07 Production readiness and durable secrets Production now requires a durable secret provider and stable encryption key. JSON health/readiness probes, protected metrics, versioned releases, readiness-gated deploys, safe legacy-secret migration, and outbound URL protections are documented together. Open production guide
2026-07 Durable approvals and billing recovery Approved actions execute through durable workers, pending approvals expire automatically, and NOWPayments callbacks enter an idempotent database inbox before retryable background processing. Credit charges and compensating refunds are also deduplicated. Operator - Gateway
2026-07 Cluster-safe agent runtime Realtime routing now coordinates connections across nodes, atomically claims commands and tasks, safely replaces stale sockets, recovers interrupted message dispatches, and lets assigned agents finish delegated work with task.complete or task.fail. Review realtime events
2026-06 Cross-agent communication API Agent communication now runs natively on the shared /api/v1 and /socket surfaces. Self-registration returns the canonical agk_ credential, and workspace and sender identity always come from authentication. Open cross-agent guide
2026-04 Agent security and compliance Service-agent RBAC with security roles, async policy violation detection, SOC 2 and GDPR compliance report generation, and a dedicated /app/security dashboard with operator API. Browse security endpoints
2026-03 Fleet management for physical robots Robot registration, mission lifecycle, diagnostics, fleet alerts, OTA update management, and predictive maintenance are now part of the operator surface. Realtime fleet channels stream robot heartbeats, status changes, mission updates, and alert events over WebSocket. Operator - Fleet
2026-03 Realtime channels and WebSockets Service agents can now mint short-lived socket tokens, connect to /socket, join Phoenix channels, receive commands, and stream trace, replay, and approval lifecycle updates in realtime. Open WebSocket guide
2026-02 SCIM 2.0 enterprise provisioning Full SCIM 2.0 support for enterprise identity provisioning. User and group CRUD, filtering, pagination, and idempotent upsert via externalId. Compatible with Okta, Azure AD, and other identity providers. SCIM v2
2026-02 Gateway execute with trace recording New POST /api/v1/gateway/execute endpoint provides unified action execution with full trace event recording. Returns detailed SMTP events (connecting, authenticated, sent) and persists traces for UI observability. Gateway
2026-02 Webhook delivery system Outbound webhook subscriptions with HMAC-SHA256 signed deliveries, exponential backoff retry (up to 8 attempts), and delivery status tracking. Subscribe to 20+ event types or use the wildcard for all events. Operator - Webhooks
2026-01 Primary workspace API key Protected public APIs now accept the primary workspace API key directly. POST /api/v1/register returns a ready-to-use key, and POST /api/v1/agent_tokens remains optional for clients that want a 30-day access token. Authentication
2026-01 Policy packaging and secrets depth Managed secret APIs, policy template packs, and richer connector catalog metadata are now part of the operator surface. Operator - Gateway
2025-12 Observability search and correlation Cross-surface search and related-record correlation endpoints now expose traces, alerts, replays, and failure groups through one operator query layer. Operator - Observability
2025-12 Evals review and incident learning Eval review queues, incident-generated eval drafts, promotion flows, and shadow-run request fields are now documented below. Operator - Evals

API and Realtime Documentation

Robots Center now has a WebSocket layer for agents and operators.

Recently shipped

Endpoints