> ## 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

> Get detailed metadata, input fields, and output fields for a specific agent by its ID or slug.



## OpenAPI

````yaml /api-reference/v1/v1.1.0_openapi.json post /action/describe_agent
openapi: 3.0.0
info:
  version: 1.1.0
  title: AI Actions - Get Data
  description: API specifications for 'Get Data' category AI actions.
  license:
    name: MIT
servers:
  - url: https://api-lr.agent.ai/v1
security:
  - bearerAuth: []
paths:
  /action/describe_agent:
    post:
      tags:
        - Agent Discovery
      summary: Describe Agent
      description: >-
        Get detailed metadata, input fields, and output fields for a specific
        agent by its ID or slug.
      operationId: describe_agent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - agent_id
              properties:
                agent_id:
                  type: string
                  description: >-
                    The agent ID or human-readable slug (e.g. "fluximage" or
                    "1a4g81x0bfsc5dpi").
                  example: fluximage
      responses:
        '200':
          description: Agent details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAgentResponse'
              example:
                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
        '400':
          description: Missing agent_id parameter
          content:
            application/json:
              example:
                status: 400
                error: agent_id is required
        '401':
          description: Invalid or expired API key
          content:
            application/json:
              example:
                status: 401
                error: Invalid or expired JWT token.
        '404':
          description: Agent not found
          content:
            application/json:
              example:
                status: 404
                error: Agent not found
components:
  schemas:
    DescribeAgentResponse:
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code
          example: 200
        agent:
          $ref: '#/components/schemas/AgentDetails'
        inputs:
          type: array
          items:
            type: string
          description: List of input field variable names the agent accepts.
          example:
            - image_prompt
        outputs:
          type: array
          items:
            type: string
          description: List of output variable names the agent produces.
          example:
            - image_generated
    AgentDetails:
      type: object
      description: Agent metadata and configuration details.
      properties:
        id:
          type: string
          description: Unique agent identifier.
          example: 1a4g81x0bfsc5dpi
        human_id:
          type: string
          nullable: true
          description: Human-readable slug for the agent URL.
          example: fluximage
        name:
          type: string
          description: Agent display name.
          example: Flux Image Generator
        description:
          type: string
          description: Agent description text.
          example: Generates an image using the new Flux AI model.
        url:
          type: string
          description: Agent runner page URL.
          example: https://agent.ai/agent/fluximage
        profile_url:
          type: string
          description: Agent profile page URL.
          example: https://agent.ai/profile/fluximage
        icon:
          type: string
          description: Agent icon path.
          example: /icons/generative-image.svg
        type:
          type: string
          description: Agent type.
          enum:
            - studio
            - workflow
            - expert
          example: studio
        status:
          type: string
          description: Agent visibility status.
          enum:
            - public
            - private
            - team
          example: public
        tags:
          type: array
          items:
            type: string
          description: Agent category tags.
          example:
            - Marketing
        executions:
          type: integer
          description: Total number of times the agent has been run.
          example: 970429
        review:
          type: object
          properties:
            count:
              type: integer
              description: Number of reviews.
              example: 26611
            score:
              type: number
              description: Average review score (1-5).
              example: 4.23
        authors:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                example: Dharmesh Shah
              username:
                type: string
                example: dharmesh
              user_token:
                type: string
        created_at:
          type: string
          format: date-time
          description: ISO 8601 creation timestamp.
        updated_at:
          type: string
          format: date-time
          description: ISO 8601 last update timestamp.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token from your account
        ([https://agent.ai/user/integrations#api](https://agent.ai/user/integrations#api))

````