Skip to main content
PUT
/
v1
/
orchestrate
/
agents
/
{id}
/
chat-starter-settings
Create Or Update Chat Starter Settings For A Registered Agent
curl --request PUT \
  --url https://{api_endpoint}/api/v1/orchestrate/agents/{id}/chat-starter-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "starter_prompts": {
    "customize": [
      {
        "title": "<string>",
        "prompt": "<string>",
        "id": "<string>",
        "subtitle": "<string>",
        "state": "<string>"
      }
    ]
  },
  "welcome_content": {
    "welcome_message": "<string>",
    "description": "<string>"
  }
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json

A specification for chat starter settings within an agent

starter_prompts
AgentCustomizedPromptsIn · object

Agent Starter Prompts

welcome_content
AgentWelcomeContentIn · object

Agent Welcome Message

Response

Successful Response