Background Jobs

Authenticate every request with Authorization: Bearer clr_live_YOUR_API_KEY.

Queue a scrape

POST /scrape Queue a scrape through the Claro Public API. Required scope: generate

Request body

Content type: application/json (required)

Request example

{
  "urls": [
    "https://example.com/products"
  ],
  "prompt": "Extract product names and prices"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/scrape" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "urls": [
    "https://example.com/products"
  ],
  "prompt": "Extract product names and prices"
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/scrape"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "urls": [
    "https://example.com/products"
  ],
  "prompt": "Extract product names and prices"
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/scrape`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "urls": [
      "https://example.com/products"
    ],
    "prompt": "Extract product names and prices"
  }),
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get job by ID

GET /jobs Get job by ID through the Claro Public API. Required scope: generate

Parameters

Name	Location	Type	Required
`id`	query	string	Yes

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/jobs?id=YOUR_ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/jobs?id=YOUR_ID"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/jobs?id=YOUR_ID`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get jobs by reference

GET /jobs/by-reference Get jobs by reference through the Claro Public API. Required scope: generate

Parameters

Name	Location	Type	Required
`referenceType`	query	string	Yes
`referenceId`	query	string	Yes

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/jobs/by-reference?referenceType=YOUR_REFERENCE_TYPE&referenceId=YOUR_REFERENCE_ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/jobs/by-reference?referenceType=YOUR_REFERENCE_TYPE&referenceId=YOUR_REFERENCE_ID"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/jobs/by-reference?referenceType=YOUR_REFERENCE_TYPE&referenceId=YOUR_REFERENCE_ID`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Retry a job

POST /jobs/retry Retry a job through the Claro Public API. Required scope: generate

Request body

Content type: application/json (required)

Request example

{
  "backgroundTaskId": "00000000-0000-4000-8000-000000000009"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/jobs/retry" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "backgroundTaskId": "00000000-0000-4000-8000-000000000009"
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/jobs/retry"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "backgroundTaskId": "00000000-0000-4000-8000-000000000009"
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/jobs/retry`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "backgroundTaskId": "00000000-0000-4000-8000-000000000009"
  }),
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get Started

Core

Operations

Modules

Research Agents

Platform Reference

API Documentation

Queue a scrape

Request body

Example request

Responses

Get job by ID

Parameters

Example request

Responses

Get jobs by reference

Parameters

Example request

Responses

Retry a job

Request body

Example request

Responses

​Queue a scrape

​Request body

​Example request

​Responses

​Get job by ID

​Parameters

​Example request

​Responses

​Get jobs by reference

​Parameters

​Example request

​Responses

​Retry a job

​Request body

​Example request

​Responses

Queue a scrape

Request body

Example request

Responses

Get job by ID

Parameters

Example request

Responses

Get jobs by reference

Parameters

Example request

Responses

Retry a job

Request body

Example request

Responses