# bapsolver

> API documentation for bapsolver: create reCAPTCHA v3 token jobs and poll them for the token.

- [Introduction](https://docs.bapsolver.xyz/index.md): Get reCAPTCHA v3 tokens for your own site through a simple job API.
- [Quickstart](https://docs.bapsolver.xyz/quickstart.md): Submit a job and read its token in two requests.
- [Authentication](https://docs.bapsolver.xyz/authentication.md): Send your API token as a bearer token on every /v1 request.
- [Jobs](https://docs.bapsolver.xyz/concepts/jobs.md): How a job moves from queued to done, and how to wait for it.
- [Job kinds and proxies](https://docs.bapsolver.xyz/concepts/job-kinds.md): Choose reCAPTCHA v3 or Enterprise, and send a job through your own proxy.
- [Use the token](https://docs.bapsolver.xyz/concepts/using-tokens.md): Send the token with the browser identity that made it, before it expires.
- [Errors](https://docs.bapsolver.xyz/reference/errors.md): Request errors, job errors, and what to do about each.
- [Limits](https://docs.bapsolver.xyz/reference/limits.md): Request size, rate, queue and time limits.
- [API overview](https://docs.bapsolver.xyz/api-reference/introduction.md): Base URL, authentication, request format and response envelope.
- [Create a job](https://docs.bapsolver.xyz/api-reference/jobs/create-a-job.md): Returns at once with `202 Accepted` and the job in the `queued` state. The `Location` header holds the job path. Read the job with Get a job until it is `done` or `failed`.
- [Get a job](https://docs.bapsolver.xyz/api-reference/jobs/get-a-job.md): Returns the job. Once it is done, `result` holds the token; once it has failed, `error` holds the code. Add `wait` to hold the request open until the job finishes.
- [List jobs](https://docs.bapsolver.xyz/api-reference/jobs/list-jobs.md): Returns the jobs the service holds, newest first, without their tokens. Read a token with Get a job.
- [Cancel a job](https://docs.bapsolver.xyz/api-reference/jobs/cancel-a-job.md): A queued job leaves the line and a running one is stopped; both then read as failed with JOB_CANCELLED. A finished job is removed from the server.
- [Check service health](https://docs.bapsolver.xyz/api-reference/service/check-service-health.md): Public and unauthenticated. Returns `ok: true` while the service is up. A healthy service can still fail a job.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.