# Web Extract API

Pull structured JSON out of any web page: name the fields you want, or send a JSON Schema, and get one row per URL with the values. Pages are always fetched live. Failed extractions and schema mismatches are not charged.

**Pricing:** $0.01 per page

**Endpoint:** `POST /v1/data/web/extract/run`

**Auth:** `Authorization: Bearer mk_live_...`

## Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urls` | array | Yes | Pages to extract from, up to 100 per request. One row per page. |
| `fields` | array | No | Names of the values to pull from each page, like price, title or author. |
| `schema` | object | No | A JSON Schema object (type object with properties) describing the data to extract. Every property needs a type, and every array needs items. |
| `prompt` | string | No | Optional guidance in plain words, like: prices in USD, monthly billing only. |

## Example

`?wait=true` holds the request open until the run finishes (up to 60s) and returns the rows inline: one request, no polling.

```bash
curl -X POST "https://api.mindcase.co/v1/data/web/extract/run?wait=true" \
  -H "Authorization: Bearer mk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"params":{"urls":["..."]}}'
```

```python
import requests

resp = requests.post(
    "https://api.mindcase.co/v1/data/web/extract/run",
    params={"wait": "true"},
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
    json={"params": {
    "urls": [
        "..."
    ]
}},
)
rows = resp.json()["data"]
```

## Longer runs

If the run is still going at the 60s ceiling you get back `{ job_id, status: "running" }` instead of rows (same if the result is over 100 rows; those come back `truncated`). Poll with that `job_id`:

```bash
# 1) check status
curl https://api.mindcase.co/v1/jobs/JOB_ID \
  -H "Authorization: Bearer mk_live_YOUR_API_KEY"

# 2) when status == completed, fetch the rows
curl https://api.mindcase.co/v1/jobs/JOB_ID/results \
  -H "Authorization: Bearer mk_live_YOUR_API_KEY"
```

Full API reference (auth, jobs, balance, SDKs, MCP): https://mindcase.co/skills.md

## Response columns

| Field | Display name | Type |
|-------|--------------|------|
| `url` | URL | text |
| `extractStatus` | Extract Status | text |
| `data` | Data | object |
| `fieldsFound` | Fields Found | integer |
| `statusCode` | Status Code | integer |
| `fetchedAt` | Fetched At | text |
| `engine` | Engine | text |
| `errorType` | Error Type | text |
| `errorMessage` | Error Message | text |