Skip to main content
POST

Body

url
string
The image url.
file_store_key
string
The key used to store the image on Jigsawstack file. Learn more about how to handle files in Jigsawstack’s Handling Files section.
prompts
array of strings
Array of prompts for targeted object detection. Each prompt must be between 1-150 characters. Optional and nullable.
features
array of enums
Array of features to enable. Available options: object_detection, gui. Must contain at least one feature.
annotated_image
boolean
default:"false"
Whether to return an annotated image with detected objects highlighted.
return_type
enum
default:"url"
Format for returning images. Available options: url, base64.
return_masks
boolean
default:"false"
Binary segmentation masks for detected objects.
Either file_store_key or url can be provided not both.
x-api-key
string
required
Your JigsawStack API key

Response

success
boolean
Indicates whether the call was successful.
_usage
object
Usage information for the API call.
log_id
string
A unique identifier for the request
annotated_image
string
The annotated image with detected objects highlighted. Only included if annotated_image=true and objects/gui_elements exist. Format depends on return_type parameter (URL or base64).
gui_elements
array
Array of detected GUI elements. Only included if features includes “gui”.
objects
array
Array of detected objects. Only included if features includes “object_detection”.
tags
string[]
Array of automatically generated tags describing the detected objects and content.