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

Public task types accepted by POST /v1/async/task and its batch endpoints. Dedicated analysis endpoints and AI Rendering publication create readable tasks through their own routes.

Available options:
CHATGPT,
PERPLEXITY,
GEMINI,
AIMODE,
GOOGLE_AIMODE,
GOOGLE,
GOOGLE_AIO,
GOOGLE_SERP,
NAVER_AI_BRIEF,
NAVER_AI_TAB,
NAVER_AI_MODE,
NAVER,
NAVER_SERP,
COMMERCE_SERP,
COMMERCE_PRODUCT,
BING_SEARCH,
BING,
BING_COPILOT_SEARCH,
BING_COPILOT,
COPILOT,
META_AI,
QWEN,
DOUBAO,
REDDIT,
WEB_SCRAPE,
WEB_MAP,
WEB_CRAWL,
KEYWORD_VOLUME,
CITATION_ANALYSIS,
GEO_AUDIT,
SOURCE_INFLUENCE,
CITATION_ATTRIBUTION,
PROMPT_RESEARCH,
GEO_SCORE
Allowed value: "COMMERCE_SERP"
​
payload
object
required

The payload for the selected taskType; see TaskInput for the engine-specific schema.

​
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

Credits, with up to two decimals (for example 1.25). The submit response always shows 0: a hold is placed on your balance, but nothing is charged yet. Polling shows 0 until the task is terminal, then the settled charge: the task's price for COMPLETED, 0 for FAILED. A task webhook reports the same charge in creditsCharged; on a FAILED task it reports the task's price in creditsToCharge and 0 in creditsCharged. CITATION_ANALYSIS and WEB_CRAWL are charged by usage, up to the hold placed at submit.