Skip to main content

​
Endpoints

MethodPathWhat it does
GET/checkpoints?execution_id=...List checkpoints for an execution
GET/checkpoints/{checkpoint_id}Fetch checkpoint metadata
GET/checkpoints/{checkpoint_id}?include_state=trueFetch checkpoint metadata + state
POST/checkpointsCreate a checkpoint (usually via SDK)

​
List checkpoints

GET /checkpoints Parameters:
  • execution_id (required)
  • limit (default: 50)
  • offset (default: 0)
curl -sS "https://api.omium.ai/api/v1/checkpoints?execution_id=exec_abc&limit=50" \
  -H "X-API-Key: $OMIUM_API_KEY"
Response: 
{
  "items": [
    {
      "id": "chk_1",
      "execution_id": "exec_abc",
      "name": "initial_state",
      "created_at": "2026-01-01T12:00:00Z",
      "metadata": {}
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

​
Get a checkpoint

GET /checkpoints/{checkpoint_id} 
curl -sS "https://api.omium.ai/api/v1/checkpoints/chk_1" \
  -H "X-API-Key: $OMIUM_API_KEY"
To include state: 
curl -sS "https://api.omium.ai/api/v1/checkpoints/chk_1?include_state=true" \
  -H "X-API-Key: $OMIUM_API_KEY"

​
Create a checkpoint

POST /checkpoints Most applications create checkpoints via the SDK (@omium.checkpoint or auto-checkpointing). If you manage state yourself, you can post a checkpoint explicitly: 
curl -sS "https://api.omium.ai/api/v1/checkpoints" \
  -H "X-API-Key: $OMIUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "execution_id": "exec_abc",
    "name": "custom_checkpoint_name",
    "state": { "step": "after_load", "vars": { "count": 42 } },
    "metadata": { "note": "manual save point" }
  }'

​
Next steps

Executions

Replay and rollback flows use checkpoint IDs.

Python SDK

Prefer decorators and auto-checkpoints in Python apps.