Method | Path | Scopes | Status |
|---|
POST | /v1/api-keys
| keys:manage / session
| 201 |
GET | /v1/api-keys
| keys:manage / session
| 200 |
GET | /v1/api-keys/{key_id}
| keys:manage / session
| 200 |
PATCH | /v1/api-keys/{key_id}
| keys:manage / session
| 200 |
POST | /v1/api-keys/{key_id}/rotate
| keys:manage / session
| 201 |
POST | /v1/api-keys/{key_id}/revoke
| keys:manage / session
| 200 |
GET | /v1/brands
| brands:read
| 200 |
GET | /v1/brands/{brand_id}
| brands:read
| 200 |
GET | /v1/brands/{brand_id}/capabilities
| any read scope | 200 |
GET | /v1/brands/{brand_id}/prompt-library
| prompts:read
| 200 |
GET | /v1/brands/{brand_id}/prompt-library/{prompt_id}
| prompts:read
| 200 |
GET | /v1/brands/{brand_id}/scan-runs
| visibility:read
| 200 |
GET | /v1/brands/{brand_id}/scan-runs/{scan_run_id}
| visibility:read
| 200 |
GET | /v1/brands/{brand_id}/visibility
| visibility:read
| 200 |
GET | /v1/brands/{brand_id}/recommendations
| recommendations:read
| 200 |
GET | /v1/brands/{brand_id}/recommendations/{recommendation_id}
| recommendations:read
| 200 |
GET | /v1/brands/{brand_id}/content
| content:read
| 200 |
GET | /v1/brands/{brand_id}/content/{content_id}
| content:read
| 200 |
PATCH | /v1/brands/{brand_id}/content/{content_id}
| content:write
| 200 |
POST | /v1/brands/{brand_id}/content/{content_id}/cover
| content:write
| 200 |
POST | /v1/brands/{brand_id}/content/generations
| content:generate
| 202 |
GET | /v1/jobs/{job_id}
| jobs:read
| 200 |
POST | /v1/jobs/{job_id}/cancel
| jobs:read
| 200 |
GET | /v1/brands/{brand_id}/integrations
| integrations:read
| 200 |
POST | /v1/brands/{brand_id}/publishing/previews
| publishing:preview
| 200 |
POST | /v1/brands/{brand_id}/publishing/operations
| publishing:write
| 202 |
GET | /v1/brands/{brand_id}/publishing/operations/{operation_id}
| jobs:read or publishing:write
| 200 |
GET | /v1/brands/{brand_id}/calendar
| calendar:read
| 200 |
PATCH | /v1/brands/{brand_id}/calendar/topics/{topic_id}
| calendar:write
| 200 |
POST | /v1/brands/{brand_id}/calendar/publications/{publication_id}/reschedule
| calendar:write + publishing:write
| 200 |
POST | /v1/brands/{brand_id}/calendar/publications/{publication_id}/cancel
| calendar:write
| 200 |
GET | /v1/brands/{brand_id}/results
| results:read
| 200 |
POST | /v1/brands/{brand_id}/results/refresh
| results:refresh
| 200 |
GET | /v1/brands/{brand_id}/website
| website:read
| 200 |
GET | /v1/brands/{brand_id}/website/resources
| website:read
| 200 |
GET | /v1/brands/{brand_id}/website/changes
| website:read
| 200 |
GET | /v1/brands/{brand_id}/website/changes/{change_set_id}
| website:read
| 200 |
GET | /v1/brands/{brand_id}/website/activity
| website:read
| 200 |
POST | /v1/brands/{brand_id}/website/actions
| website:write
| 200 |
GET | /v1/brands/{brand_id}/local
| local:read
| 200 |
POST | /v1/brands/{brand_id}/local/runs
| local:write
| 200 |
PATCH | /v1/brands/{brand_id}/local/recommendations/{recommendation_id}
| local:write
| 200 |
POST | /v1/brands/{brand_id}/local/locations
| local:write
| 200 |
PATCH | /v1/brands/{brand_id}/local/locations/{location_id}
| local:write
| 200 |
GET | /v1/brands/{brand_id}/image-bank
| images:read
| 200 |
GET | /v1/usage
| usage:read or keys:manage / session
| 200 |
GET | /v1/openapi.json
| none | 200 |
