---
title: "Get Chat Starter Settings For A Registered Agent"
method: GET
path: "/v1/orchestrate/agents/{id}/chat-starter-settings"
tags: ["Agent Chat Starter Settings"]
---

# Get Chat Starter Settings For A Registered Agent

`GET /v1/orchestrate/agents/{id}/chat-starter-settings`

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

## Path parameters

- `id` string, required

## Query parameters

- `environment_id` string, uuid, nullable
- `version_id` integer, nullable

## Response `200`

Successful Response

- AgentChatStarterSettingsOut — A specification for chat starter settings within an agent
  - `icon` string, nullable — xml strings or encoded base64 image data
  - `id` union, required — Unique identifier for the agent or no_agent for UI get
    - string, uuid
    - string
  - `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` union, required — Creation timestamp
    - string, date-time
    - string
  - `updated_at` union, required — Last update timestamp
    - string, date-time
    - string
  - `updated_by` string, required — ID of the user who updated the agent
  - `starter_prompts` AgentPromptsOut, required
    - `prompts` AgentPrompt[] — list of starter prompts of the agent
      - `id` string — Unique identifier for the prompt
      - `title` string, required — Title of the prompt
      - `subtitle` string — description of the prompt
      - `prompt` string, required — contents of the prompt
      - `state` string — active/inactivate
    - `is_default_prompts` boolean — is the prompts default or not
  - `welcome_content` AgentWelcomeContentOut, required
    - `welcome_message` string, nullable — Welcome message
    - `description` string, nullable — Description
    - `is_default_message` boolean — is the welcome message default or not
    - `is_default_description` boolean — is the welcome message description default or not

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/ibm/apis/wxo-server-api.md) · [All operations](https://skmtc.net/ibm/apis/wxo-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ibm/wxo-server-api/revisions/82c114c37196/schema)