Release Notes
- What's new
- Known issues
- Troubleshooting
- License reference
Get Started
Environments
Connections
Tools
Large Language Models (LLMs)
Evaluation Framework
Webchats
Tutorials
API's reference
- watsonx Orchestrate Developer Edition APIs
- Orchestrate Agent
- Assistants Runs
- Custom Assistants
- watsonx Assistant
- External Chat Agents
- Message Threads
- Documents
- Vector Index
- Catalog Management
- Tenant Management
- Provisioning Lite
- Embed settings
- User Profiles
- Completions
- Background Tasks
- Auth
- Orchestrate Assistant
- Notifications
- IBM unique ID mapping
- Prompts
- Artifact Management
- Default Agent Settings
- all journey types
- Connections
- Tools
- Welcome Content
- LLM Analytics
- Internal Calls are listed over here
- Agents
- Agent Releases
- Agent Release Environments
- Agent Chat Starter Settings
- API Reference
- channel integration
- Knowledge-Bases
- Chat with Docs
- Toolkits
- Voice Configurations
- Models
- Model-Policy
- Credentials
- Teams Channel
- Twilio WhatsApp Channel
Legal notices
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
/
orchestrate
/
agents
/
{id}
/
chat-starter-settings
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/orchestrate/agents/{id}/chat-starter-settings \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"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": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"prompt": "<string>",
"state": "<string>"
}
],
"is_default": false
},
"welcome_content": {
"welcome_message": "<string>",
"description": "<string>",
"is_default": false
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200
application/json
Successful Response
A specification for chat starter settings within an agent
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/orchestrate/agents/{id}/chat-starter-settings \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"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": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"prompt": "<string>",
"state": "<string>"
}
],
"is_default": false
},
"welcome_content": {
"welcome_message": "<string>",
"description": "<string>",
"is_default": false
}
}
Assistant
Responses are generated using AI and may contain mistakes.