Public REST API
Read brands, creatives, transcripts and boards from your own code.
On this page
Overview
The public REST API (a way for your own code or tools to read adintel data over the web) is read-only and returns JSON. It is on the Agency plan and up.
Base URL:
https://app.adintel.biz/api/v1
Authentication with an API key
- Open Settings → API and MCP.
- Click Create API key with Public REST API ticked. A key can carry the MCP scope, the API scope or both.
- Copy the key; it is shown only once. Keep it out of shared documents and public code.
- Send it on every request in the
Authorizationheader:
curl -H "Authorization: Bearer adk_your_key" "https://app.adintel.biz/api/v1/creatives?limit=5"
A key acts as you, in your workspace. Revoke it on the same page at any time.
Main endpoints
| Endpoint | What it returns |
|---|---|
GET /brands | Brands with their creative and ad counts. Filter with query and tracked. |
GET /brands/{id} | One brand: active creatives, velocity, media mix, landing pages, countries, top hooks. |
GET /creatives | De-duplicated creatives. Filters include brand, text query, format, active, country, language, platform, angle, emotion, offer, style, scaled, minimum runtime, ad count or score, start dates, and sort. |
GET /creatives/{id} | One creative: media, copy, landing pages, runtime, score breakdown, tags, transcript and the underlying ads. |
GET /creatives/{id}/transcript | Transcript text and timestamped segments. 404 when the creative is not a video or is not transcribed yet. |
GET /boards | Your workspace's boards. |
GET /boards/{id} | One board's details. |
GET /boards/{id}/creatives | The board's saved creatives with their notes, newest first. |
GET /usage | This period's API credits: total, used, remaining, calls and the reset date. Free. |
Responses and paging
Every response has the same shape:
{"data": ..., "metadata": {"count": ..., "cursor": ..., "credits_used": ..., "credits_remaining": ...}}
To get the next page, pass metadata.cursor back as ?cursor=. Stop when it is null.
Errors
Errors keep the same shape, with data: null and an error object holding a code and a message.
| Status | Meaning |
|---|---|
| 401 | The key is missing, wrong or revoked. |
| 403 | The key does not have the Public REST API scope. |
| 402 | Your plan does not include the API, or the API credits for this period are used up. |
| 404 | Not found, or not visible to your workspace. |
| 429 | Too many requests. Wait the number of seconds in the Retry-After header. |
Credits and rate limits
- API credits are separate from AI credits. Agency includes 10,000 API credits a month; Enterprise is unlimited.
- A call costs 1 credit per creative returned, and at least 1. A brand lookup is 1 credit; a page of 50 creatives is 50.
- Refused calls cost nothing, and
/usageis free. - A list never overspends: when few credits are left, the page shrinks to what remains.
- Credits reset with your Space's monthly credit period.
- The rate limit is 60 requests a minute per key.
Settings → API and MCP shows the credits used this period, the number of calls, the reset date and your most recent requests.
Full reference
The interactive reference, with every parameter, is at app.adintel.biz/api/v1/docs. In the app, it opens from API docs in the sidebar.