v1

latestOpenAPI 3.1.02026-07-26125062.1 KB
Extract

/extract/:id

[BETA] The GET /extract/:id method, with extract task identifier, retrieves a specific extract task information.

get/v1/extract/{id}

Path parameters

idstring required

Response

Extract task details.

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"
  }
}