Web Ask API
Point at a public URL, ask a question about that page, and get a short LLM answer — same credit wallet as social and extract routes.
GET /v1/web/ask1 credit per successful request.
About this endpoint
Agents often already have a URL from search, a CRM field, or a competitor brief. What they need next is a direct answer — pricing on a landing page, whether a docs page covers a feature — not a full markdown dump to parse in a second step.
`GET /v1/web/ask` takes required `url` and `q` query parameters. `url` must be a public http(s) page. `q` is the natural-language question (1–500 characters). The response uses the shared Social Fetch envelope. `data.lookupStatus` is `found` or `restricted`. On `found`, `data.answer` is the generated reply and `data.url` echoes the page that was analyzed. On `restricted` (bot or access protection blocked the fetch), `answer` is null. Bill from `meta.creditsCharged` and keep `meta.requestId` when an answer looks wrong.
This is page Q&A, not marketplace routing. `POST /v1/ask` picks social/API operations from a natural-language prompt. For raw page text, use `GET /v1/web/markdown` or `GET /v1/web/html`. To discover candidate URLs first, use `GET /v1/web/search`.
Web Ask API FAQ
What does the Web Ask API return?
A data object with lookupStatus, url, and answer. lookupStatus is found or restricted. When found, answer is the LLM reply about that page. When restricted, answer is null because the fetch was blocked. The envelope also includes meta.requestId and meta.creditsCharged.
How do I call web ask?
Send GET /v1/web/ask with x-api-key, a required url (public http or https), and a required q question string (1–500 characters). Full parameter rules and examples are in the API docs.
How much does web ask cost?
Pricing is documented on the operation in the API registry (shown on this page). Confirm on every response with meta.creditsCharged — that field is the billing source of truth.
How is GET /v1/web/ask different from POST /v1/ask?
GET /v1/web/ask answers a question about one public page URL using that page's content. POST /v1/ask routes a natural-language prompt to social and marketplace operations (profiles, posts, search, and similar). Use web ask when you already have a URL; use POST /v1/ask when you need a platform lookup.
When should I use markdown instead of ask?
Use GET /v1/web/markdown when you need the page text for RAG, archiving, or your own model. Use GET /v1/web/ask when you want a single answer about that page without shipping the full extract into your pipeline.
What does lookupStatus restricted mean?
The page could not be fetched for automated extraction — often bot or access protection. answer is null in that case. Retry later or use a different public URL; do not treat restricted as a successful Q&A.
Can web ask read pages behind a login?
No. Only publicly reachable pages without your session cookies. Private dashboards and authenticated app screens are out of scope.