Skip to main content
Get Chat Starter Settings For A Registered Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Query Parameters

environment_id
string<uuid> | null
version_id
integer | null

Response

Successful Response

A specification for chat starter settings within an agent

id
required

Unique identifier for the agent or no_agent for UI get

tenant_id
string
required

ID of the tenant that owns this agent

created_by
string
required

ID of the user who created the agent

created_on
required

Creation timestamp

updated_at
required

Last update timestamp

updated_by
string
required

ID of the user who updated the agent

starter_prompts
AgentPromptsOut · object
required

Agent Starter Prompts

welcome_content
AgentWelcomeContentOut · object
required

Agent Welcome Message

icon
string | null

xml strings or encoded base64 image data