Understand Responses

Immediate Responses

Synchronous endpoints return requested data in the same response.

Example

{
  "success": true,
  "data": {
    "markdown": "# Example Domain",
    "links": ["https://www.iana.org/domains/example"]
  },
  "error": null
}

Start the job, store job_id, then poll its status URL or use a webhook.

Example

{
  "success": true,
  "job_id": "job_01HXYZ",
  "status": "queued"
}

Example

{
  "success": true,
  "job_id": "job_01HXYZ",
  "status": "completed",
  "completed_pages": 10,
  "total_pages": 10
}

Use the HTTP status first. Read detail or the endpoint's public error field for the reason.

Example

{
  "detail": "Invalid or expired API key"
}