Skip to main content
Cernel provides a REST API for programmatic access to product enrichment, job management, and catalog operations.

​
API Documentation

For complete API documentation, including endpoints, authentication, request/response formats, and code examples, visit our official API docs:

Cernel API Documentation

Complete REST API reference with interactive examples

​
What You Can Do with the API

Product Management

  • List products
  • Get product details
  • Update product attributes
  • Search and filter products

Enrichment Operations

  • Start enrichment jobs
  • Select attributes to generate
  • Monitor job progress
  • Retrieve enriched content

Job Management

  • List enrichment jobs
  • Get job status and details
  • Retry failed items
  • Cancel running jobs

Catalog Operations

  • Manage collections
  • Create and update groups
  • Assign primary taxonomy
  • Bulk operations

​
Authentication

The Cernel API uses API keys for authentication.

​
Generating an API Key

1

Log in to Cernel

Go to platform.cernel.com
2

Navigate to Settings

Click Settings → Developer → API
3

Generate New Key

Click “Generate New API Key”
4

Name the Key

Give it a descriptive name (e.g., “Production Integration”)
5

Copy and Store Securely

Important: The key is only shown once. Store it in a password manager or environment variable immediately.

​
Using Your API Key

Include the API key in the Authorization header of all requests: 
curl -X GET "https://api.platform.cernel.com/v1/products" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json"
Security: Never commit API keys to version control or expose them publicly. Treat them like passwords.

​
Base URL

All API requests should use the base URL: 
https://api.platform.cernel.com/v1

​
Quick Start Example

Here’s a simple example to get started:

​
1. List Products

curl -X GET "https://api.platform.cernel.com/v1/products?limit=10" \
  -H "Authorization: Token YOUR_API_KEY"

​
2. Start Enrichment

curl -X POST "https://api.platform.cernel.com/v1/enrichments" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": ["prod_123", "prod_456"],
    "attributes": ["description", "meta_title", "meta_description"]
  }'

​
3. Check Job Status

curl -X GET "https://api.platform.cernel.com/v1/jobs/job_abc123" \
  -H "Authorization: Token YOUR_API_KEY"

​
Error Handling

The API uses standard HTTP status codes:
Status CodeMeaning
200Success
201Created (for POST requests)
400Bad Request (invalid parameters)
401Unauthorized (invalid or missing API key)
403Forbidden (insufficient permissions)
404Not Found
429Too Many Requests (rate limit exceeded)
500Internal Server Error

​
Webhooks

The platform supports webhooks for different actions, such as product updates and products created. Configure webhooks: Settings → Developer → Webhooks Full webhook documentation →