API Documentation

0 · Overview

SidecarAI provides AI‑generated product descriptions, rating capture, and tenant‑specific JWT authentication. For a quick test drive you can also use the built‑in HTML forms.

1 · Interactive Forms

Use these browser‑friendly pages for manual testing:

Generate Token

/forms/generate_token_form

Sample tenant: tenantname
password: *****
Generate Text

/forms/api_generate_form

OpenAI API requests might take 45 seconds.
Rate Text

/forms/api_rating_form

Use the unique_id from a description response.

2 · Authentication

Most API calls require a Bearer token in the Authorization header.

Generate a Tenant JWT

POST /api_gen_token/generate_jwt.php

Parameter	Type	Description
tenant	string	Your tenant identifier
password	string	Your tenant password

Example Request:

curl -X POST /api_gen_token/generate_jwt.php \
     -d "tenant=tenantname&password=tenantpassword"

3 · Endpoints

3.1 Product Description API

GET /api

Required identifier (pick one):

product_id
product_id + color_code
ean

Common optional parameters:

Parameter	Type / Default	Description
target_platform	string / general	e.g. shopify
language	string / de	Response language
num_texts	int / 1	How many description variants to return
highlight_words	string	Comma‑separated keywords to weave into the copy
text_only	0 \| 1 / 0	text_only=1 returns only text in the product_description node, text_only=0 returns sections as configured in the database
length_range	int	Approx. words (not very strict) in description 20-1500 for text_only=1, 80-2000 for text_only=0
temperature	float / 0.7	Creativity (0‑1)
debug	0 \| 1 / 0	Verbose output

3.2 Rating API

GET | POST /api_rating

Parameter	Type	Description
unique_id	string	Record ID (from generate API response)
rating	int 1-10	User score

4 · Examples

4.1 Generate a Token

curl -X POST /api_gen_token \
     -d "tenant=tenantname&password=tenantpassword"

4.2.1 Generate Product Descriptions that are color agnostic (Product)

curl "/api?product_id=72203&color_code=875&target_platform=shopify&language=de&num_texts=2&highlight_words=&debug=1" \
     -H "Authorization: Bearer "

4.2.2 Generate Product Descriptions (Product + Color)

curl "/api?product_id=72203&color_code=875&target_platform=shopify&language=de&num_texts=2&highlight_words=&debug=1" \
     -H "Authorization: Bearer "

4.2.3 Generate Product Descriptions that are Color‑Agnostic (EAN)

curl "/api?ean=7483297498327489723&target_platform=shopify&language=de&num_texts=2&highlight_words=&debug=1" \
     -H "Authorization: Bearer "

4.3 Rate a Description (GET)

curl "/api_rating?unique_id=result_6802a6d43c3683.99899606&rating=8" \
     -H "Authorization: Bearer "

Get started

Bereit für bessere Produkttexte? {=$span-text}

Starten Sie Ihre kostenlose Demo und erleben Sie KAI in Aktion.

Demo anfragen

No credit card required
14-Day free trial