API Documentation

Integrate JAKOV.AI into your workflow with our REST API

Quick Start

Get started with the JAKOV.AI API in minutes

1. Get your API key

2. Create a project

Create a project in the dashboard to configure your description style.

3. Submit products

Use the API to submit products for description generation.

Authentication

All API requests require authentication using a Bearer token. Include your API key in the Authorization header:

Authorization: Bearer ejaj_live_your_api_key_here

Keep your API key secure. Do not share it in client-side code or public repositories.

Endpoints

POST/api/v1/products

Submit products for description generation

Request Body

{
  "projectId": "your_project_id",
  "products": [
    {
      "ean": "1234567890123",
      "clientProductId": "SKU-001"
    },
    {
      "productName": "Wireless Headphones",
      "productBrand": "SoundMax",
      "clientProductId": "SKU-002"
    }
  ]
}

Parameters

Field	Type	Required	Description
projectId	string	Yes	Your project ID
products[].ean	string	No*	Product EAN/barcode
products[].productName	string	No*	Product name (used if no EAN)
products[].clientProductId	string	No	Your internal product ID

*Either ean or productName is required

GET/api/v1/products?id=...

Get the status and result of a product

{
  "id": "product_id",
  "ean": "1234567890123",
  "clientProductId": "SKU-001",
  "status": "completed",
  "generatedDescription": "This premium product...",
  "createdAt": 1706000000000,
  "completedAt": 1706000060000
}

Status Values

pendinglooking_upfoundgeneratingcompletednot_foundfailed

GET/api/v1/export?projectId=...

Export all completed descriptions from a project

Parameter	Type	Description
projectId	string	Required. Your project ID
format	string	Optional. "json" (default) or "csv"

GET/api/v1/credits

Get your current credit balance

{
  "balance": 1500
}

Webhooks

Webhook Events

Receive real-time notifications when descriptions are generated

Available Events

generation.completedgeneration.failedproject.completed

Webhook Payload

{
  "event": "generation.completed",
  "product": {
    "id": "product_id",
    "ean": "1234567890123",
    "clientProductId": "SKU-001",
    "description": "This premium product..."
  },
  "timestamp": "2026-01-23T12:00:00Z"
}

Signature Verification

Each webhook request includes a signature header for verification:

X-Webhook-Signature: sha256=abc123...

Verify the signature by computing HMAC-SHA256 of the request body using your webhook secret.

Rate Limits & Errors

Rate Limits

Endpoint	Limit
POST /api/v1/products	100 requests/minute
GET endpoints	300 requests/minute

Error Codes

Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing API key
404	Not Found - Resource doesn't exist
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

Need help? Contact us at info@jakov.ai