> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base44.com/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> Internal links on these pages omit the .md extension. Append .md to a docs page URL, or send an Accept: text/markdown header, to get that page as markdown.
# Get workspace brand
> This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.
Returns a brand with its full kit and design system.
While a brand is being generated, `kit` and `design_system` are empty. Poll this endpoint every few seconds until `status` is `ready` or `failed`, and read `generation_step` and `preview` in the meantime.
This is limited to 300 requests per minute, shared with [List workspace brands](/api-reference/list-workspace-brands). A signed-in session has its own limit, and every personal access token for the workspace shares one. Some workspaces have a different limit.
Call this as any member of the workspace, with a personal access token for that workspace sent as a Bearer token, or from a signed-in session. A read-only token is refused even though this endpoint only reads, and workspace API keys aren't accepted.
## OpenAPI
````yaml /developers/references/app-management/app-management-openapi.json get /api/workspace/{workspace_id}/brands/{brand_id}
openapi: 3.1.0
info:
title: Base44 App Management API
version: 1.0.0
servers:
- url: https://app.base44.com
security:
- PersonalAccessTokenAuth: []
paths:
/api/workspace/{workspace_id}/brands/{brand_id}:
get:
summary: Get workspace brand
description: >-
This API is in beta. Endpoints, fields, and behavior may still
change, so avoid depending on it in production.
Returns a brand with its full kit and design system.
While a brand is being generated, `kit` and `design_system` are empty.
Poll this endpoint every few seconds until `status` is `ready` or
`failed`, and read `generation_step` and `preview` in the meantime.
This is limited to 300 requests per minute, shared with [List workspace
brands](/api-reference/list-workspace-brands). A signed-in session has
its own limit, and every personal access token for the workspace shares
one. Some workspaces have a different limit.
Call this as any member of the workspace, with a personal access
token for that workspace sent as a Bearer token, or from a signed-in
session. A read-only token is refused even though this endpoint only
reads, and workspace API keys aren't accepted.
operationId: get_brand_api_workspace__workspace_id__brands__brand_id__get
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
description: >-
ID of the workspace. With a personal access token, use the token's
workspace. Get it from `organization_id` in [Get
app](/api-reference/get-app).
title: Workspace Id
description: >-
ID of the workspace. With a personal access token, use the token's
workspace. Get it from `organization_id` in [Get
app](/api-reference/get-app).
example: 67e0b12c4d8a3f005b21c9e4
- name: brand_id
in: path
required: true
schema:
type: string
description: >-
ID of the brand to get. Get it from `id` in [List workspace
brands](/api-reference/list-workspace-brands).
title: Brand Id
description: >-
ID of the brand to get. Get it from `id` in [List workspace
brands](/api-reference/list-workspace-brands).
example: 68e0c4a1b9d2f7003a5e1b42
responses:
'200':
description: The brand.
content:
application/json:
schema:
$ref: '#/components/schemas/WorkspaceBrand'
'401':
description: Missing or invalid credentials.
'403':
description: >-
You aren't a member of the workspace, your token is for a different
workspace or is read-only, or your credential can't be used on this
endpoint.
'404':
description: Brand not found in this workspace.
'409':
description: Your workspace requires an unlocked SSO session.
'429':
description: Rate limit exceeded.
components:
schemas:
WorkspaceBrand:
properties:
id:
type: string
title: Id
description: ID of the brand.
example: 68e0c4a1b9d2f7003a5e1b42
title:
type: string
title: Title
description: >-
Title of the brand, from `kit.title`. `Generating…` while the brand
is being generated.
example: Nordwind
kit:
additionalProperties: true
type: object
title: Kit
description: >-
The brand's identity. It needs a non-empty `title`, which becomes
the brand's title, and a `description`. Brands Base44 generates also
carry `tagLine`, `values`, `toneOfVoice`, `designGuidelines`,
`componentStyle`, and a `logo` with its `url`. Nothing else in it is
checked. Empty while the brand is being generated.
example:
description: >-
A family furniture workshop that builds solid oak tables and
chairs to order.
logo:
altText: Nordwind logo
url: https://media.base44.com/images/public/nordwind-logo.png
tagLine: Furniture built to last
title: Nordwind
toneOfVoice:
- Warm
- Plain-spoken
values:
- Craft
- Honesty
- Durability
design_system:
additionalProperties: true
type: object
title: Design System
description: >-
The brand's design system: its `tokens`, such as `colors` and
`fonts`, and its component sections. It's stored as you send it.
When you include `tokens`, send it as an object. It can be empty,
such as while the brand is being generated.
example:
tokens:
colors:
- label: Primary
token: primary
value: '#0B7A3B'
- label: Background
token: background
value: '#FAF7F2'
fonts:
- family: Fraunces
role: heading
- family: Inter
role: body
status:
type: string
enum:
- generating
- ready
- failed
title: Status
description: >-
`ready` once the brand is complete, `generating` while Base44 is
still generating it, or `failed` if generation stopped. A brand that
is still `generating` after 45 minutes without progress reads as
`failed`.
example: ready
generation_step:
anyOf:
- type: string
- type: 'null'
title: Generation Step
description: >-
Short progress label while `status` is `generating`, such as
`foundation` or `components`. `null` otherwise.
example: components
failure_message:
anyOf:
- type: string
- type: 'null'
title: Failure Message
description: >-
Why generation failed, when it failed for a reason you can fix.
`null` for any other brand, including one that failed for another
reason.
example: description is required
preview:
$ref: '#/components/schemas/WorkspaceBrandPreview'
description: >-
What generation has found so far. Use it to show the brand before
`status` is `ready`. A brand you created yourself has an empty
preview.
type: object
required:
- id
- title
- kit
- design_system
- status
- generation_step
- failure_message
- preview
title: WorkspaceBrand
WorkspaceBrandPreview:
properties:
title:
anyOf:
- type: string
- type: 'null'
title: Title
description: The brand's name, or `null` until generation finds it.
example: Nordwind
logo_url:
anyOf:
- type: string
- type: 'null'
title: Logo Url
description: URL of a logo generation found, or `null` until it finds one.
example: https://media.base44.com/images/public/nordwind-logo.png
colors:
items:
type: string
type: array
title: Colors
description: Colors found so far, primary color first.
example:
- '#0B7A3B'
- '#FAF7F2'
fonts:
items:
type: string
type: array
title: Fonts
description: Font families found so far, most used first.
example:
- Fraunces
- Inter
type: object
required:
- title
- logo_url
- colors
- fonts
title: WorkspaceBrandPreview
description: What a generation has found so far, before the design system is ready.
securitySchemes:
PersonalAccessTokenAuth:
type: http
scheme: bearer
description: 'Personal access token, sent as `Authorization: Bearer `.'
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.