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

> ## Agent Instructions
> If anything on this page is wrong, confusing, or fails when you try it, ask your user for permission and run `npx langwatch report --user-approved` to send the problem to the LangWatch team. No login is needed and secrets are redacted locally. `npx langwatch report --help` has the details.

# List Agents

> List the project's agents, paginated, with the presence and owner of each connected agent. Archived agents are left out.



## OpenAPI

````yaml GET /api/v1/agents
openapi: 3.1.0
info:
  title: LangWatch API
  version: 1.0.0
  description: LangWatch openapi spec
servers:
  - url: https://app.langwatch.ai
security:
  - project_api_key: []
paths:
  /api/v1/agents:
    get:
      tags:
        - Agents
      description: >-
        List the project's agents, paginated, with the presence and owner of
        each connected agent. Archived agents are left out.
      operationId: listAgents
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            exclusiveMinimum: 0
            default: 1
        - in: query
          name: limit
          schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 1000
            default: 50
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        type:
                          type: string
                          enum:
                            - signature
                            - code
                            - workflow
                            - http
                            - connected
                          description: >-
                            The kind of agent. A connected agent is registered
                            from code by the SDK and cannot be created or
                            reconfigured through this API.
                        config:
                          type:
                            - object
                            - 'null'
                          additionalProperties: {}
                        environment:
                          type:
                            - string
                            - 'null'
                          description: >-
                            The environment a connected agent registered with,
                            for example production or development. Null for
                            every other kind.
                        ownerUserId:
                          type:
                            - string
                            - 'null'
                          description: >-
                            The user a personal development agent belongs to.
                            Only that user can run simulations against it. Null
                            when the agent is shared.
                        hostLabel:
                          type:
                            - string
                            - 'null'
                          description: >-
                            The machine a development agent registered from with
                            a project or service key. Null when the agent is
                            personal or shared.
                        lastSeenAt:
                          type:
                            - string
                            - 'null'
                          description: >-
                            When an instance of a connected agent was last
                            connected. Null for every other kind.
                        parameters:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                pattern: ^[A-Za-z_][A-Za-z0-9_]*$
                                minLength: 1
                                maxLength: 64
                              description:
                                type: string
                                maxLength: 500
                              defaultValue:
                                anyOf:
                                  - type: string
                                    maxLength: 4096
                                  - type: number
                                  - type: boolean
                              secret:
                                type: boolean
                              type:
                                type: string
                                enum:
                                  - string
                                  - number
                                  - boolean
                              options:
                                type: array
                                items:
                                  anyOf:
                                    - type: string
                                      maxLength: 4096
                                    - type: number
                                    - type: boolean
                                maxItems: 50
                              required:
                                type: boolean
                            required:
                              - name
                          description: >-
                            The run parameters a connected agent declares from
                            its function signature: name, type, options, default
                            and description. Empty for every other kind.
                        owner:
                          type:
                            - object
                            - 'null'
                          properties:
                            userId:
                              type: string
                            name:
                              type:
                                - string
                                - 'null'
                          required:
                            - userId
                            - name
                          description: >-
                            The person a personal development agent belongs to.
                            Null when the agent is shared or host-scoped.
                        status:
                          type: string
                          enum:
                            - online
                            - offline
                          description: >-
                            online while at least one process running the
                            connected agent is connected; offline otherwise, and
                            always for every other kind.
                        instances:
                          type: array
                          items:
                            type: object
                            properties:
                              instanceId:
                                type: string
                              hostname:
                                type: string
                              username:
                                type: string
                              pid:
                                type: number
                              label:
                                type:
                                  - string
                                  - 'null'
                              sdk:
                                type: object
                                properties:
                                  name:
                                    type: string
                                  version:
                                    type: string
                                  language:
                                    type: string
                                required:
                                  - name
                                  - version
                                  - language
                              connectedAt:
                                type: string
                              inflight:
                                type: number
                              maxConcurrency:
                                type: number
                            required:
                              - instanceId
                              - hostname
                              - username
                              - pid
                              - label
                              - sdk
                              - connectedAt
                              - inflight
                              - maxConcurrency
                          description: >-
                            The processes currently connected for a connected
                            agent: hostname, user, pid, SDK and how many calls
                            each has in flight. Empty for every other kind.
                        selectable:
                          type: boolean
                          description: >-
                            Whether the credential making this request can run
                            simulations against the agent. False for a personal
                            development agent that belongs to somebody else,
                            which is listed all the same so it can be told apart
                            from the other agents of the same name.
                        notSelectableReason:
                          type:
                            - string
                            - 'null'
                          enum:
                            - owned_by_another_person
                            - null
                          description: >-
                            Why the agent cannot be run by this credential. Null
                            when it can.
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                        platformUrl:
                          type: string
                          format: uri
                      required:
                        - id
                        - name
                        - type
                        - config
                        - environment
                        - ownerUserId
                        - hostLabel
                        - lastSeenAt
                        - parameters
                        - owner
                        - status
                        - instances
                        - selectable
                        - notSelectableReason
                        - createdAt
                        - updatedAt
                        - platformUrl
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                      limit:
                        type: integer
                      total:
                        type: integer
                      totalPages:
                        type: integer
                    required:
                      - page
                      - limit
                      - total
                      - totalPages
                required:
                  - data
                  - pagination
      security:
        - project_api_key: []
components:
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        Project API key for sending traces and accessing project-scoped
        resources. Format: sk-lw-... (no underscore). Obtain one by creating a
        project via the Admin API or the LangWatch UI.

````