Skip to main content
GET
Get workspace brand

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

workspace_id
string
required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

brand_id
string
required

ID of the brand to get. Get it from id in List workspace brands.

Response

The brand.

id
string
required

ID of the brand.

Example:

"68e0c4a1b9d2f7003a5e1b42"

title
string
required

Title of the brand, from kit.title. Generating… while the brand is being generated.

Example:

"Nordwind"

kit
Kit · object
required

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:
design_system
Design System · object
required

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:
status
enum<string>
required

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.

Available options:
generating,
ready,
failed
Example:

"ready"

generation_step
string | null
required

Short progress label while status is generating, such as foundation or components. null otherwise.

Example:

"components"

failure_message
string | null
required

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
WorkspaceBrandPreview · object
required

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.