Skip to main content
New to Omium? Start with Installation and Quickstart, or open the REST reference index below if you already have an API key.

​
What this API is for

The Omium HTTP API sits alongside the Python SDK and CLI. Use it when you want to list executions, drive replays from your own orchestrator, or integrate Omium into a service written in any language. Day-to-day tracing still flows through the SDK in production apps.

​
Base URL

​
Authentication

​
Available resources

These endpoints are documented in detail on the pages linked in the sidebar.
AreaUse itPrimary paths
ExecutionsStart runs, inspect status, replay or roll back from checkpointsGET/POST /executions, /executions/{id}/replay
CheckpointsList checkpoints, fetch state for recoveryGET /checkpoints, GET /checkpoints/{id}
WorkflowsRegister and version workflows you push from projectsGET/POST/PUT/DELETE /workflows
FailuresInvestigate failed runs and track resolutionGET /failures, GET /failures/stats
BillingRead balances, usage, and subscription stateGET /billing/*
If you are building a new integration, read Executions first, then Checkpoints.

​
Client libraries

For Python, install the official package so headers, paths, and retries stay consistent: 
pip install omium
The SDK reads OMIUM_API_KEY and OMIUM_API_URL when you call omium.init() without arguments. See Python SDK and CLI reference for everything the shipped client can do.

​
Minimal request

List recent executions (empty list is normal on a new account): 
curl -sS "https://api.omium.ai/api/v1/executions?page=1&page_size=20" \
  -H "X-API-Key: $OMIUM_API_KEY" \
  -H "Content-Type: application/json"

​
Errors and limits

  • Expect regular HTTP status codes (401 for bad keys, 404 for unknown IDs, 429 when throttled).
  • For platform-wide throughput and spend, see your dashboard and API keys & billing.

​
Next steps

Quickstart

Run a traced workflow locally in a few minutes.

Executions API

Request and response shapes for runs and replays.

Python SDK

Instrument LangGraph, CrewAI, or your own code.

Platform capabilities

Map features to APIs and dashboard surfaces.