Skip to main content
The REST API is the canonical interface behind the TypeScript SDK.
All public routes are versioned under /v1 and use JSON.
The Runbook endpoints and the infragrid TypeScript package are a preview contract. They are not available in the production API or npm registry until the corresponding API rollout is complete.

Authentication

The key determines the workspace and allowed scopes. API keys are server credentials and must not be placed in browser JavaScript, URLs, or logs.

Resources

Runs

Start ad-hoc or Runbook executions, recover status, list history, and cancel work.

Runbooks

Create, update, publish, and execute reusable programmable definitions.

API keys

Manage scoped workspace credentials through an authenticated dashboard session.

Pagination

  • Runs use limit and offset.
  • Runbooks use a bounded limit.
  • List endpoints return at most 100 items.

Idempotency

POST /v1/runs, POST /v1/runbooks, and POST /v1/runbooks/{runbook_id}/runs accept X-Idempotency-Key. Reusing the same key with a different request body returns 409.

Run statuses

Runs report queued, running, waiting_for_approval, completed, failed, or cancelled.

Common error body

Last modified on August 28, 2026