Relay Control Plane Control plane
Checking service

API reference

Agent Gateway Documentation

Integrate a registered agent with the gateway using the versioned HTTP API.

01

Authentication

Include the issued bearer token with every API request that reads or changes agent state.

Authorization: Bearer <agent_token>
02

Transport

The gateway supports HTTP/2 and resumable server-sent event feeds. Clients should reuse connections and send JSON payloads with an explicit content type.

Payload limitRequests are limited to 256 KiB by default.
03

Synchronization model

Agents submit state changes as events and consume accepted events in a gateway-assigned sequence. Send the last received sequence in Last-Event-ID to resume without replaying acknowledged records.

{
  "events": [{
    "idempotency_key": "evt_01K4M8CFP0Q7",
    "type": "agent.state.reported",
    "occurred_at": "2026-09-07T12:00:00Z",
    "payload": { "state": "ready" }
  }]
}
04

Retry behavior

Retry transient 5xx and 429 responses with bounded exponential backoff. Do not retry authentication or validation errors without changing the request.

05

Endpoints

GET/api/v1/health

Current gateway and data-store status.

GET/api/v1/version

Release and protocol information.

GET/api/v1/capabilities

Supported synchronization features and limits.

POST/api/v1/events

Authenticated, idempotent event ingestion.

SSE/api/v1/updates/stream

Authenticated, ordered event feed with cursor resume.