Skip to content

API overview

The reference is generated from the OpenAPI document of the protocol package (version 1.0.0-draft), so it matches the code.

Base URL: https://api.revokegpt.com

Authentication. Site-secret endpoints take the site secret key as Authorization: Bearer rgsk_... (siteverify also accepts it as the secret body field, never both). The challenge and solve endpoints, used by the widget and mobile SDKs, take the public site key and no secret.

Operation Method and path Summary
createChallenge POST /v1/challenge Request a challenge
solveChallenge POST /v1/solve Submit a challenge solution
answerPuzzle POST /v1/puzzle/answer Answer a puzzle
siteverify POST /v1/siteverify Verify a response token
createAssessment POST /v1/assessments Create an assessment (token or express)
annotateAssessment POST /v1/assessments/{id}:annotate Annotate an assessment
checkPassword POST /v1/password-check Check a password against the leaked-password ranges
eraseAccount POST /v1/accounts:erase Erase the stored profile of an account
sendMfaCode POST /v1/mfa/send Send the one-time code
verifyMfaCode POST /v1/mfa/verify Verify the one-time code
getPolicyBundle GET /v1/policies/{siteKey} Fetch the signed firewall policy bundle of a site
getRgKeys GET /.well-known/rg-keys.json Public signing keys
createSession POST /v1/session Exchange a response token for a session or clearance token
siteverifyCompat POST /recaptcha/api/siteverify Verify a response token (drop-in compatible path)

See operations, schemas and error codes.