Documentation menu

API · Documents

Download one picture

GET /api/v1/documents/{id}/images/{image_id}

The image file itself: image/png for a cropped figure, image/jpeg for a whole page, at most 1568px on the long side. Use the url from the images list rather than building it.

Path parameters

  • id string required

    The document's id.

  • image_id string required

    The image's id, from the images list.

Returns 200

The image bytes (image/png or image/jpeg)

Errors

  • 401

    Missing, revoked or expired key
  • 402

    Payment required. Either the plan's monthly request quota is spent (quota_exceeded, trial plans only — pay as you go is never capped) or the workspace is out of credit (insufficient_credits).
  • 404

    No document or query with that id for this key (documents are scoped to the key's workspace and live/test mode)
  • 409

    The document has not finished processing
  • 410

    Retention ran out and the result was purged
  • 429

    Per-second burst limit for the plan exceeded; retry after Retry-After seconds

Every error has the same shape. See Errors.