Passer au contenu principal
POST

Autorisations

Authorization
string
header
requis

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

Corps

application/json
url
string<uri>
requis

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

Maximum string length: 2048
country
enum<string>
défaut: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.

Options disponibles:
US,
KR
idempotencyKey
string

Optional. Deduplicates submissions; a duplicate is a 409.

priority
integer
défaut:1

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

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

Optional. Omit to collect the result by polling instead.

Réponse

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

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: 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.