API Reference - Extralt API

The Extralt REST API is available at api.extralt.com for users with an active subscription. All requests require an API key passed as a Bearer token: Authorization: Bearer <key>.

For the full reference with request/response schemas and examples, visit api.extralt.com/docs.

Getting Started

Create an account and subscribe to a plan
Generate an API key from your dashboard
Start making requests to https://api.extralt.com

Endpoints

Extract

Base path: /v0/extract

Robot Builds

Build jobs that generate robots. Track status from pending through building to completed or failed.

GET/robot-buildsList all robot builds

POST/robot-buildsCreate a robot build

GET/robot-builds/{id}Read a robot build

DELETE/robot-builds/{id}Delete a robot build

POST/robot-builds/{id}/stopStop a robot build

Robots

AI-generated crawlers compiled to Rust. Each robot targets a specific host and country.

GET/robotsList all robots

PATCH/robots/{id}Rename a robot

DELETE/robots/{id}Delete a robot

Runs

Execution instances of a robot. Each run crawls URLs, extracts data, and tracks progress.

GET/runsList all runs

POST/runsCreate a run

GET/runs/{id}Read a run

POST/runs/{id}/restartRestart a run

POST/runs/{id}/stopStop a run

Captures

Extracted data records from completed runs.

GET/capturesList captures for a run

GET/captures/countCount captures for a run

GET/captures/exportExport captures as Parquet or JSONL

POST/captures/queryRun a SQL query over captures

Schedules

Recurring extraction automation. Link a robot to a cadence and Extralt creates runs automatically.

GET/schedulesList all schedules

POST/schedulesCreate a schedule

GET/schedules/{id}Read a schedule

PATCH/schedules/{id}Update a schedule

DELETE/schedules/{id}Delete a schedule

POST/schedules/{id}/pausePause a schedule

POST/schedules/{id}/resumeResume a schedule

Enrich

Base path: /v0/enrich

Enrichments

Enrichment jobs that translate captures to English, classify them with a taxonomy, and extract attributes and signals into structured items.

GET/enrichmentsList all enrichments

POST/enrichmentsCreate an enrichment

GET/enrichments/{id}Read an enrichment

POST/enrichments/{id}/stopStop an enrichment

Items

Enriched item rows produced by an enrichment, with transformed offers embedded.

GET/itemsList items produced by an enrichment

GET/items/{item_id}Read an item with its embedded offers