Skip to main content

​
Endpoints

MethodPathWhat it does
GET/executionsList executions
GET/executions/{execution_id}Get execution details
POST/executionsCreate an execution
POST/executions/{execution_id}/replayReplay from checkpoint
POST/executions/{execution_id}/rollbackRoll back to checkpoint

​
List executions

GET /executions Query parameters:
  • workflow_id (optional)
  • status (optional): running | completed | failed | cancelled | paused
  • page (default: 1)
  • page_size (default: 20)
curl -sS "https://api.omium.ai/api/v1/executions?page=1&page_size=20" \
  -H "X-API-Key: $OMIUM_API_KEY"
Response: 
{
  "items": [
    {
      "id": "exec_abc",
      "workflow_id": "workflow_xyz",
      "status": "running",
      "created_at": "2026-01-01T12:00:00Z",
      "updated_at": "2026-01-01T12:01:00Z",
      "input_data": {},
      "output_data": null
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 20
}

​
Get execution

GET /executions/{execution_id} 
curl -sS "https://api.omium.ai/api/v1/executions/exec_abc" \
  -H "X-API-Key: $OMIUM_API_KEY"
Response (example): 
{
  "id": "exec_abc",
  "workflow_id": "workflow_xyz",
  "status": "completed",
  "created_at": "2026-01-01T12:00:00Z",
  "updated_at": "2026-01-01T12:05:00Z",
  "input_data": { "query": "latest AI trends" },
  "output_data": { "report": "..." },
  "error": null,
  "checkpoints": [
    { "id": "chk_1", "name": "start", "created_at": "..." }
  ]
}

​
Create execution

POST /executions 
curl -sS "https://api.omium.ai/api/v1/executions" \
  -H "X-API-Key: $OMIUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_id": "workflow_xyz",
    "input_data": { "query": "Research quantum computing advancements" },
    "metadata": { "user_id": "user_123", "priority": "high" }
  }'
Response: 
{
  "id": "exec_new_123",
  "workflow_id": "workflow_xyz",
  "status": "running",
  "created_at": "2026-01-01T12:10:00Z"
}

​
Replay from checkpoint

POST /executions/{execution_id}/replay 
curl -sS "https://api.omium.ai/api/v1/executions/exec_abc/replay" \
  -H "X-API-Key: $OMIUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "checkpoint_id": "checkpoint_456" }'

​
Roll back to checkpoint

POST /executions/{execution_id}/rollback Rolling back pauses the execution at a prior checkpoint and discards later state. 
curl -sS "https://api.omium.ai/api/v1/executions/exec_abc/rollback" \
  -H "X-API-Key: $OMIUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "checkpoint_id": "checkpoint_456" }'

​
Next steps

Checkpoints

List and fetch checkpoint state for recovery.

Failures

Understand failed runs and resolution flows.