Skip to main content
GET
/
v1
/
ai
/
branding
Get AI Agent branding
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/ai/branding \
  --header 'Authorization: Bearer <token>'
{
  "displayName": "DataBot",
  "logoUrl": "https://example.com/custom-logo.png",
  "headline": "Welcome to DataBot",
  "body": "Your intelligent data assistant",
  "promptPlaceholder": "What would you like to know?"
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Response

Successfully retrieved AI Agent branding

​
name
string

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

Example:

"Omni AI"

​
logoUrl
string | null

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

Example:

"https://example.com/custom-logo.png"

​
headline
string

Headline text displayed on AI Agent landing surfaces

Example:

"Welcome to Omni AI"

​
body
string

Body copy displayed on AI Agent landing surfaces

Example:

"Ask questions about your data in natural language"

​
promptPlaceholder
string

Placeholder text for the AI prompt input field

Example:

"Ask a question about your data..."