---
title: "Extract structured data"
method: POST
path: "/web/extract"
tags: ["Web"]
---

# Extract structured data

`POST /web/extract`

## Request

- Base URL: `https://api.crevio.co/v1`
- URL: `https://api.crevio.co/v1/web/extract`
- Auth: API key in header `Authorization`

Extracts structured data across one or more URLs, guided by a prompt and optional JSON schema. Asynchronous — returns a queued job; poll `GET /v1/jobs/{id}` for the data. Charges credits on completion.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `urls` string[], required: URLs to extract from.
  - `prompt` string, required: What to extract.
  - `schema` object: Optional JSON schema for the output shape.

## Response `202`

Job queued

- ProviderJob
  - `id` string, required
  - `object` string, required
  - `type` string, required
  - `status` 'queued' | 'processing' | 'completed' | 'failed' | 'cancelled', required
  - `model` string, required
  - `progress` integer, required
  - `input` object, required
  - `result` object, nullable, required
  - `error` string, nullable, required
  - `error_code` string, nullable, required
  - `credits_used` integer, nullable, required
  - `provider_request_id` string, nullable, required
  - `created_at` string, date-time, required
  - `started_at` string, date-time, nullable, required
  - `completed_at` string, date-time, nullable, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `402`: Insufficient credits
- `422`: Validation error
- `429`: Rate limit exceeded — 600 requests per minute per credential. Retry after the number of seconds in `Retry-After`.
- `500`: Internal server error

---

[API](https://skmtc.dev/crevio/apis/crevio-api-v1.md) · [All operations](https://skmtc.dev/crevio/apis/crevio-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/crevio/apis/crevio-api-v1/revisions/2219f18ad651?raw)