Skip to main content
The Claro Public API exposes supported platform workflows through a versioned, API-key-authenticated interface.

​
Explore the Public APIs

Catalogues & Records

Manage catalogues, sources, records, snapshots, and actions.

Tables & Cells

Read table data and manage columns, rows, and cells.

Data Enrichment

Prepare catalogue data and run enrichment workflows.

AI Workflows

Run agentic generation and FindAll discovery workflows.

Knowledge & Taxonomy

Manage knowledge content, HTS classification, and taxonomy mapping.

Workspace & Account Management

Manage workspaces and review account limits, credits, and usage.

Background Jobs

Queue scraping work and inspect or retry background jobs.

Supplier Matching & Comparison

Find suppliers and run catalogue comparison workflows.

Price & Product Monitoring

Configure and run price and product monitoring workflows.

Data Quality & Export

Run deduplication and export catalogue or result data.

​
Base URL

​
Authentication

Send your Claro API key as a Bearer token with every request:
Treat API keys as secrets. Never expose them in browser code, public repositories, or client-side logs.

​
Create an API key

​
1. Open API key settings

Sign in to the Claro platform, open Settings, and select the API Keys tab.
Claro Settings page with an arrow pointing to the API Keys tab

​
2. Start creating a key

On the API keys page, select Create key.
Claro API keys page with an arrow pointing to Create key

​
3. Configure the key

Enter a descriptive name, select the scope, and then select Create key:
  • Personal charges API usage to your personal account.
  • Workspace charges API usage to the selected workspace and is available only to workspace administrators and owners.
Create an API key dialog highlighting the name, scope, and Create key controls

​
4. Copy and store the key

Use the copy button to save the key in a secure secret manager before closing the dialog. The complete key is displayed only once.
One-time API key dialog with the key redacted and arrows highlighting the warning and copy button
You cannot retrieve the complete key after closing the dialog. If you lose it, revoke the key and create a replacement.

​
API key scopes

  • objects for objects, tables, workspaces, account information, and related workflows
  • enrich for enrichment operations
  • generate for generation, scraping, and job operations
  • taxonomy for knowledge-base and taxonomy operations
  • team for team-restricted comparison, monitoring, supplier-finding, and export operations
An operation that lists multiple scopes requires all of them. A request made without a required scope returns 403 Forbidden.

​
Errors and rate limits

  • 401 Unauthorized - the API key is missing or invalid
  • 403 Forbidden - the key lacks a required scope or workspace access
  • 404 Not Found - the resource or endpoint does not exist
  • 429 Too Many Requests - the key exceeded its tier’s rate limit
Rate limits depend on the API key tier. Contact Claro support if you need a higher limit.