NopeCHA

Retrieve API key status

GET

https://api.nopecha.com/v1/status

Fetch information about remaining credit balance, seconds left until next reset, and subscription information. If no API key is provided in the query, the status of the default API key (the user's IP address) will be returned.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

Returns

200

API key status retrieved successfully.

Response body

object

API key status information.

Example request

Shell

123curl https://api.nopecha.com/v1/status \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

123456import requests

url = "https://api.nopecha.com/v1/status"
params = { "key": "YOUR_API_KEY" }
response = requests.get(url, params=params)
print(response.json())

123fetch("https://api.nopecha.com/v1/status?key=YOUR_API")
  .then(response => response.json())
  .then(console.log)

Response

123456789101112{
  "plan": "Enterprise",
  "status": "Active",
  "credit": 200000,
  "quota": 200000,
  "duration": 86400,
  "lastreset": 1719842747,
  "ttl": 744,
  "subscribed": 1,
  "current_period_start": 1,
  "current_period_end": 1
}

Retrieve API key events

GET

https://api.nopecha.com/v1/timelines

Retrieve API key events for jobs submitted by the API key, including the job submission time, job completion time, and job collection time.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

n

integer

Optional

Defaults to 100

The maximum number of events to retrieve.

Returns

200

API key timelines data retrieved successfully.

Response body

object

Latest jobs and events information for an API key.

Example request

Shell

123curl https://api.nopecha.com/v1/timelines?n=10 \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

123456789import requests

url = "https://api.nopecha.com/v1/timelines"
params = {
  "key": "YOUR_API_KEY",
  "n": 10
}
response = requests.get(url, params=params)
print(response.json())

123fetch("https://api.nopecha.com/v1/timelines?key=YOUR_API&n=10")
  .then(response => response.json())
  .then(console.log)

Response

1234567891011121314151617181920212223242526272829{
  "5l79r9zhslbnei67ymmvz8f1pxt7q25nausyr87jamy68721agaoxc26dryhxj3w": {
    "job": {
      "key": "YOUR_API_KEY",
      "type": "hcaptcha",
      "ip": "1.1.1.1",
      "task": "Please click on all entities similar to the following pattern.",
      "sitekey": "93b08d40-d46c-400a-ba07-6f91cda815b9"
    },
    "timelines": [
      {
        "event": "collected",
        "time": 1719886572.084
      },
      {
        "event": "solved",
        "time": 1719886571.186
      },
      {
        "event": "worked",
        "time": 1719886569.28
      },
      {
        "event": "posted",
        "time": 1719886569.243
      }
    ]
  }
}

Retrieve system metrics

GET

https://api.nopecha.com/v1/metrics

Retrieve system metrics data, including the number of total users, the number of online users, and the average inference time.

Returns

200

API key metrics data retrieved successfully.

Response body

object

API key metrics information.

Example request

Shell

12curl https://api.nopecha.com/v1/metrics \
  -H "Content-Type: application/json"

123456import requests

url = "https://api.nopecha.com/v1/metrics"
params = { "key": "YOUR_API_KEY" }
response = requests.get(url, params=params)
print(response.json())

123fetch("https://api.nopecha.com/v1/metrics?key=YOUR_API")
  .then(response => response.json())
  .then(console.log)

Response

12345{
  "nusers": 4048943,
  "nonline": 140087,
  "captcha.recog.solveduration": 1.016
}

Submit AWS CAPTCHA

POST

https://api.nopecha.com/v1/recognition/awscaptcha

Submit AWS WAF CAPTCHA recognition jobs to the AI inference engine.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

AWS WAF CAPTCHA recognition job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

1234curl https://api.nopecha.com/v1/recognition/awscaptcha \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d '{"audio_data": ["data:audio/aac;base64,..."]}'

1234567import requests

url = "https://api.nopecha.com/v1/recognition/awscaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = { "audio_data": ["data:audio/aac;base64,..."] }
response = requests.post(url, headers=headers, json=data)
print(response.json())

12345678910fetch("https://api.nopecha.com/v1/recognition/awscaptcha", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({ audio_data: ["data:audio/aac;base64,..."] })
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "2xuttwekei7birwsfhh3lr97oqovzm0r9u23yz03uhr2u560l2rocrmanb7etf9k"
}

Retrieve AWS CAPTCHA

GET

https://api.nopecha.com/v1/recognition/awscaptcha

Retrieve the results of submitted AWS WAF CAPTCHA recognition jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Speech-to-text inference result of a multimodal model.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/recognition/awscaptcha?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/recognition/awscaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/recognition/awscaptcha?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": ["conundrum"]
}

Submit FunCAPTCHA Tile

POST

https://api.nopecha.com/v1/recognition/funcaptcha

Submit FunCAPTCHA Tile recognition jobs to the AI inference engine.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

FunCAPTCHA Tile recognition job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

123456789curl https://api.nopecha.com/v1/recognition/funcaptcha \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d @- << EOF
{
  "task": "Pick the dice pair whose top sides add up to 14",
  "image_data": ["data:image/jpeg;base64,..."]
}
EOF

12345678910import requests

url = "https://api.nopecha.com/v1/recognition/funcaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = {
  "task": "Pick the dice pair whose top sides add up to 14",
  "image_data": ["data:image/jpeg;base64,..."]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())

12345678910111213fetch("https://api.nopecha.com/v1/recognition/funcaptcha", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({
    task: "Pick the dice pair whose top sides add up to 14",
    image_data: ["data:image/jpeg;base64,..."]
  })
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "2xuttwekei7birwsfhh3lr97oqovzm0r9u23yz03uhr2u560l2rocrmanb7etf9k"
}

Retrieve FunCAPTCHA Tile

GET

https://api.nopecha.com/v1/recognition/funcaptcha

Retrieve the results of submitted FunCAPTCHA Tile recognition jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Image recognition inference result of a multimodal model.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/recognition/funcaptcha?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/recognition/funcaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/recognition/funcaptcha?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": [false, false, true, false, false, false]
}

Submit FunCAPTCHA Match

POST

https://api.nopecha.com/v1/recognition/funcaptcha_match

Submit FunCAPTCHA Match recognition jobs to the AI inference engine.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

FunCAPTCHA Match recognition job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

123456789curl https://api.nopecha.com/v1/recognition/funcaptcha_match \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d @- << EOF
{
  "task": "Find the tile that matches the sample image",
  "image_data": ["data:image/png;base64,..."]
}
EOF

12345678910import requests

url = "https://api.nopecha.com/v1/recognition/funcaptcha_match"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = {
  "task": "Find the tile that matches the sample image",
  "image_data": ["data:image/png;base64,..."]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())

12345678910111213fetch("https://api.nopecha.com/v1/recognition/funcaptcha_match", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({
    task: "Find the tile that matches the sample image",
    image_data: ["data:image/png;base64,..."]
  })
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "2xuttwekei7birwsfhh3lr97oqovzm0r9u23yz03uhr2u560l2rocrmanb7etf9k"
}

Retrieve FunCAPTCHA Match

GET

https://api.nopecha.com/v1/recognition/funcaptcha_match

Retrieve the results of submitted FunCAPTCHA Match recognition jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Image recognition inference result of a multimodal model.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/recognition/funcaptcha_match?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/recognition/funcaptcha_match"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/recognition/funcaptcha_match?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": [false, true, false, false, false, false, false, false, false]
}

Submit GeeTest

POST

https://api.nopecha.com/v1/recognition/geetest

Submit GeeTest recognition jobs to the AI inference engine.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

GeeTest recognition job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

123456789curl https://api.nopecha.com/v1/recognition/geetest \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d @- << EOF
{
  "task": "Drag the slider to complete the puzzle",
  "image_data": ["data:image/png;base64,..."]
}
EOF

12345678910import requests

url = "https://api.nopecha.com/v1/recognition/geetest"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = {
  "task": "Drag the slider to complete the puzzle",
  "image_data": ["data:image/png;base64,..."]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())

12345678910111213fetch("https://api.nopecha.com/v1/recognition/geetest", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({
    task: "Drag the slider to complete the puzzle",
    image_data: ["data:image/png;base64,..."]
  })
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "2xuttwekei7birwsfhh3lr97oqovzm0r9u23yz03uhr2u560l2rocrmanb7etf9k"
}

Retrieve GeeTest

GET

https://api.nopecha.com/v1/recognition/geetest

Retrieve the results of submitted GeeTest recognition jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Image recognition inference result of a multimodal model.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/recognition/geetest?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/recognition/geetest"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/recognition/geetest?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

12345{
  "data": {
    "x": 58
  }
}

Submit hCaptcha

POST

https://api.nopecha.com/v1/recognition/hcaptcha

Submit hCaptcha recognition jobs to the AI inference engine.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

hCaptcha recognition job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

123456789101112131415161718192021222324252627curl https://api.nopecha.com/v1/recognition/hcaptcha \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d @- << EOF
{
  "data": {
    "request_type": "image_drag_drop",
    "requester_question": {
      "en": "Drag the object on the right to the pattern that matches it"
    },
    "tasklist": [
      {
        "datapoint_uri": "data:image/jpeg;base64,...",
        "task_key": "eabd4355-89ce-44bd-87e1-10ed1506b343",
        "entities": [
          {
            "entity_id": "d37bb4a2-5416-4413-8aeb-92e44a80a92b",
            "entity_uri": "data:image/png;base64,...",
            "coords": [412,82],
            "size": [85,85]
          }
        ]
      }
    ]
  }
}
EOF

12345678910111213141516171819202122232425262728import requests

url = "https://api.nopecha.com/v1/recognition/hcaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = {
  "data": {
    "request_type": "image_drag_drop",
    "requester_question": {
      "en": "Drag the object on the right to the pattern that matches it"
    },
    "tasklist": [
      {
        "datapoint_uri": "data:image/jpeg;base64,...",
        "task_key": "eabd4355-89ce-44bd-87e1-10ed1506b343",
        "entities": [
          {
            "entity_id": "d37bb4a2-5416-4413-8aeb-92e44a80a92b",
            "entity_uri": "data:image/png;base64,...",
            "coords": [412,82],
            "size": [85,85]
          }
        ]
      }
    ]
  }
}
response = requests.post(url, headers=headers)
print(response.json())

123456789101112131415161718192021222324252627282930fetch("https://api.nopecha.com/v1/recognition/hcaptcha", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({
  "data": {
    "request_type": "image_drag_drop",
    "requester_question": {
      "en": "Drag the object on the right to the pattern that matches it"
    },
    "tasklist": [
      {
        "datapoint_uri": "data:image/jpeg;base64,...",
        "task_key": "eabd4355-89ce-44bd-87e1-10ed1506b343",
        "entities": [
          {
            "entity_id": "d37bb4a2-5416-4413-8aeb-92e44a80a92b",
            "entity_uri": "data:image/png;base64,...",
            "coords": [412,82],
            "size": [85,85]
          }
        ]
      }
    ]
  }
})
  .then(response => response.json())
  .then(console.log);

Response

123{
  "data": "2xuttwekei7birwsfhh3lr97oqovzm0r9u23yz03uhr2u560l2rocrmanb7etf9k"
}

Retrieve hCaptcha

GET

https://api.nopecha.com/v1/recognition/hcaptcha

Retrieve the results of submitted hCaptcha recognition jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Image recognition inference result of a multimodal model.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/recognition/hcaptcha?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/recognition/hcaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/recognition/hcaptcha?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

12345678910111213{
  "data": [
    [
      {
        "entity_id": "d37bb4a2-5416-4413-8aeb-92e44a80a92b",
        "x": 45,
        "y": 27.89,
        "w": 17.71,
        "h": 26.56
      }
    ]
  ]
}

Submit Lemin CAPTCHA

POST

https://api.nopecha.com/v1/recognition/lemincaptcha

Submit Lemin CAPTCHA recognition jobs to the AI inference engine.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

Lemin CAPTCHA recognition job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

123456789curl https://api.nopecha.com/v1/recognition/lemincaptcha \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d @- << EOF
{
  "task": "Drag the badge onto the matching silhouette",
  "image_data": ["data:image/png;base64,..."]
}
EOF

12345678910import requests

url = "https://api.nopecha.com/v1/recognition/lemincaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = {
  "task": "Drag the badge onto the matching silhouette",
  "image_data": ["data:image/png;base64,..."]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())

12345678910111213fetch("https://api.nopecha.com/v1/recognition/lemincaptcha", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({
    task: "Drag the badge onto the matching silhouette",
    image_data: ["data:image/png;base64,..."]
  })
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "2xuttwekei7birwsfhh3lr97oqovzm0r9u23yz03uhr2u560l2rocrmanb7etf9k"
}

Retrieve Lemin CAPTCHA

GET

https://api.nopecha.com/v1/recognition/lemincaptcha

Retrieve the results of submitted Lemin CAPTCHA recognition jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Image recognition inference result of a multimodal model.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/recognition/lemincaptcha?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/recognition/lemincaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/recognition/lemincaptcha?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

123456{
  "data": {
    "x": 72.5,
    "y": 34.1
  }
}

Submit reCAPTCHA

POST

https://api.nopecha.com/v1/recognition/recaptcha

Submit reCAPTCHA recognition jobs to the AI inference engine.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

reCAPTCHA recognition job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

12345678910curl https://api.nopecha.com/v1/recognition/recaptcha \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d @- << EOF
{
  "task": "Select all images with traffic lights",
  "grid": "3x3",
  "image_data": ["data:image/jpeg;base64,..."]
}
EOF

1234567891011import requests

url = "https://api.nopecha.com/v1/recognition/recaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = {
  "task": "Select all images with traffic lights",
  "grid": "3x3",
  "image_data": ["data:image/jpeg;base64,..."]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())

1234567891011121314fetch("https://api.nopecha.com/v1/recognition/recaptcha", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({
    task: "Select all images with traffic lights",
    grid: "3x3",
    image_data: ["data:image/jpeg;base64,..."]
  })
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "2xuttwekei7birwsfhh3lr97oqovzm0r9u23yz03uhr2u560l2rocrmanb7etf9k"
}

Retrieve reCAPTCHA

GET

https://api.nopecha.com/v1/recognition/recaptcha

Retrieve the results of submitted reCAPTCHA recognition jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Image recognition inference result of a multimodal model.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/recognition/recaptcha?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/recognition/recaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/recognition/recaptcha?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": [true, false, true, false, true, false, false, false, true]
}

Submit Text CAPTCHA

POST

https://api.nopecha.com/v1/recognition/textcaptcha

Submit Text CAPTCHA recognition jobs to the AI inference engine.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

Text CAPTCHA recognition job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

12345678curl https://api.nopecha.com/v1/recognition/textcaptcha \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d @- << EOF
{
  "image_data": ["data:image/png;base64,..."]
}
EOF

123456789import requests

url = "https://api.nopecha.com/v1/recognition/textcaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = {
  "image_data": ["data:image/png;base64,..."]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())

123456789101112fetch("https://api.nopecha.com/v1/recognition/textcaptcha", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({
    image_data: ["data:image/png;base64,..."]
  })
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "2xuttwekei7birwsfhh3lr97oqovzm0r9u23yz03uhr2u560l2rocrmanb7etf9k"
}

Retrieve Text CAPTCHA

GET

https://api.nopecha.com/v1/recognition/textcaptcha

Retrieve the results of submitted Text CAPTCHA recognition jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Image-to-text inference result of a multimodal model.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/recognition/textcaptcha?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/recognition/textcaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/recognition/textcaptcha?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": ["STATION"]
}

Submit hCaptcha

POST

https://api.nopecha.com/v1/token/hcaptcha

Submit hCaptcha token jobs to token generators.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

hCaptcha token job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

123456789101112curl https://api.nopecha.com/v1/token/hcaptcha \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d @- << EOF
{
  "sitekey": "58366d97-3e8c-4b57-a679-4a41c8423be3",
  "url": "https://nopecha.com/captcha/hcaptcha",
  "data": {
    "rqdata": "rq_1vwJRRRVSkhKVE1DQ29CRU1qdldDRFB6enE2..."
  }
}
EOF

12345678910111213import requests

url = "https://api.nopecha.com/v1/token/hcaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = {
  "sitekey": "58366d97-3e8c-4b57-a679-4a41c8423be3",
  "url": "https://nopecha.com/captcha/hcaptcha",
  "data": {
    "rqdata": "rq_1vwJRRRVSkhKVE1DQ29CRU1qdldDRFB6enE2..."
  }
}
response = requests.post(url, headers=headers, json=data)
print(response.json())

12345678910111213141516fetch("https://api.nopecha.com/v1/token/hcaptcha", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({
    sitekey: "58366d97-3e8c-4b57-a679-4a41c8423be3",
    url: "https://nopecha.com/captcha/hcaptcha",
    data: {
      rqdata: "rq_1vwJRRRVSkhKVE1DQ29CRU1qdldDRFB6enE2..."
    }
  })
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "2xuttwekei7birwsfhh3lr97oqovzm0r9u23yz03uhr2u560l2rocrmanb7etf9k"
}

Retrieve hCaptcha

GET

https://api.nopecha.com/v1/token/hcaptcha

Retrieve the results of submitted hCaptcha token jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Token job results retrieved successfully.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/token/hcaptcha?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/token/hcaptcha"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/token/hcaptcha?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "P0_eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}

Submit reCAPTCHA v2

POST

https://api.nopecha.com/v1/token/recaptcha2

Submit reCAPTCHA v2 token jobs to token generators.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

reCAPTCHA v2 token job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

1234567891011121314curl https://api.nopecha.com/v1/token/recaptcha2 \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d @- << EOF
{
  "sitekey": "6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI",
  "url": "https://example.com/login",
  "data": {
    "theme": "dark",
    "s": "DATA_S_VALUE"
  },
  "enterprise": false
}
EOF

123456789101112131415import requests

url = "https://api.nopecha.com/v1/token/recaptcha2"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = {
  "sitekey": "6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI",
  "url": "https://example.com/login",
  "data": {
    "theme": "dark",
    "s": "DATA_S_VALUE"
  },
  "enterprise": False
}
response = requests.post(url, headers=headers, json=data)
print(response.json())

123456789101112131415161718fetch("https://api.nopecha.com/v1/token/recaptcha2", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({
    sitekey: "6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI",
    url: "https://example.com/login",
    data: {
      theme: "dark",
      s: "DATA_S_VALUE"
    },
    enterprise: false
  })
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "3bxl7gjj59u40ewhye8oyw8lxmlok4lk"
}

Retrieve reCAPTCHA v2

GET

https://api.nopecha.com/v1/token/recaptcha2

Retrieve the results of submitted reCAPTCHA v2 token jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Token job results retrieved successfully.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/token/recaptcha2?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/token/recaptcha2"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/token/recaptcha2?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "03AFcWeA5wNq2g9M6YIB-uK3seGQ19izQvQnOe_l-sample"
}

Submit reCAPTCHA v3

POST

https://api.nopecha.com/v1/token/recaptcha3

Submit reCAPTCHA v3 token jobs to token generators.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

reCAPTCHA v3 token job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

123456789101112131415curl https://api.nopecha.com/v1/token/recaptcha3 \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d @- << EOF
{
  "sitekey": "6Lc_aX0UAAAAAB1c2DEFghiJKLmNoPQRStuVwxYz",
  "url": "https://example.com/login",
  "data": {
    "action": "login",
    "theme": "light",
    "s": "DATA_S_VALUE"
  },
  "enterprise": true
}
EOF

12345678910111213141516import requests

url = "https://api.nopecha.com/v1/token/recaptcha3"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = {
  "sitekey": "6Lc_aX0UAAAAAB1c2DEFghiJKLmNoPQRStuVwxYz",
  "url": "https://example.com/login",
  "data": {
    "action": "login",
    "theme": "light",
    "s": "DATA_S_VALUE"
  },
  "enterprise": True
}
response = requests.post(url, headers=headers, json=data)
print(response.json())

12345678910111213141516171819fetch("https://api.nopecha.com/v1/token/recaptcha3", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({
    sitekey: "6Lc_aX0UAAAAAB1c2DEFghiJKLmNoPQRStuVwxYz",
    url: "https://example.com/login",
    data: {
      action: "login",
      theme: "light",
      s: "DATA_S_VALUE"
    },
    enterprise: true
  })
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "2xuttwekei7birwsfhh3lr97oqovzm0r9u23yz03uhr2u560l2rocrmanb7etf9k"
}

Retrieve reCAPTCHA v3

GET

https://api.nopecha.com/v1/token/recaptcha3

Retrieve the results of submitted reCAPTCHA v3 token jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Token job results retrieved successfully.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/token/recaptcha3?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/token/recaptcha3"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/token/recaptcha3?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "1.ABCDEFGHIJKLMNOPQRSTUVWX_sample_token"
}

Submit Cloudflare Turnstile

POST

https://api.nopecha.com/v1/token/turnstile

Submit Cloudflare Turnstile token jobs to token generators.

Request headers

Authorization

string

Optional

User API key.

Request body

object

Required

Cloudflare Turnstile token job data.

Returns

200

Job submitted successfully. Use the job ID from this response to retrieve the results.

Response body

object

Example request

Shell

12345678910111213curl https://api.nopecha.com/v1/token/turnstile \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY" \
  -d @- << EOF
{
  "sitekey": "0x4AAAAAAABBBBCCCCDDDDEEEEFFFGGGHH",
  "url": "https://example.com/login",
  "data": {
    "action": "login",
    "cdata": "customer-metadata"
  }
}
EOF

1234567891011121314import requests

url = "https://api.nopecha.com/v1/token/turnstile"
headers = { "Authorization": "Basic YOUR_API_KEY" }
data = {
  "sitekey": "0x4AAAAAAABBBBCCCCDDDDEEEEFFFGGGHH",
  "url": "https://example.com/login",
  "data": {
    "action": "login",
    "cdata": "customer-metadata"
  }
}
response = requests.post(url, headers=headers, json=data)
print(response.json())

1234567891011121314151617fetch("https://api.nopecha.com/v1/token/turnstile", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_KEY"
  },
  body: JSON.stringify({
    sitekey: "0x4AAAAAAABBBBCCCCDDDDEEEEFFFGGGHH",
    url: "https://example.com/login",
    data: {
      action: "login",
      cdata: "customer-metadata"
    }
  })
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "2xuttwekei7birwsfhh3lr97oqovzm0r9u23yz03uhr2u560l2rocrmanb7etf9k"
}

Retrieve Cloudflare Turnstile

GET

https://api.nopecha.com/v1/token/turnstile

Retrieve the results of submitted Cloudflare Turnstile token jobs.

Request headers

Authorization

string

Optional

User API key.

Query parameters

key

string

Optional

User API key.

id

string

Required

A unique job ID of the submitted job.

Returns

200

Token job results retrieved successfully.

Response body

object

Example request

Shell

123curl https://api.nopecha.com/v1/token/turnstile?id=JOB_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $YOUR_API_KEY"

1234567import requests

url = "https://api.nopecha.com/v1/token/turnstile"
headers = { "Authorization": "Basic YOUR_API_KEY" }
params = { "id": "JOB_ID" }
response = requests.get(url, headers=headers, params=params)
print(response.json())

12345fetch("https://api.nopecha.com/v1/token/turnstile?id=JOB_ID", {
  headers: { "Authorization": "Basic YOUR_API_KEY" }
})
  .then(response => response.json())
  .then(console.log)

Response

123{
  "data": "0.zLH9XGqT34J7GO1PEPKgHeYwO38CvXgGVZ6tVfl9eyZg5GvV7mTZGbBl"
}

Invalid Request

HTTP 400

App code 10

Request is invalid. Check the request body and query parameters for errors. If the type field is present in this error response, it will describe the nature of the error.

Error body

Response body

object

Update Required

HTTP 400

App code 17

The client must update to the latest version to continue using the service. This can be due to a breaking change or a security update. Although this error has never been used, it is reserved for future use.

Error body

Response body

object

Invalid API Key

HTTP 401

App code 15

The provided API key is invalid. If you believe this is an error, please contact support.

Error body

Response body

object

Unavailable Feature

HTTP 402

App code 18

The feature is unavailable for the current plan. An upgraded plan is required to use this feature.

Error body

Response body

object

Out of Credit

HTTP 403

App code 16

The API key has run out of credit. If you believe this is an error, please contact support.

Error body

Response body

object

Free Tier Ineligible

HTTP 403

App code 12

IP address is ineligible to use the Free plan. Switch to a trusted IP to use the Free plan or subscribe to a paid plan to continue using the service on this IP address.

Error body

Response body

object

Incomplete Job

HTTP 409

App code 14

Job is incomplete. Recommended wait time before retrying the request is 500ms.

Error body

Response body

object

Rate Limited

HTTP 429

App code 11

Rate limit for this endpoint has been reached for the API key. Slow down the request rate to avoid this error.

Error body

Response body

object

Internal Server Error

HTTP 500

App code 9

An unknown error occurred. Check the request and try again. If the error persists, please contact support.

Error body

Response body

object