Get Chat Starter Settings For A Registered Agent

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

Get Chat Starter Settings For A Registered Agent

cURL

curl --request GET \
  --url https://{api_endpoint}/api/v1/orchestrate/agents/{id}/chat-starter-settings \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "<string>",
  "created_by": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>",
  "starter_prompts": {
    "prompts": [
      {
        "title": "<string>",
        "prompt": "<string>",
        "id": "<string>",
        "subtitle": "<string>",
        "state": "<string>"
      }
    ],
    "is_default_prompts": false
  },
  "welcome_content": {
    "welcome_message": "<string>",
    "description": "<string>",
    "is_default_message": false,
    "is_default_description": false
  }
}

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

200

application/json

Successful Response

A specification for chat starter settings within an agent

id · string<uuid> string · 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 · string<date-time> string · required

Creation timestamp

updated_at · string<date-time> string · required

Last update timestamp

updated_by · string · required

ID of the user who updated the agent

starter_prompts · AgentPromptsOut · object · required

Agent Starter Prompts

Show child attributes

welcome_content · AgentWelcomeContentOut · object · required

Agent Welcome Message

Show child attributes