Skip to main content
The Engine exposes a single HTTP API on the port your deployment chose (default 8000). Every endpoint other than /health requires authentication via the X-Engine-Key header. Most write endpoints accept JSON; the execution endpoint streams Server-Sent Events back to the client.

​
Conventions

  • Base URL — your deployment’s URL (no version prefix today).
  • Auth header — X-Engine-Key: <key> on every request except /health.
  • Content type — application/json for request bodies that have one.
  • Streaming — /execute returns text/event-stream (SSE).
  • Errors — non-2xx responses include a JSON body {"error": "<code>", "message": "<human description>"}. See Errors.

​
Endpoints by category

​
Execution

Reference →

​
Human-in-the-loop

Reference →

​
RPC

Reference →

​
Asset Directory (MCP connectors)

Reference →

​
Memory

Reference →

​
Skills

Reference →

​
Admin

Reference →

​
Observability

Reference →

​
Authentication

Every endpoint except /health requires the X-Engine-Key header. See Authentication for how keys are issued, hashed, and rotated.

​
Streaming

POST /execute returns Server-Sent Events. Each event has a type (text_delta, tool_call, tool_result, hitl_request, etc.) and a JSON data payload. The complete event catalog lives at Streaming events.