Workspace
Find the brands a key can see, and read the workspace's plan, prompts and engine spend.
GET /brands
List the brands this key can see.
Note
A key on a seat limited to named clients lists only those clients.
| About this route | Detail |
|---|---|
| Returns | brands: one row per brand with its id, name, primaryDomain, verticalKey, active and lifecycle (client, pitch or archived). Use an id from this list as brandId on every other route. |
| Seat | Any seat's key, a viewer's included. |
| Plan | Every plan. |
| Rate limit | None on this route. |
| Engine budget | Nothing this route does is metered. |
curl "https://api.ansengine.co/brands" \
-H "Authorization: Bearer ak_your_key"| Status | When |
|---|---|
| 200 | brands: one row per brand with its id, name, primaryDomain, verticalKey, active and lifecycle (client, pitch or archived). Use an id from this list as brandId on every other route. |
| 401 | No valid API key was sent. |
GET /org/usage
Read the plan, the prompt pool and engine spend against the monthly cap.
Note
A key on a seat limited to named clients reads a smaller shape marked scoped: true, carrying its own clients' counts and spend only.
| About this route | Detail |
|---|---|
| Returns | plan, cycleStart, brands, seats, prompts (used and limit, with one row per brand), brandSpend, and spend: spentUsd against capUsd for this cycle, with halted true once the cap is reached. |
| Seat | Any seat's key, a viewer's included. |
| Plan | Every plan. |
| Rate limit | None on this route. |
| Engine budget | Nothing this route does is metered. |
curl "https://api.ansengine.co/org/usage" \
-H "Authorization: Bearer ak_your_key"| Status | When |
|---|---|
| 200 | plan, cycleStart, brands, seats, prompts (used and limit, with one row per brand), brandSpend, and spend: spentUsd against capUsd for this cycle, with halted true once the cap is reached. |
| 401 | No valid API key was sent. |
| 404 | The workspace behind this key no longer exists. |