Get the balance

GET https://api.noptcha.com/v1/balance

Native API (v1). Guide. Operation ID getBalance.

The organization's balance (needs balance:read).

Request

Authentication: Authorization: Bearer <key> (Keys).

Responses

200

Balance.

Headers: Noptcha-Request-Id.

Content: application/json

Field	Type	Description
available required	string	What new tasks can use: cash + promo + credit limit − held. pattern: ^-?[0-9]+\.[0-9]{6}$
cash required	string	Decimal US dollars with 6 places. pattern: ^-?[0-9]+\.[0-9]{6}$
credit_limit required	string	Decimal US dollars with 6 places. pattern: ^-?[0-9]+\.[0-9]{6}$
currency required	const "USD"
held required	string	Reserved for tasks in flight. pattern: ^-?[0-9]+\.[0-9]{6}$
promo required	string	Promotional credit. pattern: ^-?[0-9]+\.[0-9]{6}$

401

unauthorized: the key is malformed, unknown, revoked or expired.

Headers: Noptcha-Request-Id, RateLimit (optional), RateLimit-Policy (optional).

Content: application/problem+json

Field	Type	Description
code required	string	Machine-readable error code (see the table).
detail optional	string	Human-readable explanation of this occurrence.
request_id required	string	Same as the Noptcha-Request-Id header.
status required	integer	The HTTP status code.
title required	string
type required	string	format: uri

403

forbidden: the key lacks the scope this endpoint needs, the client IP is not in the key's allowlist, the key may not use this task type, or the organization is suspended (detail says which). Also returned, without detail, when the request did not pass through our edge network.

Headers: Noptcha-Request-Id, RateLimit (optional), RateLimit-Policy (optional).

Content: application/problem+json

Field	Type	Description
code required	string	Machine-readable error code (see the table).
detail optional	string	Human-readable explanation of this occurrence.
request_id required	string	Same as the Noptcha-Request-Id header.
status required	integer	The HTTP status code.
title required	string
type required	string	format: uri

413

request_too_large: the body exceeds the limit (1 MB for image types, 64 KB otherwise). Any request with a body over 1 MB gets this, GET requests included.

Headers: Noptcha-Request-Id, RateLimit (optional), RateLimit-Policy (optional).

Content: application/problem+json

Field	Type	Description
code required	string	Machine-readable error code (see the table).
detail optional	string	Human-readable explanation of this occurrence.
request_id required	string	Same as the Noptcha-Request-Id header.
status required	integer	The HTTP status code.
title required	string
type required	string	format: uri

429

rate_limited: too many tasks created per second by this key, the same task polled too often, the sandbox's per-organization rate, usage queried too often, the catalog fetched too often from this IP, or this IP sent too many invalid keys. concurrency_limited: the organization has too many tasks in flight for this captcha family (or, with a test key, too many sandbox tasks still processing). Wait Retry-After seconds.

Headers: Noptcha-Request-Id, RateLimit (optional), RateLimit-Policy (optional), Retry-After.

Content: application/problem+json

Field	Type	Description
code required	string	Machine-readable error code (see the table).
detail optional	string	Human-readable explanation of this occurrence.
request_id required	string	Same as the Noptcha-Request-Id header.
status required	integer	The HTTP status code.
title required	string
type required	string	format: uri

500

internal: an error on our side.

Headers: Noptcha-Request-Id, RateLimit (optional), RateLimit-Policy (optional).

Content: application/problem+json

Field	Type	Description
code required	string	Machine-readable error code (see the table).
detail optional	string	Human-readable explanation of this occurrence.
request_id required	string	Same as the Noptcha-Request-Id header.
status required	integer	The HTTP status code.
title required	string
type required	string	format: uri

503

service_unavailable: no capacity right now (all solvers busy or failing, the gateway is overloaded, a dependency is unavailable). For POST /v1/tasks nothing was created or charged. Wait Retry-After.

Headers: Noptcha-Request-Id, RateLimit (optional), RateLimit-Policy (optional), Retry-After.

Content: application/problem+json

Field	Type	Description
code required	string	Machine-readable error code (see the table).
detail optional	string	Human-readable explanation of this occurrence.
request_id required	string	Same as the Noptcha-Request-Id header.
status required	integer	The HTTP status code.
title required	string
type required	string	format: uri

Header descriptions and every schema: Schemas. Machine-readable: openapi.json, openapi.yaml.