POST
/
v1
/
vocr

​
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.

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)

Was this page helpful?

Run Prompt DirectObject Detention