Reference · v1.0.0
API reference
Every endpoint, generated from the OpenAPI spec. Base URL https://api.coherenceltd.com/v1.
Account
Your workspace and its licences.
List licences
get/licencesscope products:read
The tools this workspace is licensed for, which channels each licence covers (web, api, mcp) and how much of this month’s allowance is used. Creator Briefs counts briefs in its own limits, so its usage here may read 0.
curl https://api.coherenceltd.com/v1/licences \
-H "Authorization: Bearer $COHERENCE_API_KEY"{
"data": [
{
"product": "creator-briefs",
"name": "string",
"channels": [
"web"
],
"monthly_allowance": 0,
"used_this_month": 0,
"renews_or_ends_at": "string"
}
]
}Creator Briefs
Research a product and write a brief creators can film from.
List briefs
get/briefsscope creator-briefs:read
Creator briefs in this workspace, newest first.
Parameters
statusstring | Only briefs with this status.One of: queued, researching, writing, checking, ready, failed |
limitinteger | How many items to return, 1–100. |
cursorstring | Pass next_cursor from the previous page to continue. |
curl https://api.coherenceltd.com/v1/briefs \
-H "Authorization: Bearer $COHERENCE_API_KEY"{
"data": [
{
"id": "string",
"status": "queued",
"product_name": "string",
"title": "string",
"created_at": "string",
"updated_at": "string",
"finished_at": "string",
"url": "https://…"
}
],
"next_cursor": "string"
}Create a brief
post/briefsscope creator-briefs:execute
Researches a TikTok Shop product, its best videos and competitors, and writes a brief creators can film from (US market, English). Returns at once with status "queued"; the brief is usually ready in 3–6 minutes. Uses one brief from the monthly allowance.
Parameters
Idempotency-Keystring · header | Same as idempotency_key in the body. |
Body
product_namestring required | The product, or its TikTok Shop product link. |
product_idstring | TikTok Shop product ID, if you have it. |
audiencestring | Who the creators should speak to. |
objectivestring | What the campaign should achieve. |
approved_factsstring | Claims creators may make: ingredients, results, offers. Only these are stated as fact. |
campaign_termsstring | Commission, deadlines, deliverables. Appended to the brief as written. |
creative_directionstring | |
reference_urlsstring[] | Up to 8 public HTTPS links to videos or pages to learn from. |
idempotency_keystring | A UUID you generate. Retrying with the same key returns the original result instead of doing the work twice. Also accepted as the Idempotency-Key header. |
curl -X POST https://api.coherenceltd.com/v1/briefs \
-H "Authorization: Bearer $COHERENCE_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"product_name": "string"
}'{
"id": "string",
"status": "queued",
"product_name": "string",
"title": "string",
"created_at": "string",
"updated_at": "string",
"finished_at": "string",
"url": "https://…",
"input": {},
"markdown": "string",
"document": {},
"sources": [
"string"
],
"warnings": [
"string"
],
"error_code": "string",
"revision": 0
}Get a brief
get/briefs/{id}scope creator-briefs:read
One brief with its status. When status is ready it includes the finished brief as Markdown and as structured data. Poll every 15–30 seconds while it is running.
Parameters
idstring · path required | The brief ID. |
curl https://api.coherenceltd.com/v1/briefs/{id} \
-H "Authorization: Bearer $COHERENCE_API_KEY"{
"id": "string",
"status": "queued",
"product_name": "string",
"title": "string",
"created_at": "string",
"updated_at": "string",
"finished_at": "string",
"url": "https://…",
"input": {},
"markdown": "string",
"document": {},
"sources": [
"string"
],
"warnings": [
"string"
],
"error_code": "string",
"revision": 0
}ContentIQ
What is selling on TikTok Shop right now, and why.
List winning hooks
get/content-iq/hooksscope content-iq:read
What is selling on TikTok Shop right now: top videos by category with their hooks, angles, why they work and their sales. One entry per video, strongest first. Refreshed daily.
Parameters
categorystring | One of: Beauty & skincare, Wellness, Personal care, Home & kitchen, Fashion, Tech & gadgets |
sortstring | score is Coherence’s blend of reach and sales.One of: score, views, units_sold, newest |
qstring | Words to find in the hook or angle. |
limitinteger |
curl https://api.coherenceltd.com/v1/content-iq/hooks \
-H "Authorization: Bearer $COHERENCE_API_KEY"{
"data": [
{
"id": "string",
"category": "Beauty & skincare",
"video_id": "string",
"video_url": "string",
"hook": "string",
"angle": "string",
"why_it_works": "string",
"evidence": "string",
"views": 0,
"units_sold": 0,
"gmv_usd": 0,
"metric_window_days": 0,
"is_ad": true,
"observed_at": "string"
}
],
"refreshed_at": "string"
}