> 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/agent-builder/build/basic-details.md).

# Basic Details

**Basic Details** is the agent's identity card. It carries the four pieces of information that travel with the agent everywhere it appears — in the host application, in the preview pane, in dashboards, in shared traces: a name, an avatar, a short description, and the format the agent renders its responses in. These settings are what users (and other systems) see; they are the agent's outside.

Manage Agent → Basic Details

Reach this page by clicking **Manage Agent** in the header strip; Basic Details is the default section in the left navigation when the dialog opens.

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

The right pane has four configurable items, top to bottom.

#### Agent Avatar <a href="#agent-avatar" id="agent-avatar"></a>

A small image that represents the agent visually in chat surfaces and in the Layout canvas. The avatar is optional. Two buttons sit next to the preview: **Upload** (pick a local image) and **Remove** (clear the current avatar). When no avatar is set, the platform shows a default icon.

#### Agent Name <a href="#agent-name" id="agent-name"></a>

The agent's display name. This is what shows 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.

#### Agent Description <a href="#agent-description" id="agent-description"></a>

A short prose description of what the agent does. Used in tenant-facing listings of agents and in tooltips. Keep it action-oriented — what the agent does for users — rather than implementation-oriented.

#### Agent Output Format <a href="#agent-output-format" id="agent-output-format"></a>

A dropdown selecting 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.

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

| Field               | Obligation | Notes                           |
| ------------------- | ---------- | ------------------------------- |
| Agent Avatar        | Optional   | Default icon shown when empty.  |
| Agent Name          | Mandatory  | Recommended. Auto-generated.    |
| Agent Description   | Optional   | Recommended. Auto-generated.    |
| Agent Output Format | Mandatory  | `Markdown` (default) or `Json`. |

### 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 four fields are the agent's public face. The name and avatar are 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. And the output format quietly decides whether your agent fits cleanly into the host application or generates parsing errors at runtime. Get these right at the start; revisiting them later means updating every surface that has already rendered the agent's identity.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.