Sign in

v1

latestOpenAPI 3.1.02026-07-26252382475.4 KB
Agent Chat Starter Settings

Get Chat Starter Settings For A Registered Agent

Retrieves welcome message and starter prompts of a specific agent by its id.

get/v1/orchestrate/agents/{id}/chat-starter-settings

Path parameters

idstring required

Query parameters

environment_idstring uuid nullable
version_idinteger nullable

Response

Successful Response

iconstring nullable

xml strings or encoded base64 image data

tenant_idstring required

ID of the tenant that owns this agent

created_bystring required

ID of the user who created the agent

updated_bystring required

ID of the user who updated the agent