跳转到主要内容
POST

授权

Authorization
string
header
必填

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

请求体

application/json
url
string<uri>
必填

The page to score: an http or https URL on a public host, on the default port.

Maximum string length: 2048
country
enum<string>
默认值:US

Where the person reading the page is. The page is rendered from an address in that country, in its language and time zone. Any other value is a 422 REGION_UNSUPPORTED.

可用选项:
US,
KR
idempotencyKey
string

Optional. Deduplicates submissions; a duplicate is a 409.

priority
integer
默认值:1

Optional. Echoed in task metadata; values outside 1-10 are clamped. It does not guarantee execution order.

必填范围: 1 <= x <= 10
webhook
object

Optional. Omit to collect the result by polling instead.

响应

Queued; poll /v1/async/task/{id}. Its response follows GeoScoreResult.

success
boolean
必填
task
object
必填
credits
object
必填

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.