Skip to main content
POST
Locate Element

Authorizations

X-Axilio-Api-Key
string
header
required

Axilio API key (axl_*).

Body

application/json

Argus POST /elements:locate request.

Grounds a natural-language query in a list of UI elements: the model picks one of elements. The screenshot is optional context; the answer is always an element, never a point.

elements
Element · object[]
required

Candidate elements

Required array length: 1 - 2000 elements
query
string
required

Natural-language target description

Required string length: 1 - 2000
image
string | null

Optional base64 screenshot (PNG or JPEG) the element bounds are in

Maximum string length: 16777216
model
string | null

VLM model to use; must be one of the models from GET /models. Omit to use the server's configured default.

Minimum string length: 1

Response

Successful Response

Argus POST /elements:locate response.

element_id is one of the request's element ids when found, else null. It names the element rather than indexing the list, so the answer does not depend on element order. The billing fields match screenshot locate.

confidence
number
required

Model self-reported confidence

Required range: 0 <= x <= 1
cost_microdollars
integer
required

Provider-reported cost in microdollars

Required range: x >= 0
found
boolean
required

Whether the model picked an element

latency_ms
integer
required

End-to-end VLM call latency

Required range: x >= 0
model
string
required

Model identifier returned by the provider

completion_tokens
integer
default:0

Completion (output) tokens the model billed for this call

Required range: x >= 0
element_id
string | null

The chosen element's id; null when not found

prompt_tokens
integer
default:0

Prompt (input) tokens the model billed for this call

Required range: x >= 0