Sign in

v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
AI

Get AI helper branding

Returns the organization's AI helper branding — display name, optional custom logo URL, and copy used on AI helper landing surfaces (headline, body, prompt placeholder). Falls back to Omni's defaults when the organization hasn't configured custom branding, so the response is always populated. Used by client apps (iOS, embeds) to render the AI helper with the org's chosen identity.

get/api/v1/ai/branding

Response

AI branding retrieved successfully.

bodystring required

Body / description copy shown beneath the headline on AI helper landing surfaces.

headlinestring required

Short headline shown on AI helper landing surfaces.

logoUrlstring uri nullable required

Absolute URL to a custom AI helper logo. null when the org has not configured a custom logo — clients should render their default avatar (e.g. Blobby).

namestring required

Display name for the AI helper. Defaults to Omni Agent when no custom branding is set.

placeholderstring required

Placeholder text for the AI helper's prompt input.

Example response

{
  "body": "I can help answer data questions, build a Dashboard, or create an App.",
  "headline": "What would you like to know?",
  "logoUrl": "https://example.com/blobby.png",
  "name": "Blobby",
  "placeholder": "Ask a question about your data..."
}