Skip to main content

​
Base URL

All API requests should be made to: https://api.omium.ai/api/v1

​
Authentication

All API requests require authentication using an API key. Include it in the X-API-Key header or as a Bearer token. 
# Using X-API-Key header (recommended)
curl -X GET "https://api.omium.ai/api/v1/checkpoints" \
  -H "X-API-Key: omium_xxxxx"

# Using Bearer token
curl -X GET "https://api.omium.ai/api/v1/checkpoints" \
  -H "Authorization: Bearer omium_xxxxx"

​
Endpoints

​
List Checkpoints

GET /checkpoints List all checkpoints for a given execution. Query Parameters:
  • execution_id: (Required) The ID of the execution.
  • limit: Maximum number of checkpoints to return (default: 50).
  • offset: Number of checkpoints to skip (for pagination).
Response: 
{
  "items": [
    {
      "id": "chk_1",
      "execution_id": "exec_abc",
      "name": "initial_state",
      "created_at": "2025-01-01T12:00:00Z",
      "metadata": {}
    },
    {
      "id": "chk_2",
      "execution_id": "exec_abc",
      "name": "data_processed",
      "created_at": "2025-01-01T12:01:30Z",
      "metadata": { "step": "process_data" }
    }
  ],
  "total": 2,
  "limit": 50,
  "offset": 0
}

​
Get Checkpoint Details

GET /checkpoints/{checkpoint_id} Retrieve details of a specific checkpoint, optionally including its full state. Path Parameters:
  • checkpoint_id: The ID of the checkpoint.
Query Parameters:
  • include_state: If true, the full execution state at this checkpoint will be returned (default: false).
Response (without state): 
{
  "id": "chk_1",
  "execution_id": "exec_abc",
  "name": "initial_state",
  "created_at": "2025-01-01T12:00:00Z",
  "metadata": {}
}
Response (with state): 
{
  "id": "chk_1",
  "execution_id": "exec_abc",
  "name": "initial_state",
  "created_at": "2025-01-01T12:00:00Z",
  "metadata": {},
  "state": {
    "current_step": "start",
    "variables": {
      "input": "initial_input_data"
    }
  }
}

​
Create Checkpoint (via SDK)

POST /checkpoints Manually create a checkpoint for an ongoing execution. This is typically done via the Omium SDK. Request Body: 
{
  "execution_id": "exec_abc",
  "name": "custom_checkpoint_name",
  "state": {
    "current_data": "intermediate_result",
    "status": "in_progress"
  },
  "metadata": {
    "user_note": "Manual save point"
  }
}
Response: 
{
  "id": "chk_new_123",
  "execution_id": "exec_abc",
  "name": "custom_checkpoint_name",
  "created_at": "2025-01-01T12:03:00Z"
}