Skip to main content
POST
/
action
/
describe_agent
Describe Agent
curl --request POST \
  --url https://api-lr.agent.ai/v1/action/describe_agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "fluximage"
}
'
{
  "status": 200,
  "agent": {
    "id": "<string>",
    "human_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "url": "<string>",
    "profile_url": "<string>",
    "icon": "<string>",
    "type": "studio",
    "status": "public",
    "tags": [
      "<string>"
    ],
    "executions": 123,
    "review": {
      "count": 123,
      "score": 123
    },
    "authors": [
      {
        "name": "<string>",
        "username": "<string>",
        "user_token": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "inputs": [
    "<string>"
  ],
  "optional_inputs": [
    "<string>"
  ],
  "outputs": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token from your account (https://agent.ai/user/integrations#api)

Body

application/json
​
agent_id
string
required

The agent ID or human-readable slug (e.g. "fluximage" or "1a4g81x0bfsc5dpi").

Example:

"fluximage"

Response

Agent details retrieved successfully

​
status
integer
Example:

200

​
agent
object

Agent metadata and configuration details.

​
inputs
string[]

Required input field variable names the agent accepts.

​
optional_inputs
string[]

Optional input field variable names. Only present for knowledge agents (e.g. run_id to resume a conversation).

​
outputs
string[]

Output variable names the agent produces.