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

# Retrieve an agent

> Retrieves the agent with the given ID.



## OpenAPI

````yaml admin-openapi GET /agents/{agent_id}
openapi: 3.0.1
info:
  title: api
  version: 0.0.1
servers:
  - url: https://api.proficientai.com
    description: Production (The production environment)
  - url: https://main-64bxvpctea-uc.a.run.app
    description: Staging (The staging environment)
  - url: http://localhost:8080
    description: Development (The local environment)
security: []
paths:
  /agents/{agent_id}:
    get:
      tags:
        - Agents
      summary: Retrieve an agent
      description: Retrieves the agent with the given ID.
      operationId: agents_get
      parameters:
        - name: agent_id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AgentId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agent'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    AgentId:
      title: AgentId
      type: string
      description: The unique identifier of the agent
    Agent:
      title: Agent
      type: object
      description: >-
        <p>An _agent_ is an AI entity that exists to serve your project's users.
        Agents are intelligent, configurable and context-aware and can interact
        with your users via a messaging system enabled by the Proficient
        API.</p>
      properties:
        id:
          $ref: '#/components/schemas/AgentId'
        object:
          $ref: '#/components/schemas/AgentObjectType'
        active:
          $ref: '#/components/schemas/AgentActiveStatus'
        description:
          $ref: '#/components/schemas/AgentDescription'
        display_description:
          $ref: '#/components/schemas/AgentDisplayDescription'
        display_name:
          $ref: '#/components/schemas/AgentDisplayName'
        name:
          $ref: '#/components/schemas/AgentName'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
      required:
        - id
        - object
        - active
        - description
        - display_description
        - display_name
        - name
        - created_at
        - updated_at
    ApiError:
      title: ApiError
      type: object
      description: >-
        Represents the general interface of an API error. The body of every
        error returned by the API contains `code` and `message` fields.
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      required:
        - error
    AgentObjectType:
      title: AgentObjectType
      type: string
      enum:
        - agent
      description: The type of the `Agent` object
    AgentActiveStatus:
      title: AgentActiveStatus
      type: boolean
      description: >-
        Whether the agent is currently active. If not, users will not be able to
        interact with the agent.
    AgentDescription:
      title: AgentDescription
      type: string
      description: The description of the agent, intended for developers' reference.
    AgentDisplayDescription:
      title: AgentDisplayDescription
      type: string
      description: >-
        The agent's public-facing description, meant to be visible to your
        users.
    AgentDisplayName:
      title: AgentDisplayName
      type: string
      description: >-
        The agent's display name, intended to serve as the public-facing name
        visible to your users.
    AgentName:
      title: AgentName
      type: string
      description: >-
        The name of the agent, designed to be visible to developers for internal
        reference purposes.
    CreatedAt:
      title: CreatedAt
      type: integer
      description: >-
        The time at which the object was created, measured in milliseconds since
        the Unix epoch
    UpdatedAt:
      title: UpdatedAt
      type: integer
      description: >-
        The time at which the object was last updated, measured in milliseconds
        since the Unix epoch
    ApiErrorBody:
      title: ApiErrorBody
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ApiErrorCode'
        message:
          type: string
      required:
        - code
        - message
    ApiErrorCode:
      title: ApiErrorCode
      type: string
      enum:
        - invalid_request
        - invalid_credentials
        - forbidden
        - resource_not_found
        - conflict
        - unavailable
        - unknown

````