Skip to main content
POST
View a web page or an image and answer a question about it.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Visual question-answering parameters

companyId
string
required

Company ID whose data credits are billed for the call

query
string
required

What to answer about what is seen, e.g. "Describe the visual design and layout" or "What text is in this graphic?"

url
string

Full http(s) URL of a web PAGE to screenshot and view. Provide exactly one of url or imageUrl.

imageUrl
string

Full http(s) URL (or data: URI) of a direct IMAGE file to view. Provide exactly one of url or imageUrl.

fullPage
boolean

For a page url: view the entire scrollable page (default true) or just the visible viewport (false). Ignored for imageUrl.

Response

The vision model's text answer about the page or image

Vision answer about the page or image

answer
string

The vision model's plain-text answer to the query, based only on what is visible

sourceUrl
string

The page or image that was viewed