> For the complete documentation index, see [llms.txt](https://docs.uptiq.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.uptiq.ai/ai-workbench-qore/console/agent-builder/build/basic-details.md).

# Basic Details

**Basic Details** is the agent's identity card. It carries the information that travels with the agent everywhere it appears: a name, a short description, the format its responses are written in, and its conversation starters. These settings are what users (and other systems) see; they are the agent's outside.

Reach this page by clicking **Agent Config** in the canvas header. Basic Details is the first item under *Agent Setup* in the left navigation, and the default section when the dialog opens. The page reads *"Define your agent's identity - name, purpose, and how it should respond."*

### The fields <a href="#the-fields" id="the-fields"></a>

The right pane has two sections, **Identity** and **Response**, and a **Conversation Starters** list.

#### Identity <a href="#identity" id="identity"></a>

**Name** (required). The agent's display name. This is what appears in the header strip, in the agent-name selector menu, and on the agent-list dashboard. Renaming here is the same action as renaming through the agent-name menu in the header.

**Description** (required). A short prose description of what the agent does. It is used in listings of agents and in tooltips. Keep it action-oriented, saying what the agent does for users, not how it is built.

#### Response <a href="#response" id="response"></a>

**Output Format** (required). A dropdown that sets how the agent's text responses are rendered:

* **Markdown** (default): the agent's output is treated as Markdown. Headings, bullets, code blocks, bold, and links render with formatting.
* **Json**: the agent's output is treated as a JSON payload. The host application is responsible for parsing it.

Choose Markdown for any agent whose output is read by humans in chat. Choose Json when the agent's output is consumed by another system that needs a structured payload.

#### Conversation Starters <a href="#conversation-starters" id="conversation-starters"></a>

A list of suggested first messages for the agent, such as `Ask about a policy` or `Troubleshoot a common problem`. They appear as buttons in an empty conversation, and selecting one fills the message box without sending it.

Select **Manage** to change the list. The **Conversation Starters** window reads *"Help users start a conversation with your agent."* and holds one text box for each starter:

* Edit a starter by typing in its box.
* Select the bin icon beside a starter to delete it.
* Select **Add Starter** to add a box. It is unavailable while the list holds four starters.
* Select **Regenerate Suggestions** to have the platform suggest a new set of starters.
* Select **Save** to keep your changes. It stays unavailable until you change something. Select **Cancel** to close the window without saving.

### Fields and obligation <a href="#fields-and-obligation" id="fields-and-obligation"></a>

| Field                 | Obligation | Notes                                 |
| --------------------- | ---------- | ------------------------------------- |
| Name                  | Mandatory  | Recommended. Auto-generated.          |
| Description           | Mandatory  | Recommended. Auto-generated.          |
| Output Format         | Mandatory  | `Markdown` (default) or `Json`.       |
| Conversation Starters | Optional   | Select **Manage** to change the list. |

### Saving <a href="#saving" id="saving"></a>

The **Save** button sits in the top-right of the right pane. It activates when you've made unsaved changes. Clicking it commits the changes to the current draft of the agent.

Saved changes here do **not** automatically create a version snapshot. They're saved to the draft. To preserve the current state as a recoverable version, click **Draft Version** in the header strip after saving.

### Why this matters <a href="#why-this-matters" id="why-this-matters"></a>

These fields are the agent's public face. The name is how every other surface (the dashboard, the chat, the Layout canvas, any embed of this agent in another application) refers to this agent. The description shapes how teammates decide whether *this* agent is the right one to invoke for a new use case. The output format quietly decides whether your agent fits cleanly into the host application. The conversation starters decide what a first-time user is invited to ask.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.uptiq.ai/ai-workbench-qore/console/agent-builder/build/basic-details.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
