POST
/
v1
/
vocr
import { JigsawStack } from "jigsawstack";

const jigsawstack = JigsawStack({
apiKey: "your-api-key",
});

const result = await jigsaw.vision.vocr({
prompt: ["Title", "Description"],
url: "https://res.cloudinary.com/dev-ninja/image/upload/v1712567895/webhooks_qaaslj.png",
});


{
"success": true,
"context": {
  "Title": [
    "Webhook Trigger"
  ],
  "Description": [
    "Select events that will trigger the webhook will listen to. At least one event must be selected.",
    "Success logs",
    "Error logs",
    "Endpoint",
    "Create"
  ]
},
"width": 2880,
"height": 1800,
"tags": [
  "text",
  "screenshot",
  "software",
  "multimedia software",
  "graphics software"
],
"has_text": true,
"sections": [
  {
    "text": "",
    "lines": []
  }
]
}

​
Body

​
prompt
string | Array<string>

The prompt used to describe the image. Default prompt is Describe the image in detail.

​
url
string

The image url. Not required if file_store_key is specified.

​
file_store_key
string

The key used to store the image on Jigsawstack File Storage. Not required if url is specified.

​
page_range
Array<number>

Specifies a range of pages to process with vOCR, provided as a two-element array: [startPage, endPage]. For example, [1,10] processes pages 1 through 10. The range must span 10 or fewer pages. If the specified endPage exceeds the document’s total pages, the last available page will be used instead. Both startPage and endPage are inclusive and must be positive integers where startPage ≤ endPage.

Either url or file_store_key should be provided not both.

​
Prompt Example

  • String
{
  prompt: "Describe the image in detail.";
}
  • Array<String>

Use this approach to retrieve specific data from the image file.

{
  prompt: ["first name", "last name"];
}
​
x-api-key
string
required

Your JigsawStack API key

​
Response

​
success
boolean

Indicates whether the call was successful.

Supported file types: - Images: JPEG, JPG, PNG - Documents: Multi-page PDFs (up to 10 pages per API request)

import { JigsawStack } from "jigsawstack";

const jigsawstack = JigsawStack({
apiKey: "your-api-key",
});

const result = await jigsaw.vision.vocr({
prompt: ["Title", "Description"],
url: "https://res.cloudinary.com/dev-ninja/image/upload/v1712567895/webhooks_qaaslj.png",
});


{
"success": true,
"context": {
  "Title": [
    "Webhook Trigger"
  ],
  "Description": [
    "Select events that will trigger the webhook will listen to. At least one event must be selected.",
    "Success logs",
    "Error logs",
    "Endpoint",
    "Create"
  ]
},
"width": 2880,
"height": 1800,
"tags": [
  "text",
  "screenshot",
  "software",
  "multimedia software",
  "graphics software"
],
"has_text": true,
"sections": [
  {
    "text": "",
    "lines": []
  }
]
}

Was this page helpful?

Suggest editsRaise issue