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

# List agents

> Lists public metadata for named support agents in the API key workspace. Prompt/config internals and learned profiles are not returned.



## OpenAPI

````yaml /openapi.json get /api/v1/agents
openapi: 3.1.0
info:
  title: Woes REST API
  summary: >-
    Public REST API for Woes workspace conversations, issues, clients, agents,
    sources, definitions, usage, and analytics.
  description: >-
    Use workspace API keys to work with Woes support conversations, messages,
    issues, client account aggregates, public agent metadata, API context
    sources, workspace definitions, usage meters, and sanitized analytics from
    server-side integrations.
  version: '2026-06-29'
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://woes.dev
    description: Production
security:
  - workspaceApiKey: []
tags:
  - name: Conversations
    description: Create, read, update, and message support conversations.
  - name: Issues
    description: Create, read, and update support issues.
  - name: Clients
    description: Read client account aggregates derived from workspace conversations.
  - name: Agents
    description: Read named support agent metadata and public widget keys.
  - name: Sources
    description: Create, inspect, update, delete, and rescan API context sources.
  - name: Definitions
    description: Read workspace tags, statuses, priorities, and custom field definitions.
  - name: Usage
    description: Read current-month public API and live API check usage.
  - name: Analytics
    description: Read sanitized workspace analytics aggregates.
paths:
  /api/v1/agents:
    get:
      tags:
        - Agents
      summary: List agents
      description: >-
        Lists public metadata for named support agents in the API key workspace.
        Prompt/config internals and learned profiles are not returned.
      operationId: listAgents
      parameters:
        - $ref: '#/components/parameters/AgentSearch'
        - $ref: '#/components/parameters/AgentEnabled'
        - $ref: '#/components/parameters/AgentIsDefault'
        - $ref: '#/components/parameters/ListLimit'
      responses:
        '200':
          description: Agent list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentListResponse'
              examples:
                agents:
                  value:
                    object: list
                    hasMore: false
                    agents:
                      - object: agent
                        id: 872b407a-d359-4479-806a-72307e9c27d0
                        name: Docs agent
                        enabled: true
                        isDefault: false
                        widgetPublicKey: trovw_agent_872b407ad3594479806a72307e9c27d0
                        attachedSourceCount: 3
                        learningStatus: ready
                        learnedAt: '2026-06-29T13:00:00.000Z'
                        createdAt: '2026-06-28T18:00:00.000Z'
                        updatedAt: '2026-06-29T13:00:00.000Z'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    AgentSearch:
      name: search
      in: query
      required: false
      description: Search by agent id, name, or public widget key.
      schema:
        type: string
        minLength: 1
        maxLength: 120
      example: docs
    AgentEnabled:
      name: enabled
      in: query
      required: false
      description: Filter agents by enabled state.
      schema:
        type: boolean
      example: true
    AgentIsDefault:
      name: isDefault
      in: query
      required: false
      description: Filter to default or non-default agents.
      schema:
        type: boolean
      example: false
    ListLimit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      description: Number of records to return.
      example: 10
  schemas:
    AgentListResponse:
      type: object
      required:
        - object
        - hasMore
        - agents
      properties:
        object:
          type: string
          const: list
        hasMore:
          type: boolean
        agents:
          type: array
          items:
            $ref: '#/components/schemas/Agent'
    Agent:
      type: object
      required:
        - object
        - id
        - name
        - enabled
        - isDefault
        - widgetPublicKey
        - attachedSourceCount
        - learningStatus
        - learnedAt
        - createdAt
        - updatedAt
      properties:
        object:
          type: string
          const: agent
        id:
          type: string
        name:
          type: string
        enabled:
          type: boolean
        isDefault:
          type: boolean
        widgetPublicKey:
          type:
            - string
            - 'null'
          description: Public widget key for this agent. This is not a REST API credential.
        attachedSourceCount:
          type: integer
          minimum: 0
          description: Number of API context sources attached to the agent.
        learningStatus:
          $ref: '#/components/schemas/AgentLearningStatus'
        learnedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      description: >-
        Public agent metadata. Prompt/config internals, learned profiles,
        attached source ids, provider details, and operator-only debug data are
        intentionally omitted.
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - code
        - error
      properties:
        code:
          type: string
        error:
          type: string
    AgentLearningStatus:
      type: string
      enum:
        - idle
        - pending
        - ready
        - failed
  responses:
    InvalidRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidRequest:
              value:
                code: invalid_request
                error: Request body is invalid.
    Unauthorized:
      description: Missing, unknown, revoked, or expired API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              value:
                code: unauthorized
                error: A valid workspace API key is required.
    InsufficientScope:
      description: API key does not include the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientScope:
              value:
                code: insufficient_scope
                error: This API key is missing the required scope.
    RateLimited:
      description: Too many API requests.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimited:
              value:
                code: rate_limited
                error: Too many API requests. Slow down and try again shortly.
    InternalError:
      description: Unexpected API failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              value:
                code: internal_error
                error: The API request could not be completed.
  securitySchemes:
    workspaceApiKey:
      type: http
      scheme: bearer
      description: >-
        Workspace API key that starts with woesk_. Paste your own key into the
        docs playground; never expose it in browser code.
      x-default: woesk_your_api_key_here

````