Argyll logo Argyll

Engine API

The OpenAPI specifications are the source of truth for engine and Step HTTP contracts.

Specifications

  • Engine API covers Step and Space management, Space membership, Flow execution and queries, planning, health, and engine state.
  • Step Interface covers invocation requests, responses, execution headers, and async completion.

Open either specification in Swagger UI, Redoc, or an editor with OpenAPI support to browse schemas and send requests.

Spaces

Use /engine/spaces to list or create Spaces and /engine/spaces/{space_id} to read, replace, or delete one. GET /engine/spaces/{space_id}/steps returns the current Steps selected by that Space. Pass space_id when creating a Flow or previewing a plan, or set flow.space_id on a Flow Step, to restrict planning to those Steps. See Spaces for selector semantics.

For a complete request sequence, use the Quick Start. For live event subscriptions, see WebSocket API.

Next WebSocket API