> For the complete documentation index, see [llms.txt](https://docs.interactive.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.interactive.ai/cli/iai_agents_describe.md).

# iai agents describe

Describe an agent in detail

## Synopsis

Show detailed information about a specific agent including its configuration.

Endpoint shows Private (name:port), reachable only within the project, and Public, the externally accessible hostname, shown when the agent was created or updated with --endpoint.

In Agent Config, each attached mcp shows the endpoint the agent dials it on: an entry with endpoint: public uses the mcp's public endpoint, one without endpoint its private one.

Secret-backed environment variables show \<secret: name/key>, not the secret value.

Use --revision to view a specific past revision instead of the current state. Past revision output includes server-recorded actor and source attribution when available.

```
iai agents describe <agent_name> [flags]
```

## Examples

```
  iai agents describe my-agent
  iai agents describe my-agent --revision 3
  iai agents describe my-agent --yaml
```

## Options

```
  -h, --help                  help for describe
      --json                  Output raw API response as JSON
  -o, --organization string   Organization name
  -p, --project string        Project name
      --revision int          Show a specific past revision instead of the current state
  -w, --watch                 Poll and refresh every 2s until interrupted
      --yaml                  Output raw API response as YAML
```

## Options inherited from parent commands

```
      --api-key string               API key for authentication
      --cfg-file string              Path to YAML config file with organization, project, and optional service definitions
      --deployment-hostname string   Hostname for the deployment API (default "https://deployment.interactive.ai")
      --hostname string              Hostname for the API (default "https://app.interactive.ai")
```

## SEE ALSO

* [iai agents](https://docs.interactive.ai/cli/iai_agents.md) - Deploy AI agents with policies, routines, and tools


---

# 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.interactive.ai/cli/iai_agents_describe.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.
