> ## 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.

# API reference

> The Sequentum Cloud REST API, organized by resource.

The Sequentum Cloud API is REST over HTTPS. Requests are JSON; responses are JSON. Every resource lives under `/api/v1` on the production base URL:

```
https://dashboard.sequentum.com/api/v1
```

## Conventions

* **Authentication** — `Authorization: ApiKey {key}` header. See [Authentication](/api-reference/authentication).
* **Identifiers** — Agents use integer `agentId`. Runs use integer `runId`. Sessions use string `sessionId`.
* **Times** — ISO 8601, UTC. Always serialized as strings.
* **Pagination** — list endpoints that paginate accept `pageIndex` (1-based) and `recordsPerPage`. When provided, the response is `{ items: [...], totalRecordCount: N }`; when omitted, the response is a plain array (backward-compatible shape on legacy endpoints). Endpoints that don't paginate return the full list.
* **Rate limits** — 100 requests per 60-second window per API key, with `X-RateLimit-Limit`, `X-RateLimit-Window-Seconds`, and `Retry-After` (on `429`) response headers. See [Errors](/api-reference/errors).
* **Errors** — RFC 7807 problem details. See [Errors](/api-reference/errors).

## Resources

<CardGroup cols={2}>
  <Card title="Agent Builder" icon="wand-magic-sparkles" href="/api-reference/agent-builder/start-session">
    Prompt-to-agent sessions that produce a new Agent.
  </Card>

  <Card title="Agents" icon="robot" href="/api-reference/agents/start-run">
    List, run, version, archive — the core Agent lifecycle.
  </Card>

  <Card title="Schedules" icon="calendar" href="/api-reference/schedules/list">
    Cron, run-once, and interval triggers attached to Agents.
  </Card>

  <Card title="Analytics" icon="chart-line" href="/api-reference/analytics/runs-summary">
    Run summaries, records summaries, and per-run diagnostics.
  </Card>

  <Card title="Billing" icon="credit-card" href="/api-reference/billing/credits">
    Credits balance, spending, history, and per-agent cost breakdowns.
  </Card>

  <Card title="Spaces" icon="layer-group" href="/api-reference/spaces/list">
    Workspaces grouping agents, members, and credits.
  </Card>
</CardGroup>

## Choosing a transport

Most endpoints are simple request/response. A few patterns are worth knowing:

* **Synchronous vs. asynchronous run start** — `POST /api/v1/agent/{agentId}/start` accepts an `isRunSynchronously` flag. When `false` (default), the call returns immediately with a `runId` and you poll for completion. When `true`, the call blocks until the run finishes and returns extracted records inline. Use sync only when the run is fast and you need the data in the same request — async is the right default for production.
* **Polling run status** — for async runs, poll `GET /api/v1/agent/{agentId}/run/{runId}/status` until the status is terminal: `Completed` (9), `Success` (10), `Failure` (6, restartable), `Stopped` (8), or `Skipped` (11). See [Runs](/concepts/runs) for the full lifecycle.

## Tools

* **OpenAPI spec** — this site renders from the live server spec at [`https://dashboard.sequentum.com/swagger/v1/swagger.json`](https://dashboard.sequentum.com/swagger/v1/swagger.json). The interactive Swagger UI is available at [`https://dashboard.sequentum.com/api-docs/index.html`](https://dashboard.sequentum.com/api-docs/index.html).
* **Postman collection** — [`postman.com/sequentumdev/sequentum-cloud`](https://www.postman.com/sequentumdev/sequentum-cloud/overview).

## SDKs

Official SDKs are coming for Node and Python. Until then, every endpoint works fine over `curl` or `fetch` / `requests`.