Overview
Call it with no parameters for five random letters in a 200×70 GIF, plus the solution, an id and a 24-hour download link. Set type=math for a question like 7 + 4 = ?, and tune length, character set, difficulty, size and format to fit your form. Add audio=true for a spoken version in a clear recorded voice, with optional background noise. Audio and math are free on every plan; paid plans can also set colors. Keep the solution on your server and compare it with what the visitor types, ignoring case.
Live Test Captcha Generator API →
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl "https://api.apiverve.com/v1/captchagenerator?type=math&length=6&charset=alphanumeric&unambiguous=true&difficulty=hard&width=240&height=80&format=png&color=%231d3557&backgroundColor=%23f1faee&audio=true&audioNoise=low&inline=true" \
-H "x-api-key: your_api_key_here"const res = await fetch('https://api.apiverve.com/v1/captchagenerator?type=math&length=6&charset=alphanumeric&unambiguous=true&difficulty=hard&width=240&height=80&format=png&color=%231d3557&backgroundColor=%23f1faee&audio=true&audioNoise=low&inline=true', {
headers: { 'x-api-key': 'your_api_key_here' },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.get(
"https://api.apiverve.com/v1/captchagenerator?type=math&length=6&charset=alphanumeric&unambiguous=true&difficulty=hard&width=240&height=80&format=png&color=%231d3557&backgroundColor=%23f1faee&audio=true&audioNoise=low&inline=true",
headers={"x-api-key": "your_api_key_here"},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/captchagenerator?type=math&length=6&charset=alphanumeric&unambiguous=true&difficulty=hard&width=240&height=80&format=png&color=%231d3557&backgroundColor=%23f1faee&audio=true&audioNoise=low&inline=true", nil)
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
typeOptional | string | text draws random characters; math draws an arithmetic question such as 7 + 4 = ? and the solution is the answer. length, charset and unambiguous apply to text onlytextmathdefault text |
lengthOptional | integer | Number of characters in the captcha (4-8) (text only) default 5 · range 4–8 |
charsetOptional | string | Characters to draw from: lowercase letters, uppercase letters, mixed-case letters, digits, or letters and digits (text only)lowercaseuppercasemixeddigitsalphanumericdefault lowercase |
unambiguousOptional | boolean | Leave out characters that are easy to misread: 0, O, o, 1, l, I, i and Q (text only) |
difficultyOptional | string | Distortion level. Harder levels add more rotation, warp, noise lines, background texture and a line through the text. For type=math it also sets the numbers: small additions and subtractions at easy, larger ones at medium, multiplication at hard. It does not change the audio; see audioNoiseeasymediumharddefault medium |
widthOptional | integer | Image width in pixels (100-400) default 200 · range 100–400 |
heightOptional | integer | Image height in pixels (40-150) default 70 · range 40–150 |
formatOptional | string | Image formatgifpngdefault gif |
colorOptionalPremium | string | Text color as a hex code (e.g. #1d3557). By default each character gets a random dark color |
backgroundColorOptionalPremium | string | Background color as a hex code (e.g. #ffffff) default #ffffff |
audioOptional | boolean | Also return a spoken WAV version of the same challenge in audioURL, for visitors who cannot see the image. Text captchas are read character by character; math questions are read aloud without the answer |
audioNoiseOptional | string | Background noise in the audio, with audio=true: none (clearest, best for accessibility), low, medium or high. Higher levels make automated transcription harder and the audio harder to follownonelowmediumhighdefault none |
inlineOptional | boolean | Return the image as a base64 data URI in dataURI (and the audio in audioDataURI) instead of storing them; downloadURL and audioURL are then null |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"id": "e183c54c-5bf6-455e-bc96-195685cee71c",
"expires": 1766010041360,
"solution": "fwvct",
"downloadURL": "https://storage.googleapis.com/apiverve/APIData/captchagenerator/e183c54c-5bf6-455e-bc96-195685cee71c.gif?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1766010041&Signatu…"
}
}
Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
id | string | "e183c54c-5bf6-455e-bc96-195685cee71c" | Unique identifier for the generated captcha |
expires | number | 1766010041360 | Unix timestamp in milliseconds when the image link expires (24 hours) |
solution | string | "fwvct" | The correct answer: the characters drawn, or for type=math the answer as a string of digits. Compare it with the visitor's answer ignoring case |
downloadURL | string | "https://storage.googleapis.com/apiverve/APIData/captchagenerator/e183c54c-5bf6-455e-bc96-195685cee71…" | Signed URL of the captcha image, valid for 24 hours. Null when inline=true |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Registration Form Protection
- To block automated spam registrations, web apps fetch a challenge image for the signup form and check submitted text against the returned solution.
- Failed Login Throttling
- When visitors trigger multiple failed login attempts, authentication services display a captcha image to verify that a person is behind the keyboard.
- Contact Form Verification
- Community forums attach challenge images to public inquiry forms, using the millisecond expiration timestamp to invalidate stale submissions.
- Password Reset Defense
- Require visitors to solve a visual challenge before sending password reset links to prevent bad actors from triggering bulk recovery emails.
Other ways to use Captcha Generator
Set up Captcha Generator on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Data Generation: