Screenshots

Locate In Screenshot

Changed on

Find the element a query describes in a screenshot: a point, or an OCR text.

post/api/v1/screenshots:locate

Request

Request body

imagestring required

Base64 encoded image (PNG or JPEG)

modelstring nullable

VLM model to use; must be one of the models from GET /models. Omit to use the server's configured default. The system prompt is fixed to the element-locator task.

querystring required

Natural-language target description

Response

Successful Response

cache_read_tokensinteger

Prompt tokens read from cache

cache_write_tokensinteger

Prompt tokens written to cache

completion_tokensinteger

Completion (output) tokens the model billed for this call

confidencenumber required

Model self-reported confidence

cost_microdollarsinteger required

Provider-reported cost in microdollars

foundboolean required

Whether the VLM located the target

latency_msinteger required

End-to-end VLM call latency

matched_text_indexinteger nullable

Index into the request texts list when the answer is OCR-grounded.

modelstring required

Model identifier returned by the provider

prompt_tokensinteger

Prompt (input) tokens the model billed for this call

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • warning

      the request property's maxLength was set to 2000

    • warning

      the // request property's maxLength was set to 1024