Skip to main content
POST

Body

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

Response

boolean
Indicates whether the call was successful.
object
Usage information for the API call.
string
A unique identifier for the request
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).
array
Array of detected GUI elements. Only included if features includes “gui”.
array
Array of detected objects. Only included if features includes “object_detection”.
string[]
Array of automatically generated tags describing the detected objects and content.