API
API documentation
Generate descriptions from your own systems with a simple JSON over HTTPS API. API access is included in the Enterprise plan.
Authentication
Create a key in your dashboard under API keys (account holder, Enterprise plan). A key is shown once, so store it safely. Send it as a bearer token. Keys act on your workspace and use its allowance and brand voice. Revoke a key at any time in the same place.
Base URL: https://productscribe.com/api/v1. All requests use HTTPS and JSON.
Authorization: Bearer ps_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxGenerate a description
POST /api/v1/generate. Each successful call uses one description from your allowance. If we cannot produce text, the call fails and nothing is used.
| Field | Type | Description |
|---|---|---|
title | string, required | Product name or title, up to 200 characters. |
keywords | string | Comma separated target keywords, up to 300 characters. |
details | string | Facts and features, one per line, up to 1500 characters. The text uses only these facts. |
language | string | One of 32 languages, for example English or French. Default English. |
length | string | short, medium (default) or long. |
folder | string | Optional folder name (up to 40 characters) for the dashboard history. |
curl -X POST https://productscribe.com/api/v1/generate \
-H "Authorization: Bearer $PRODUCTSCRIBE_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Stoneware pour-over coffee set",
"keywords": "pour over coffee set, ceramic dripper",
"details": "Hand-glazed stoneware\nFits one or two cups",
"language": "English",
"length": "short"
}'{
"id": "9f3c1a7e2b4d5c60",
"title": "Stoneware pour-over coffee set",
"language": "English",
"description": "A hand-glazed stoneware pour-over set that brews one or two cups ...",
"meta_description": "Hand-glazed stoneware pour-over coffee set for one or two cups ...",
"seo_score": 86,
"suggested_keywords": ["ceramic coffee dripper", "pour over set"],
"uniqueness_score": 100,
"remaining": null
}remaining is null on unlimited plans. Generated descriptions are also saved in your dashboard history. The SEO score is a writing aid, not a ranking prediction.
const res = await fetch("https://productscribe.com/api/v1/generate", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.PRODUCTSCRIBE_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ title: "Linen throw blanket", language: "German" }),
});
if (!res.ok) throw new Error((await res.json()).message);
const { description, meta_description } = await res.json();Read your usage
GET /api/v1/usage returns the plan, how many descriptions you used in the current 30-day period and when access ends.
{
"plan": "Enterprise",
"period_limit": null,
"used_this_period": 412,
"remaining": null,
"period_resets_at": "2027-01-08T10:15:00.000Z",
"access_ends_at": "2027-11-21T10:15:00.000Z"
}Errors
Errors return a JSON body with a machine-readable error and a readable message.
| Status | error | Meaning |
|---|---|---|
| 400 | invalid_title, invalid_language, invalid_json | The request body is not valid. |
| 401 | invalid_key | Missing, wrong or revoked key. |
| 402 | limit_reached, plan_expired | The period allowance is used up or access has ended. |
| 403 | plan_feature | The plan does not include API access. |
| 429 | rate_limited | Too many requests. Wait for the Retry-After seconds. |
| 502, 503 | ai_failed, ai_unavailable | The writing engine could not finish. Nothing was used. Retry. |
Limits
- 600 requests per key every 15 minutes.
- Up to 5 active keys per account.
- Enterprise is unlimited under fair use. See the Terms of Sale.
- Do not use the API for fake reviews, spam or misleading claims.
Questions or a bespoke integration? Ask for a quote.