Skip to main content
Get Chat Starter Settings For A Registered Agent
curl --request GET \
  --url https://{api_endpoint}/api/v1/orchestrate/agents/{id}/chat-starter-settings \
  --header 'Authorization: Bearer <token>'
{
  "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.watson-orchestrate.ibm.com/llms.txt

Use this file to discover all available pages before exploring further.

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