Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sequentum.com/llms.txt

Use this file to discover all available pages before exploring further.

Errors are returned as JSON with the standard RFC 7807 problem-details shape: 
{
  "type": "https://docs.sequentum.com/errors/agent-not-found",
  "title": "Agent not found",
  "status": 404,
  "detail": "No agent with id 4711 exists in space 1.",
  "instance": "/api/v1/agent/4711"
}

​
HTTP status codes

CodeMeaning
200OK — request succeeded.
201Created — a new resource was created.
202Accepted — async work was queued (e.g., start run).
400Bad request — invalid input. detail will explain.
401Unauthorized — missing or invalid API key.
403Forbidden — the key is valid but lacks access to the resource.
404Not found.
409Conflict — usually a state-machine violation (e.g., finish on a cancelled session).
422Unprocessable entity — request was syntactically valid but semantically rejected.
429Rate limited. Retry after the Retry-After header.
500, 502, 503Server error. Safe to retry with backoff.

​
Rate limits

The API limits each API key to 100 requests per 60-second window (with a small queue of 10 requests when the limit is reached). When you exceed the limit, you’ll get 429 Too Many Requests. Three response headers communicate the limit on every request:
HeaderMeaning
X-RateLimit-LimitMax requests in the window (default: 100).
X-RateLimit-Window-SecondsWindow length (default: 60).
Retry-AfterSeconds to wait before retrying — only present on 429 responses.
If you’re hitting the limit consistently, contact support — limits are config-driven per deployment and can be raised. Limits apply per API key, so distinct keys (e.g., per-environment) get independent budgets.

​
Retries

Retry 5xx and 429 responses with exponential backoff, respecting Retry-After when present. Do not retry 4xx responses other than 429. POST endpoints are not currently idempotent. A retried POST /agent/{id}/start will queue a second Run — design your retry logic to check before retrying (e.g., poll GET /agent/{id}/runs for a recent in-flight Run before issuing another start).