メインコンテンツへスキップ
POST

承認

Authorization
string
header
必須

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

ヘッダー

Prefer
string

wait=<seconds> holds the request at most that long, up to 290. wait=0 answers with the task id at once.

例:

"wait=120"

Accept
enum<string>
デフォルト:application/json

text/html answers with the task's saved page and needs payload.include.html: true. Any other value answers with JSON.

利用可能なオプション:
application/json,
text/html

ボディ

application/json
taskType
enum<string>
必須

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.

利用可能なオプション:
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
必須

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
デフォルト:1

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

必須範囲: 1 <= x <= 10
webhook
object

Optional. Omit to collect the result by polling instead.

レスポンス

The task ended: the body GET /v1/async/task/{id} returns, with response or error. With Accept: text/html, the saved page of the completed task.

success
boolean
必須
task
object
必須
credits
object
必須

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.

response
object

The engine-specific result. Absent until the task is terminal. See the Engines guide for per-engine shapes. NAVER_AI_TAB preserves the original text, markdown, sources and cards when Naver returns HTTP success, a valid stream ending in done, and nonempty answer text with unknown_error. It includes upstreamError and returns immediately without retrying or rephrasing, even with retryQuery. COMPLETED means collection finished; the answer may still be incomplete. Empty, cut-off or malformed streams still fail. Policy refusals complete with a policy_declined notice. rawContent is returned only with include.rawResponse. With include.citationAnalysis, answer results also carry citationAnalysis (see Include). CITATION_ANALYSIS returns CitationAnalysisResult; see the Citation Analysis guide. PROMPT_RESEARCH returns PromptResearchResult; see the Prompt Research guide. GEO_SCORE returns GeoScoreResult; see the GEO Score guide. Answer engines with include.analysis add analysis (AnswerAnalysis).

error
string

Present when task.status is FAILED. A plain string, not the {code, message, timestamp} object used by request-level errors.