> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agent.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Describe Agent

## Overview

Retrieve detailed metadata, input fields, and output fields for any agent on the platform using its ID or slug.

### Use Cases

* **Agent Discovery**: Programmatically inspect an agent's capabilities before invoking it.
* **Dynamic Integrations**: Build tools that adapt to an agent's input/output schema at runtime.
* **Catalog & Documentation**: Generate agent directories or documentation from live metadata.

## Endpoint

POST [https://api-lr.agent.ai/v1/action/describe\_agent](https://api-lr.agent.ai/v1/action/describe_agent)

## Authentication

Requires a Bearer token (your API key) in the `Authorization` header.

Get your API key from [agent.ai/user/settings#credits](https://agent.ai/user/settings#credits).

## Configuration Fields

### Agent ID

* **Description**: The unique agent identifier or human-readable slug.
* **Example**: `"fluximage"` or `"1a4g81x0bfsc5dpi"`
* **Required**: Yes

## Response Fields

### Agent

* **id**: Unique agent identifier.
* **human\_id**: Human-readable slug used in URLs (nullable).
* **name**: Agent display name.
* **description**: Agent description text.
* **url**: Agent runner page URL (e.g. `https://agent.ai/agent/fluximage`).
* **profile\_url**: Agent profile page URL (e.g. `https://agent.ai/profile/fluximage`).
* **icon**: Agent icon path.
* **type**: Agent type — `studio`, `workflow`, or `expert`.
* **status**: Visibility — `public`, `private`, or `team`.
* **tags**: Array of category tags.
* **executions**: Total number of runs.
* **review**: Object with `count` (number of reviews) and `score` (average 1–5).
* **authors**: Array of author objects with `name`, `username`, and `user_token`.
* **created\_at**: ISO 8601 creation timestamp.
* **updated\_at**: ISO 8601 last update timestamp.

### Inputs

* **Description**: Array of input field variable names the agent accepts.
* **Example**: `["image_prompt"]`

### Outputs

* **Description**: Array of output variable names the agent produces.
* **Example**: `["image_generated"]`

## Example Request

```curl -X POST https://api-lr.agent.ai/v1/action/describe_agent \ theme={null}
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"agent_id": "fluximage"}'
```

## Example Response

```{ theme={null}
  "status": 200,
  "agent": {
    "id": "1a4g81x0bfsc5dpi",
    "human_id": "fluximage",
    "name": "Flux Image Generator",
    "description": "Generates an image using the new Flux AI model.",
    "url": "https://agent.ai/agent/fluximage",
    "profile_url": "https://agent.ai/profile/fluximage",
    "icon": "/icons/generative-image.svg",
    "type": "studio",
    "status": "public",
    "tags": ["Marketing"],
    "executions": 970429,
    "review": {
      "count": 26611,
      "score": 4.23
    },
    "authors": [
      {
        "name": "Dharmesh Shah",
        "username": "dharmesh",
        "user_token": "77cadf7cbd19448b9f11951082c26bd1"
      }
    ],
    "created_at": "2024-08-15T20:56:33",
    "updated_at": "2026-03-13T17:44:27"
  },
  "inputs": ["image_prompt"],
  "outputs": ["image_generated"]
}
```