API Documentation

Everything you need to integrate ERPIDE Captcha Solver into your application.

Authentication: All API requests require an API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key from the Dashboard. You also need an active license to use the solve endpoints.

Base URL

https://captcha.erpide.com/api/v1

Solve Endpoints

POST /api/v1/solve

Solve a slider captcha by uploading background and piece images directly.

Request (multipart/form-data)

Parameter	Type	Description
`bg_image` required	file	Background image (PNG/JPG)
`piece_image` required	file	Puzzle piece image (PNG with transparency)
`piece_y`	integer	Y coordinate of the piece (default: 0)
`piece_w`	integer	Piece width in pixels (default: 70)
`piece_h`	integer	Piece height in pixels (default: 70)

Response

JSON Response

{
    "success": true,
    "x": 142,
    "solve_time_ms": 28.3,
    "error": null
}

Example (Python)

python

import requests

response = requests.post(
    "https://captcha.erpide.com/api/v1/solve",
    headers={"Authorization": "Bearer cap_your_api_key_here"},
    files={
        "bg_image": open("background.png", "rb"),
        "piece_image": open("piece.png", "rb"),
    },
    data={"piece_y": 50}
)

result = response.json()
if result["success"]:
    print(f"X = {result['x']}")

Example (Node.js)

javascript

const FormData = require('form-data');
const fs = require('fs');
const axios = require('axios');

const form = new FormData();
form.append('bg_image', fs.createReadStream('background.png'));
form.append('piece_image', fs.createReadStream('piece.png'));
form.append('piece_y', '50');

const response = await axios.post(
    'https://captcha.erpide.com/api/v1/solve',
    form,
    {
        headers: {
            ...form.getHeaders(),
            'Authorization': 'Bearer cap_your_api_key_here'
        }
    }
);

console.log('X =', response.data.x);

POST /api/v1/solve-url

Solve a slider captcha by providing image URLs. The server downloads the images for you.

Request (JSON)

Parameter	Type	Description
`bg_url` required	string	URL of the background image
`piece_url` required	string	URL of the puzzle piece image
`piece_y`	integer	Y coordinate (default: 0)
`piece_w`	integer	Piece width (default: 70)
`piece_h`	integer	Piece height (default: 70)

Example Request

curl -X POST https://captcha.erpide.com/api/v1/solve-url \
  -H "Authorization: Bearer cap_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "bg_url": "https://example.com/captcha/bg.png",
    "piece_url": "https://example.com/captcha/piece.png",
    "piece_y": 50
  }'

License Management

POST /api/v1/license/activate

Activate a license key on your account. You need an active license to use the solve endpoints.

Request

{ "license_key": "LIC-XXXXXXXX-XXXXXXXX-XXXXXXXX" }

GET /api/v1/license/my

List all licenses on your account.

Error Codes

Code	Meaning
`401`	Invalid or missing API key
`403`	No active license
`400`	Bad request (missing images, invalid URL)
`200` + `success: false`	Captcha could not be solved (no charge)

Rate Limits

Rate limits depend on your license plan. Starter: 1000 solves/day. Pro: 10000 solves/day.