Brand API

In ANKK, each Public API key is automatically bound to a single Brand upon creation. All subsequent API requests operate within that brand’s context. You can retrieve brand details to verify key validity and access status.

📌 Endpoints

Method	Path	Description	Required Scope
`GET`	`/v1/brand`	Retrieve details for the brand bound to the API key	`brands:read` or `*`
`GET`	`/v1/brands`	Retrieve the key-bound brand wrapped in a list array	`brands:read` or `*`

🔍 Get Brand Details (`GET /v1/brand`)

Verify which brand your spk_... API key is attached to.

Request Example

curl -X GET "https://api.ankk.app/v1/brand" \
  -H "Authorization: Bearer spk_live_xxxxxxxx"

Response Example (`200 OK`)

{
  "brand_ref": "brand_01jm8v4k9example",
  "name": "ACME Studio",
  "slug": "acme-studio",
  "role": "owner",
  "is_locked": false
}

Response Fields

Field	Type	Description
`brand_ref`	`string`	Unique brand identifier (ULID format)
`name`	`string`	Display name of the brand
`slug`	`string`	Unique slug used in URL paths
`role`	`string`	Permission role of the key issuer (`owner`)
`is_locked`	`boolean`	Indicates whether the brand is locked due to billing or policy restrictions

[!IMPORTANT] If is_locked: true, publishing and write operations will be blocked with 423 Locked (brand_locked). Check your subscription under Plans & Limits or Billing Guide.