Passer au contenu principal
POST

Autorisations

Authorization
string
header
requis

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

Corps

application/json
taskType
enum<string>
requis

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.

Options disponibles:
CHATGPT,
PERPLEXITY,
GEMINI,
AIMODE,
GOOGLE_AIMODE,
GOOGLE,
GOOGLE_AIO,
GOOGLE_SERP,
GOOGLE_PLACES,
GOOGLE_NEWS,
NAVER_AI_BRIEF,
NAVER_AI_TAB,
NAVER_AI_MODE,
NAVER,
NAVER_SERP,
COMMERCE_SERP,
COMMERCE_PRODUCT,
BING_SEARCH,
BRAVE_SEARCH,
BING,
COPILOT,
BING_COPILOT,
MICROSOFT_COPILOT,
BING_AIMODE,
BING_COPILOT_SEARCH,
COPILOT_SEARCH,
META_AI,
QWEN,
DOUBAO,
BAIDU_WENXIN,
BAIDU_AI_SEARCH,
CITATION_ANALYSIS,
GEO_AUDIT,
SOURCE_INFLUENCE,
CITATION_ATTRIBUTION,
PROMPT_RESEARCH,
GEO_SCORE,
SEARCH,
WEB_SEARCH,
WEB_SCRAPE
Allowed value: "COMMERCE_SERP"
payload
object
requis

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

idempotencyKey
string

Optional. Deduplicates submissions for at least 30 days after the request. Omit for no deduplication. A duplicate is a 409 on this endpoint, but a success on the batch endpoint.

priority
integer
défaut:1

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

Plage requise: 1 <= x <= 10
webhook
object

Optional. Omit to collect the result by polling instead.

Réponse

Task accepted and queued.

success
boolean
requis
task
object
requis
credits
object
requis

Credits, with up to two decimals (for example 1.25). The submit response always shows 0: nothing is charged yet, and the task's price is held from your balance when it starts. 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, GOOGLE_PLACES and GOOGLE_NEWS are charged by usage, up to the hold placed when the task starts.