CoherenceDevelopers

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.

Request
curl https://api.coherenceltd.com/v1/licences \
  -H "Authorization: Bearer $COHERENCE_API_KEY"
Response 200
{
  "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

status
string
Only briefs with this status.One of: queued, researching, writing, checking, ready, failed
limit
integer
How many items to return, 1–100.
cursor
string
Pass next_cursor from the previous page to continue.
Request
curl https://api.coherenceltd.com/v1/briefs \
  -H "Authorization: Bearer $COHERENCE_API_KEY"
Response 200
{
  "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-Key
string · header
Same as idempotency_key in the body.

Body

product_name
string required
The product, or its TikTok Shop product link.
product_id
string
TikTok Shop product ID, if you have it.
audience
string
Who the creators should speak to.
objective
string
What the campaign should achieve.
approved_facts
string
Claims creators may make: ingredients, results, offers. Only these are stated as fact.
campaign_terms
string
Commission, deadlines, deliverables. Appended to the brief as written.
creative_direction
string
reference_urls
string[]
Up to 8 public HTTPS links to videos or pages to learn from.
idempotency_key
string
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.
Request
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"
  }'
Response 202
{
  "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

id
string · path required
The brief ID.
Request
curl https://api.coherenceltd.com/v1/briefs/{id} \
  -H "Authorization: Bearer $COHERENCE_API_KEY"
Response 200
{
  "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

category
string
One of: Beauty & skincare, Wellness, Personal care, Home & kitchen, Fashion, Tech & gadgets
sort
string
score is Coherence’s blend of reach and sales.One of: score, views, units_sold, newest
q
string
Words to find in the hook or angle.
limit
integer
Request
curl https://api.coherenceltd.com/v1/content-iq/hooks \
  -H "Authorization: Bearer $COHERENCE_API_KEY"
Response 200
{
  "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"
}