Generate
Web -> JSON
Generate structured prediction for the given url.
POST
/
v1
/
web
/
generate
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Request to the VLM API (i.e. structured prediction).
id
string
Unique identifier of the request.
created_at
string
Date and time when the request was created (in UTC timezone)
url
string
requiredThe URL of the web page.
model
enum<string>
default: vlm-1The model to use for generating the response.
Available options:
vlm-1
domain
enum<string> | null
The domain identifier.
Available options:
web.ecommerce-product-catalog
, web.github-developer-stats
, web.market-research
mode
enum<string>
default: accurateThe mode to use for the model.
Available options:
fast
, accurate
metadata
object
Optional metadata to pass to the model.
Response
200 - application/json
Base prediction response for all API responses.
id
string
Unique identifier of the response.
created_at
string
Date and time when the request was created (in UTC timezone)
completed_at
string | null
Date and time when the response was completed (in UTC timezone)
response
any | null
The response from the model.
status
string
default: pendingThe status of the job.