Webinar: Better Agents, Easier than Ever — Thursday, June 18th at 9am PT / 12pm ET. Register Now
Version 2.5
Branding

Branding

Read and update the workspace branding — the display name, light/dark logos, and primary color shown across the application.

All paths are relative to the base URL and require an Authorization: Bearer YOUR_API_KEY header.

Reading branding is available to any authenticated user (the same values are rendered to everyone). Updating branding is admin only.

The branding object

PublicBranding is returned by both endpoints. An empty string on any field means no override is set and the product default is in effect.

FieldTypeDescription
workspace_namestringWorkspace display name override.
logo_data_urlstringLight-mode logo as a data:image/png;base64 URL.
logo_dark_data_urlstringDark-mode logo as a data:image/png;base64 URL.
primary_colorstringPrimary brand color as #RRGGBB.

Get branding

GET /branding

Returns the current PublicBranding.

curl 'https://{your-deployment-host}/tenants/{tenant-id}/api/v2/branding' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Update branding

PATCH /branding

Atomic partial update. Absent fields are left untouched; an empty string clears that override back to the product default.

Body

FieldTypeRequiredDescription
workspace_namestringNoDisplay name override (max 40 characters). Empty string clears it.
logo_data_urlstringNoLight-mode logo as a data:image/png;base64 URL (PNG, max 256 KiB raw). Empty string clears it.
logo_dark_data_urlstringNoDark-mode logo as a data:image/png;base64 URL (PNG, max 256 KiB raw). Empty string clears it.
primary_colorstringNoPrimary brand color as #RRGGBB. Empty string clears it.
curl -X PATCH 'https://{your-deployment-host}/tenants/{tenant-id}/api/v2/branding' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "workspace_name": "Acme Corp", "primary_color": "#1A73E8" }'

Content is validated server-side (hex color format, PNG data-URL prefix and size); invalid input returns 422. Returns the updated PublicBranding.