Platform · API
Every agent, callable.
If the catalog work belongs inside a pipeline you already run, skip the interface. Products, enrichment, validation, market analysis, import, brands, and categories are all REST endpoints, with webhooks on completion.
POST/api/{org}/product-enrichment-jobs/create
{
"productIds": ["prod_abc123", "prod_def456"],
"modelType": "pro-v1",
"attributeIds": ["attr_description", "attr_specifications"]
}POST/api/{org}/product-enrichment-jobs/{id}/items/get
{
"success": true,
"data": {
"items": [
{
"productId": "prod_abc123",
"status": "completed",
"attributes": {
"material": {
"value": "316L stainless steel, passivated",
"sources": ["https://www.boltdepot.com/..."]
}
}
}
]
}
}Surface
What is exposed
Anything the interface can start, a key can start. There is no second-class API tier.
- Organizations
- Discover which organizations a key can reach.
- Products
- Create, read, update, delete, and bulk-create products.
- Enrichment jobs
- Create a job, list jobs, read per-product results, stop a run.
- Validation jobs
- The same lifecycle, returning scores and reasoning per attribute.
- Market analysis jobs
- Retailer, price, MSRP, and stock results per product.
- AI import jobs
- Submit files, poll extraction, and finalise the products you want.
- Brand & category jobs
- Brand enrichment and category enrichment, driven the same way.
- Webhooks
- Register endpoints and receive job completion events.
Conventions
What to expect
Keys, not sessions
Scoped to an organization, with a configurable rate limit and auto-refill, and usage tracked per key. Rotate without touching anyone's login.
Jobs, not requests
Agent work is asynchronous by nature. You create a job, it runs in the background, and results are read per item when it completes.
Webhooks over polling
Register an endpoint and take the completion event. Polling works; it is just worse.
Predictable envelopes
A consistent success and error shape, standard status codes, and cursor-style pagination on list endpoints.
Rate headers on every response
Limit, remaining, and reset, so a client can back off before it gets a 429 rather than after.
Costs still estimated
API-created jobs consume the same credits and respect the same balance. Nothing runs that the organization cannot pay for.
API
Developer questions
How do we authenticate?
An API key, sent as either an x-api-key header or a Bearer token. Keys are scoped to an organization and carry their own rate limit and usage tracking.
How many products can one job take?
Up to 5,000 product IDs per enrichment job. Larger catalogs are a loop, not a support ticket.
Do we have to poll for results?
You can, but you should not need to. Register a webhook and take the completion event instead.
What are the rate limits?
Configurable per key, with limit, remaining, and reset returned as response headers. A 429 means the key hit its ceiling, not that the platform did.
Is there an SDK?
Not yet — the API is plain REST with JSON, so a typed client is a short file. If an official SDK would change your decision, tell sales; it moves the roadmap.
Create a key and POST ten products.
The free credits cover a real integration test, not a hello-world. Start there and decide.
5 credits on signup · no card required