taskType selects the engine. You submit every task the same way, and every result comes back in the same result object. Only the response object inside it changes from engine to engine.
What every task shares
GET /v1/async/task/{id} returns the same result object for every engine: success, task (id, status and metadata), credits, and, once the task is finished, response or error. See Async tasks for the lifecycle and Webhooks for push delivery.
Every answer engine puts the answer in response.text and the pages it cited in response.sources, an array of { position, url, label } plus engine-specific fields. Google AI Overviews is the exception: the overview sits under response.aioverview, inside a search results object.
Answer engines
Search and web data
COMMERCE_SERP: site is required: amazon, walmart, target, ebay, aliexpress, google_shopping, sephora or ulta (US), coupang, oliveyoung, 11st, lotteon, musinsa or kurly (KR), rakuten, yahoo_shopping or qoo10 (JP), flipkart, myntra or nykaa (IN), or zalando (DE). query: required, 1-500 characters. country: optional, the site’s country by default. limit: optional integer from 1 to 40, default 20.
COMMERCE_PRODUCT: url is required: a product page on amazon, walmart, target, sephora or ulta (US), 11st, lotteon, musinsa, kurly or oliveyoung (KR), rakuten, yahoo_shopping or qoo10 (JP), flipkart, myntra or nykaa (IN), or zalando (DE), up to 2,048 characters. country: optional, the storefront’s country by default.
Prices are per completed task. Credits and limits explains holds, charges and add-ons.
Which payload field is read
For the engines listed below, validation accepts a task that carries eitherprompt or query, from 1 to 100,000 characters (400 VALIDATION_ERROR otherwise). Each engine reads one field first and falls back to the other, so a request sent with the other key still runs:
CHATGPT,GEMINI,PERPLEXITY,BING_COPILOT,META_AI,QWEN,DOUBAOandBING_SEARCHreadprompt, thenquery.GOOGLE,AIMODE,GOOGLE_SERP,NAVER_AI_BRIEF,NAVER_AI_TAB,NAVER_SERPandREDDITreadquery, thenprompt.
Accepted aliases
These names are accepted at submit and run as the canonical taskType. New code should send the canonical name.
Private engines are rejected with
403 ENGINE_PRIVATE.
The live list
GET /v1/capabilities needs no API key and returns every public taskType with its aliases, endpoint, credits, required and optional input fields, whether it accepts location and include.html, its country policy, and a minimal example payload. It is built from the same code that enforces each rule, so use it to drive engine and country pickers.
Request options
- Markdown and raw responses: which
includeflags each engine honors. - Answer analysis: brands, recommendations, sentiment and source types next to the answer.
- HTML pages: the screen the engine showed, as a shareable page.
- Regions and location: countries, device locations and capacity.
- Citation Analysis: which cited content shaped an answer.