Sign in

v1

latestOpenAPI 3.1.02026-07-26125062.1 KB
Extract

/extract

[BETA] The POST /extract method creates an asynchronous extract task.

post/v1/extract

Request body

qstring required

[BETA] The natural-language query describing which rows to extract and what each row should contain.

{"stackTrail":"components:schemas:ExtractTaskInput:properties:schema","oasType":"schema","type":"unknown","description":"[BETA] Optional JSON schema describing a single extracted row. When provided, every returned row must match this schema."}
urlstring uri required

[BETA] The seed URL the extract task should start from.

verifyUrlsboolean

[BETA] Defines whether URLs found in extracted rows should be checked for reachability after extraction. Defaults to false.

Example request

{
  "url": "https://example.com/team"
}

Response

Extract task created successfully.

createdAtstring date-time required

The date and time when the task was created.

errorstring nullable required

The error message if the task failed.

idstring required

The unique identifier of the task.

status'completed' | 'failed' | 'pending' | 'processing' required

The current status of the task.

updatedAtstring date-time required

The date and time when the task status was last updated.

type'extract' required

Example response

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "id": "01234-abcd-56789",
  "status": "completed",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "input": {
    "url": "https://example.com/team"
  }
}