API reference

OpenAPI

One tag: method, path, summary, auth, and scopes. Request and response fields ship in this page — expand a row to read the contract.

Browse docs

Endpoints

GET

/api/v1/openapi.json

Get OpenAPI specification

Returns the OpenAPI 3.1 specification for the Robots Center API.

None

Responses

200

OpenAPI 3.1 specification

Returns: OpenAPI

GET

/api/v1/openapi/agent-communication.json

Get agent communication OpenAPI specification

Returns the SDK-focused OpenAPI 3.1 contract for agent onboarding and communication.

None

Responses

200

Agent communication OpenAPI 3.1 specification

429

Client IP rate limit exceeded

Returns: AgentCommunicationProblem

GET

/api/v1/realtime/agent-communication.json

Get agent communication realtime contract

Returns the authoritative Phoenix v2 websocket contract for agent communication.

None

Responses

200

Agent communication realtime contract