Knowledge & Taxonomy

Authenticate every request with Authorization: Bearer clr_live_YOUR_API_KEY.

List knowledge base items

GET /knowledge-base List knowledge base items through the Claro Public API. Required scope: taxonomy

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/knowledge-base" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/knowledge-base"
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/knowledge-base`, {
  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 knowledge base item

GET /knowledge-base/{id} Get knowledge base item through the Claro Public API. Required scope: taxonomy

Parameters

Name	Location	Type	Required
`id`	path	string	Yes

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/knowledge-base/$ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

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

const id = "YOUR_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/knowledge-base/${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.

Update knowledge base item

PATCH /knowledge-base/{id} Update knowledge base item through the Claro Public API. Required scope: taxonomy

Parameters

Name	Location	Type	Required
`id`	path	string	Yes

Request body

Content type: application/json (required)

Request example

{
  "name": "Procurement policy",
  "description": "Current purchasing requirements"
}

Example request

curl -X PATCH "https://platform.getclaro.ai/api/public/v1/knowledge-base/$ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Procurement policy",
  "description": "Current purchasing requirements"
}'

import json
import requests
id = "YOUR_ID"
url = f"https://platform.getclaro.ai/api/public/v1/knowledge-base/{id}"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "name": "Procurement policy",
  "description": "Current purchasing requirements"
}''')
response = requests.patch(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const id = "YOUR_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/knowledge-base/${id}`, {
  method: "PATCH",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Procurement policy",
    "description": "Current purchasing requirements"
  }),
});

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.

Upload knowledge base files

POST /knowledge-base/upload/files Upload knowledge base files through the Claro Public API. Required scope: taxonomy

Request body

Content type: multipart/form-data (required) Upload the source file using the file form field.

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/knowledge-base/upload/files" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -F "file=@path/to/file.csv"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/knowledge-base/upload/files"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
files = {"file": open("path/to/file.csv", "rb")}
response = requests.post(url, headers=headers, files=files)
response.raise_for_status()
print(response.text)

const formData = new FormData();
formData.append("file", fileInput.files[0]);

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/knowledge-base/upload/files`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
  body: formData,
});

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

Responses

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

Upload knowledge base content

POST /knowledge-base/upload/content Upload knowledge base content through the Claro Public API. Required scope: taxonomy

Request body

Content type: application/json (required)

Request example

{
  "name": "Procurement policy",
  "description": "Purchasing requirements",
  "content": "All suppliers must complete due diligence."
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/knowledge-base/upload/content" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Procurement policy",
  "description": "Purchasing requirements",
  "content": "All suppliers must complete due diligence."
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/knowledge-base/upload/content"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "name": "Procurement policy",
  "description": "Purchasing requirements",
  "content": "All suppliers must complete due diligence."
}''')
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/knowledge-base/upload/content`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Procurement policy",
    "description": "Purchasing requirements",
    "content": "All suppliers must complete due diligence."
  }),
});

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.

Classify an HTS code

POST /generate/hts-agent Classify an HTS code 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/hts-agent" \
  -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/hts-agent"
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/hts-agent`, {
  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.

Detect taxonomy structure

POST /taxonomy/detect-structure Detect taxonomy structure through the Claro Public API. Required scope: taxonomy

Request body

Content type: application/json (required)

Request example

{
  "headers": [
    "Department",
    "Category"
  ],
  "rows": [
    {
      "Department": "Electronics",
      "Category": "Laptops"
    }
  ]
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/taxonomy/detect-structure" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "headers": [
    "Department",
    "Category"
  ],
  "rows": [
    {
      "Department": "Electronics",
      "Category": "Laptops"
    }
  ]
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/taxonomy/detect-structure"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "headers": [
    "Department",
    "Category"
  ],
  "rows": [
    {
      "Department": "Electronics",
      "Category": "Laptops"
    }
  ]
}''')
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/taxonomy/detect-structure`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "headers": [
      "Department",
      "Category"
    ],
    "rows": [
      {
        "Department": "Electronics",
        "Category": "Laptops"
      }
    ]
  }),
});

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.

Map taxonomy

POST /taxonomy/{taxonomyId}/map Map taxonomy through the Claro Public API. Required scope: taxonomy

Parameters

Name	Location	Type	Required
`taxonomyId`	path	string	Yes

Request body

Content type: application/json (required)

Request example

{
  "catalogObjectId": "00000000-0000-4000-8000-000000000001"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/taxonomy/$TAXONOMY_ID/map" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "catalogObjectId": "00000000-0000-4000-8000-000000000001"
}'

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

const taxonomyId = "YOUR_TAXONOMY_ID";

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

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.

List taxonomy assignments

GET /taxonomy/{taxonomyId}/assignments List taxonomy assignments through the Claro Public API. Required scope: taxonomy

Parameters

Name	Location	Type	Required
`taxonomyId`	path	string	Yes

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/taxonomy/$TAXONOMY_ID/assignments" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
taxonomy_id = "YOUR_TAXONOMY_ID"
url = f"https://platform.getclaro.ai/api/public/v1/taxonomy/{taxonomy_id}/assignments"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const taxonomyId = "YOUR_TAXONOMY_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/taxonomy/${taxonomyId}/assignments`, {
  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.

Review taxonomy assignment

PATCH /taxonomy/assignments/{id} Review taxonomy assignment through the Claro Public API. Required scope: taxonomy

Parameters

Name	Location	Type	Required
`id`	path	string	Yes

Request body

Content type: application/json (required)

Request example

{
  "reviewStatus": "ACCEPTED"
}

Example request

curl -X PATCH "https://platform.getclaro.ai/api/public/v1/taxonomy/assignments/$ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "reviewStatus": "ACCEPTED"
}'

import json
import requests
id = "YOUR_ID"
url = f"https://platform.getclaro.ai/api/public/v1/taxonomy/assignments/{id}"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "reviewStatus": "ACCEPTED"
}''')
response = requests.patch(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const id = "YOUR_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/taxonomy/assignments/${id}`, {
  method: "PATCH",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reviewStatus": "ACCEPTED"
  }),
});

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.

Reassign taxonomy assignment

PATCH /taxonomy/assignments/{id}/reassign Reassign taxonomy assignment through the Claro Public API. Required scope: taxonomy

Parameters

Name	Location	Type	Required
`id`	path	string	Yes

Request body

Content type: application/json (required)

Request example

{
  "categoryRowId": "00000000-0000-4000-8000-000000000008"
}

Example request

curl -X PATCH "https://platform.getclaro.ai/api/public/v1/taxonomy/assignments/$ID/reassign" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "categoryRowId": "00000000-0000-4000-8000-000000000008"
}'

import json
import requests
id = "YOUR_ID"
url = f"https://platform.getclaro.ai/api/public/v1/taxonomy/assignments/{id}/reassign"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "categoryRowId": "00000000-0000-4000-8000-000000000008"
}''')
response = requests.patch(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const id = "YOUR_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/taxonomy/assignments/${id}/reassign`, {
  method: "PATCH",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "categoryRowId": "00000000-0000-4000-8000-000000000008"
  }),
});

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.

​List knowledge base items

​Example request

​Responses

​Get knowledge base item

​Parameters

​Example request

​Responses

​Update knowledge base item

​Parameters

​Request body

​Example request

​Responses

​Upload knowledge base files

​Request body

​Example request

​Responses

​Upload knowledge base content

​Request body

​Example request

​Responses

​Classify an HTS code

​Request body

​Example request

​Responses

​Detect taxonomy structure

​Request body

​Example request

​Responses

​Map taxonomy

​Parameters

​Request body

​Example request

​Responses

​List taxonomy assignments

​Parameters

​Example request

​Responses

​Review taxonomy assignment

​Parameters

​Request body

​Example request

​Responses

​Reassign taxonomy assignment

​Parameters

​Request body

​Example request

​Responses

List knowledge base items

Example request

Responses

Get knowledge base item

Parameters

Example request

Responses

Update knowledge base item

Parameters

Request body

Example request

Responses

Upload knowledge base files

Request body

Example request

Responses

Upload knowledge base content

Request body

Example request

Responses

Classify an HTS code

Request body

Example request

Responses

Detect taxonomy structure

Request body

Example request

Responses

Map taxonomy

Parameters

Request body

Example request

Responses

List taxonomy assignments

Parameters

Example request

Responses

Review taxonomy assignment

Parameters

Request body

Example request

Responses

Reassign taxonomy assignment

Parameters

Request body

Example request

Responses