API Reference
The stable Extralt REST API is available at api.extralt.com. Public v1 requests require an org-scoped API key passed as a Bearer token: Authorization: Bearer <key>.
Getting started
- Create an account and subscribe to a plan
- Generate an API key from your dashboard
- Install the Python or TypeScript SDK, or make
requests under
https://api.extralt.com/v1directly
Create and restart operations require an Idempotency-Key header so that a
network retry cannot duplicate work; the SDKs send one for you.
Endpoints
Every operation, with its parameters, responses, and examples, is documented in
the API reference. Each is one SDK method in the
same area and resource, such as client.extract.runs.create for
POST /v1/extract/runs.
Conventions
The generated OpenAPI document is the authoritative reference for request fields, response schemas, status codes, and enums.
Text fields of Captures, Items, and Explore results use an empty string ("")
for absence in API responses, exports, and direct queries. This includes
product page URLs: an imported product without a page URL returns "".
Exports stream the stored values without converting empty strings to null.
Embedded JSON retains its own null values, and nullable numbers and timestamps
remain nullable.
Subscriptions and access
An active subscription is required for writes. After a subscription ends, the 30-day grace period permits read-only API access and exports. After grace, organization access is suspended; after 180 days, the organization is deactivated. Billing and reactivation remain available through the dashboard while an organization is suspended.
During grace, stop and pause operations remain available to reduce risk.
Retrying a completed idempotent request returns its stored result, while a new
request is rejected with 402 Payment Required. Suspended and deactivated
organizations cannot use these data operations.
MCP
For compatible agent clients, Extralt exposes the same customer-facing capabilities as task-oriented MCP tools with OAuth. MCP is documented separately because its tools are not REST routes. See Connect through MCP.