Skip to main content

Chains Commands

See Chains module docs for permissions and data model.

soat list-chains​

List continuation chains

  • Method: GET
  • Path: /api/v1/chains

Usage​

soat list-chains

Options​

--project-id​

Project ID (required if not using project key auth)

  • Source: query
  • Required: no
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B
--status​

Filter by chain status. Repeat the parameter to OR values. A value outside the enum, empty string included, is a 400.

  • Source: query
  • Required: no
  • Type: array<enum("active", "concluded", "expired", "budget_exhausted")>
--agent-id​

Filter by the agent whose continuation opened the chain

  • Source: query
  • Required: no
  • Type: string
  • Example: agent_V1StGXR8Z5jdHi6B

soat get-chain​

Get a continuation chain

  • Method: GET
  • Path: /api/v1/chains/{chain_id}

Usage​

soat get-chain

Options​

This command has no options.