Skip to main content
POST

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>.

Body

application/json
taskType
enum<string>
required

The engine to query. NAVER is a deprecated alias for NAVER_AI_BRIEF. GOOGLE_AIO and GOOGLE_AIMODE are the unified names for GOOGLE and AIMODE; both spellings are accepted and responses echo the canonical GOOGLE / AIMODE. GOOGLE_SERP returns the Google results page without the AI Overview; payload.page selects pages 1-10. NAVER_SERP returns Naver's web results, 15 per page (payload.page 1-10), and with payload.action page reads one naver.com page by payload.url. REDDIT searches Reddit posts by query (optionally within one subreddit), reads one post with its first page of comments by url, or lists posts with action feed or user_posts. WEB_SCRAPE reads one web page by payload.url and returns its main content as Markdown with its images. WEB_MAP lists a site's addresses from its start page links and sitemaps. WEB_CRAWL reads a site's pages under a start address, each as WEB_SCRAPE reads it, at 1 credit per page returned. KEYWORD_VOLUME returns the monthly search volume of payload.keywords (1-100) in payload.country: Naver for KR and Google for 216 other countries. META_AI returns the meta.ai chat answer with its cited sources and search queries; a prompt Meta refuses completes with an empty text and a notice quoting Meta. QWEN returns the answer of Qwen's China web chat (qianwen.com) with its web search, sources and search queries; payload.country sets the exit and the answer locale. DOUBAO returns the answer of Doubao's China web chat (doubao.com) with its web search, sources and search queries; it always asks from mainland China, whatever payload.country is. BING and BING_COPILOT_SEARCH are accepted as earlier spellings of BING_SEARCH, and COPILOT as the earlier spelling of BING_COPILOT; responses echo the new names. SOURCE_INFLUENCE and PROMPT_RESEARCH tasks are created through their own endpoints (POST /v1/source-influence, POST /v1/prompt-research); they appear here because their tasks report them.

Available options:
CHATGPT,
PERPLEXITY,
GEMINI,
AIMODE,
GOOGLE_AIMODE,
GOOGLE,
GOOGLE_AIO,
GOOGLE_SERP,
NAVER_AI_BRIEF,
NAVER_AI_TAB,
NAVER,
NAVER_SERP,
BING_SEARCH,
BING,
BING_COPILOT,
COPILOT,
META_AI,
QWEN,
DOUBAO,
REDDIT,
WEB_SCRAPE,
WEB_MAP,
WEB_CRAWL,
KEYWORD_VOLUME,
SOURCE_INFLUENCE,
CITATION_ATTRIBUTION,
PROMPT_RESEARCH
payload
object
required

Engine payloads share this envelope. Scraping engines require prompt or query; WEB_SCRAPE, WEB_MAP and WEB_CRAWL require url; KEYWORD_VOLUME requires keywords and country. SOURCE_INFLUENCE has its own endpoint (POST /v1/source-influence, with answer and citations at the top level; CITATION_ATTRIBUTION is its deprecated alias) and is rejected here with 400 USE_DEDICATED_ENDPOINT.

idempotencyKey
string

Optional. Deduplicates submissions. Omit for no deduplication. A duplicate is a 409 on this endpoint, but a success on the batch endpoint.

priority
integer
default:1

Compatibility field; does not guarantee execution order. Values outside 1–10 are clamped, not rejected.

Required range: 1 <= x <= 10
webhook
object

Optional. Omit to collect the result by polling instead.

Response

Task accepted and queued.

success
boolean
required
task
object
required
credits
object
required

Submit and polling envelopes preserve zero values. With billing enabled, account settlement uses the engine pricing policy; webhooks report the persisted charge. SOURCE_INFLUENCE is metered by actual usage.