Skip to main content
POST
Create a job

Authorizations

Authorization
string
header
required

Your API token. Send it on every /v1 request as Authorization: Bearer <API_TOKEN>.

Body

application/json
kind
enum<string>
required

recap_v3: reCAPTCHA v3. recap_v3_enterprise: reCAPTCHA Enterprise. The _proxy kinds run through the proxy sent with the job; the others take none.

Available options:
recap_v3,
recap_v3_enterprise,
recap_v3_proxy,
recap_v3_enterprise_proxy
url
string<uri>
required

The page the challenge is on; the token is for its origin.

Maximum string length: 4096
siteKey
string
required
Required string length: 1 - 256
action
string
default:submit

The reCAPTCHA v3 action.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9/_]+$
proxy
string

Proxy for the _proxy kinds: a pool id or IP:PORT:USER:PASS. Credentials are never echoed back.

Required string length: 3 - 512

Response

The job was queued.

ok
any
required
requestId
string<uuid>
required

Server-generated correlation identifier; caller-supplied identifiers are ignored.

data
object
required