Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
AI

Get AI Agent branding

Return the organization's AI Agent's branding configuration, including display name, custom logo URL, and copy for AI Agent landing surfaces. Falls back to Omni's default values when custom branding hasn't been configured.

get/v1/ai/branding

Response

Successfully retrieved AI Agent branding

namestring

The display name for the AI Agent. Defaults to Omni Agent if branding hasn't been configured.

logoUrlstring nullable

Absolute URL to the custom logo image for the AI Agent. Returns null if no custom logo is configured.

headlinestring

Headline text displayed on AI Agent landing surfaces

bodystring

Body copy displayed on AI Agent landing surfaces

promptPlaceholderstring

Placeholder text for the AI prompt input field

Example response

{
  "name": "Omni AI",
  "logoUrl": "https://example.com/custom-logo.png",
  "headline": "Welcome to Omni AI",
  "body": "Ask questions about your data in natural language",
  "promptPlaceholder": "Ask a question about your data..."
}