Brands

4 endpoints for working with brands.

List brands

get/brandslist_brands

Lists the organization's brands. A brand id is required to create a skroll.

Example request

curl

curl -X GET https://skrollai.com/api/v1/brands \
  -H "Authorization: Bearer sk_..."

Responses

200Brands, newest first

Array of Brand

Field	Type	Description
id*	string (uuid)	n/a
name*	string	n/a
sourceUrl*	string	Website the brand was extracted from
createdAt*	string (date-time)	n/a
updatedAt*	string (date-time)	n/a

401Missing, malformed, unknown or revoked API key

403The key's creator lacks access

422Input failed validation

429Rate limit exceeded. See the Retry-After header

500Unexpected server error

Extract a brand from a website

post/brandscreate_brand_from_url

Scrapes a public website and synthesizes a brand book from it. Synchronous and slow (typically 30-90 seconds).

Example request

curl

curl -X POST https://skrollai.com/api/v1/brands \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com"
  }'

Request body

Field	Type	Description
url*	string (uri)	Public website to extract the brand book from

Responses

201The created brand

401Missing, malformed, unknown or revoked API key

403The key's creator lacks access

422Input failed validation

429Rate limit exceeded. See the Retry-After header

500Unexpected server error

Get a brand

get/brands/{id}get_brand

Returns a brand including its full brand book (palette, typography, voice, imagery).

Example request

curl

curl -X GET https://skrollai.com/api/v1/brands/0b1e0f7c-1c3f-4a0e-9f5a-1a2b3c4d5e6f \
  -H "Authorization: Bearer sk_..."

Parameters

Parameter	In	Type	Description
id*	path	string (uuid)	n/a

Responses

200The brand

401Missing, malformed, unknown or revoked API key

403The key's creator lacks access

404Resource not found

422Input failed validation

429Rate limit exceeded. See the Retry-After header

500Unexpected server error

Delete a brand

delete/brands/{id}delete_brand

Deletes a brand. Fails with 409 if any skroll still uses it.

Example request

curl

curl -X DELETE https://skrollai.com/api/v1/brands/0b1e0f7c-1c3f-4a0e-9f5a-1a2b3c4d5e6f \
  -H "Authorization: Bearer sk_..."

Parameters

Parameter	In	Type	Description
id*	path	string (uuid)	n/a

Responses

200Deleted

Deleted

Field	Type	Description
deleted*	true	n/a

401Missing, malformed, unknown or revoked API key

403The key's creator lacks access

404Resource not found

409Brand is still used by existing skrolls

422Input failed validation

429Rate limit exceeded. See the Retry-After header

500Unexpected server error