Agent
Give it a task and it searches, reads pages and fills your fields, with a quote for each.
Authorizations
Headers
A value you choose for one call. Send the same key with the same method, path and body within 24 hours and the first answer comes back with idempotent-replayed: true, with the same cost headers and no second charge. A call that sends zeroDataRetention and answers with page data is not kept, so a retry runs again. Needs an API key.
Query Parameters
Body
Pages to start from, up to 20. An address with * in it, such as https://qdrant.tech/blog/*, is expanded from the site's own page list, up to 10 pages. Without urls the agent searches the web.
1 - 20 elements2048The fields to fill, as a JSON Schema (draft-07 or 2020-12) object with properties. Pydantic's model_json_schema() and zod's toJSONSchema() output work as they are. enum, const, anyOf, oneOf, nullable types, $ref with $defs, required, descriptions and any key names are read. Up to 100 top-level fields and 32 KB. A field the page does not state comes back null.
The most this run may spend, counted in steps of $0.002. Default 2500, which is $5. Every step is checked against what is left before it runs, so the run never goes over. A run that cannot finish inside it fails with stopReason credit_limit_reached and what it found in partial. What it already spent is charged.
Where to be told about the job: a plain address, or { url } which gets a JSON POST when the job starts, for each finished page, and when the job ends. headers are sent with every call, metadata comes back in every call, and events picks which of started, page, action, completed, failed and cancelled to send (all by default). An agent run sends action for each step it takes, and page too. Every call is signed: read Stophy-Signature (t=,v1=), where v1 is the HMAC-SHA256 of "." with your webhook secret from webhook.secret. A call that gets no 2xx is sent again, up to 3 times. Every call has an eventId that stays the same when the call is sent again, so you can skip one you already handled. If your address answers slowly, a page event can carry only the page url. Read that page with the status call.
Response
The data, and what this call cost in dollars.