---
title: "POST /vocr"
method: POST
path: "/vocr"
---

# POST /vocr

`POST /vocr`

## Request

- Base URL: `https://api.jigsawstack.com/v1`
- URL: `https://api.jigsawstack.com/v1/vocr`
- Auth: API key in header `x-api-key`

## Request body

- object
  - `url` string
  - `file_store_key` string
  - `prompt` union
    - string
    - string[]
    - object
  - `page_range` number[], nullable
  - `fine_grained` boolean: High fidelity word level bounding boxes within complex documents
  - `return_bounds` boolean: Include bounding box coordinates for each line and word. When false, the coordinates are omitted but the text and confidence are still returned.

## Response `200`

Successful response

- object
  - `success` boolean: Whether the request was successful
  - `data` object: Response data
  - `error` object: Error details if request failed
    - `message` string: Error message
    - `code` string: Error code

## Other responses

- `400`: Bad Request - The request was malformed or contained invalid parameters
- `401`: Unauthorized - Authentication credentials are missing or invalid
- `403`: Forbidden - The request is not allowed
- `404`: Not Found - The requested resource was not found
- `500`: Internal Server Error - Something went wrong on our end

---

[API](https://skmtc.dev/jigsawstack/apis/jigsawstack-api.md) · [All operations](https://skmtc.dev/jigsawstack/apis/jigsawstack-api/llms.txt) · [OpenAPI document](https://skmtc.dev/jigsawstack/apis/jigsawstack-api/revisions/8bd803916bde?raw)