AI Workflows - Claro AI

Authenticate every request with Authorization: Bearer clr_live_YOUR_API_KEY.

Start an agentic list

POST /generate/list Start an agentic list through the Claro Public API. Required scope: generate

Request body

Content type: application/json (required)

Request example

{
  "prompt": "Find European ecommerce software suppliers",
  "min_rows": 10,
  "search_tier": "focus"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/generate/list" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "prompt": "Find European ecommerce software suppliers",
  "min_rows": 10,
  "search_tier": "focus"
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/generate/list"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "prompt": "Find European ecommerce software suppliers",
  "min_rows": 10,
  "search_tier": "focus"
}''')
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/generate/list`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "prompt": "Find European ecommerce software suppliers",
    "min_rows": 10,
    "search_tier": "focus"
  }),
});

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.

Generate criteria

POST /generate/criteria Generate criteria through the Claro Public API. Required scope: generate

Request body

Content type: application/json (required)

Request example

{
  "prompt": "Find sustainable packaging suppliers"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/generate/criteria" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "prompt": "Find sustainable packaging suppliers"
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/generate/criteria"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "prompt": "Find sustainable packaging suppliers"
}''')
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/generate/criteria`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "prompt": "Find sustainable packaging suppliers"
  }),
});

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.

Clarify a prompt

POST /generate/clarify-prompt Clarify a prompt through the Claro Public API. Required scope: generate

Request body

Content type: application/json (required)

Request example

{
  "prompt": "Find software suppliers for an ecommerce company"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/generate/clarify-prompt" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "prompt": "Find software suppliers for an ecommerce company"
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/generate/clarify-prompt"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "prompt": "Find software suppliers for an ecommerce company"
}''')
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/generate/clarify-prompt`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "prompt": "Find software suppliers for an ecommerce company"
  }),
});

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.

Generate company details

POST /generate/company-details Generate company details through the Claro Public API. Required scope: generate

Request body

Content type: application/json (required)

Request example

{
  "company_name": "Claro",
  "domain": "getclaro.ai",
  "functional_area": "Procurement",
  "sub_category": "Supplier intelligence"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/generate/company-details" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "company_name": "Claro",
  "domain": "getclaro.ai",
  "functional_area": "Procurement",
  "sub_category": "Supplier intelligence"
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/generate/company-details"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "company_name": "Claro",
  "domain": "getclaro.ai",
  "functional_area": "Procurement",
  "sub_category": "Supplier intelligence"
}''')
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/generate/company-details`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "company_name": "Claro",
    "domain": "getclaro.ai",
    "functional_area": "Procurement",
    "sub_category": "Supplier intelligence"
  }),
});

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.

Ingest FindAll data

POST /generate/find-all/ingest Ingest FindAll data through the Claro Public API. Required scope: generate

Request body

Content type: application/json (required)

Request example

{
  "objective": "Find UK manufacturers of recycled cardboard packaging"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/generate/find-all/ingest" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "objective": "Find UK manufacturers of recycled cardboard packaging"
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/generate/find-all/ingest"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "objective": "Find UK manufacturers of recycled cardboard packaging"
}''')
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/generate/find-all/ingest`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "objective": "Find UK manufacturers of recycled cardboard packaging"
  }),
});

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.

Create FindAll run

POST /generate/find-all/runs Create FindAll run through the Claro Public API. Required scope: generate

Request body

Content type: application/json (required)

Request example

{
  "objective": "Find UK recycled-packaging manufacturers",
  "entity_type": "company",
  "match_conditions": [
    {
      "name": "Material",
      "description": "Produces recycled cardboard packaging"
    }
  ],
  "match_limit": 10
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/generate/find-all/runs" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "objective": "Find UK recycled-packaging manufacturers",
  "entity_type": "company",
  "match_conditions": [
    {
      "name": "Material",
      "description": "Produces recycled cardboard packaging"
    }
  ],
  "match_limit": 10
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/generate/find-all/runs"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "objective": "Find UK recycled-packaging manufacturers",
  "entity_type": "company",
  "match_conditions": [
    {
      "name": "Material",
      "description": "Produces recycled cardboard packaging"
    }
  ],
  "match_limit": 10
}''')
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/generate/find-all/runs`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "objective": "Find UK recycled-packaging manufacturers",
    "entity_type": "company",
    "match_conditions": [
      {
        "name": "Material",
        "description": "Produces recycled cardboard packaging"
      }
    ],
    "match_limit": 10
  }),
});

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

Responses

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

Get FindAll run

GET /generate/find-all/runs/{findallId} Get FindAll run through the Claro Public API. Required scope: generate

Parameters

Name	Location	Type	Required
`findallId`	path	string	Yes

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/$FINDALL_ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
findall_id = "YOUR_FINDALL_ID"
url = f"https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/{findall_id}"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const findallId = "YOUR_FINDALL_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/${findallId}`, {
  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 FindAll result

GET /generate/find-all/runs/{findallId}/result Get FindAll result through the Claro Public API. Required scope: generate

Parameters

Name	Location	Type	Required
`findallId`	path	string	Yes

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/$FINDALL_ID/result" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
findall_id = "YOUR_FINDALL_ID"
url = f"https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/{findall_id}/result"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const findallId = "YOUR_FINDALL_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/${findallId}/result`, {
  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.

Extend FindAll run

POST /generate/find-all/runs/{findallId}/extend Extend FindAll run through the Claro Public API. Required scope: generate

Parameters

Name	Location	Type	Required
`findallId`	path	string	Yes

Request body

Content type: application/json (required)

Request example

{
  "additional_match_limit": 10
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/$FINDALL_ID/extend" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "additional_match_limit": 10
}'

import json
import requests
findall_id = "YOUR_FINDALL_ID"
url = f"https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/{findall_id}/extend"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "additional_match_limit": 10
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const findallId = "YOUR_FINDALL_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/${findallId}/extend`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "additional_match_limit": 10
  }),
});

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.

Enrich FindAll run

POST /generate/find-all/runs/{findallId}/enrich Enrich FindAll run through the Claro Public API. Required scope: generate

Parameters

Name	Location	Type	Required
`findallId`	path	string	Yes

Request body

Content type: application/json (required)

Request example

{
  "output_schema": {
    "employee_count": {
      "type": "number"
    }
  },
  "processor": "company_research"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/$FINDALL_ID/enrich" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "output_schema": {
    "employee_count": {
      "type": "number"
    }
  },
  "processor": "company_research"
}'

import json
import requests
findall_id = "YOUR_FINDALL_ID"
url = f"https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/{findall_id}/enrich"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "output_schema": {
    "employee_count": {
      "type": "number"
    }
  },
  "processor": "company_research"
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const findallId = "YOUR_FINDALL_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/${findallId}/enrich`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "output_schema": {
      "employee_count": {
        "type": "number"
      }
    },
    "processor": "company_research"
  }),
});

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.

Cancel FindAll run

POST /generate/find-all/runs/{findallId}/cancel Cancel FindAll run through the Claro Public API. Required scope: generate

Parameters

Name	Location	Type	Required
`findallId`	path	string	Yes

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/$FINDALL_ID/cancel" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
findall_id = "YOUR_FINDALL_ID"
url = f"https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/{findall_id}/cancel"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.post(url, headers=headers)
response.raise_for_status()
print(response.text)

const findallId = "YOUR_FINDALL_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/generate/find-all/runs/${findallId}/cancel`, {
  method: "POST",
  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.

​Start an agentic list

​Request body

​Example request

​Responses

​Generate criteria

​Request body

​Example request

​Responses

​Clarify a prompt

​Request body

​Example request

​Responses

​Generate company details

​Request body

​Example request

​Responses

​Ingest FindAll data

​Request body

​Example request

​Responses

​Create FindAll run

​Request body

​Example request

​Responses

​Get FindAll run

​Parameters

​Example request

​Responses

​Get FindAll result

​Parameters

​Example request

​Responses

​Extend FindAll run

​Parameters

​Request body

​Example request

​Responses

​Enrich FindAll run

​Parameters

​Request body

​Example request

​Responses

​Cancel FindAll run

​Parameters

​Example request

​Responses

Start an agentic list

Request body

Example request

Responses

Generate criteria

Request body

Example request

Responses

Clarify a prompt

Request body

Example request

Responses

Generate company details

Request body

Example request

Responses

Ingest FindAll data

Request body

Example request

Responses

Create FindAll run

Request body

Example request

Responses

Get FindAll run

Parameters

Example request

Responses

Get FindAll result

Parameters

Example request

Responses

Extend FindAll run

Parameters

Request body

Example request

Responses

Enrich FindAll run

Parameters

Request body

Example request

Responses

Cancel FindAll run

Parameters

Example request

Responses