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

# List workers

> Lists the workers that are connected and keep their lease, ordered by id, with the pools they serve, the plugin types they may run, their capacity and the slots in use at their last heartbeat



## OpenAPI

````yaml /api/openapi.json get /api/workers
openapi: 3.1.0
info:
  title: Yukta REST API
  version: 0.0.1-SNAPSHOT
  description: >-
    Create sessions and workflows, start and steer executions, and read their
    status, logs and results. Pre-beta: paths and schemas may change before
    v0.1.0.
servers:
  - url: http://localhost:8080
    description: Local server (default address)
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Supervisors API
    description: Supervisors and control planes on the control bus
  - name: Workflow Versions API
    description: List the saved versions and roll back
  - name: Workflow API
    description: Endpoints for starting workflows and listing their executions
  - name: Execution API
    description: Stop, restart and observe workflow executions
  - name: Execution Search API
    description: Find runs across sessions
  - name: Control Bus & Observability API
    description: >-
      Endpoints for control bus operations, node management, and execution
      observability
  - name: Execution Control API
    description: Pause, resume, step and stop nodes
  - name: Session API
    description: Endpoints for session and workflow discovery, configuration management
  - name: Session API
    description: Validate a draft workflow without saving it
  - name: Workers API
    description: Workers connected to the control plane
  - name: Events API
    description: Live feed of execution events
  - name: Workflow Details API
    description: Workflow DAG graph with plugin metadata and per-workflow execution history
  - name: Execution Results API
    description: Follow the result of an execution
  - name: Execution Logs API
    description: Stream execution logs
  - name: Control audit API
    description: Control commands and who sent them
  - name: Plugin API
    description: Endpoints for discovering workflow plugins
paths:
  /api/workers:
    get:
      tags:
        - Workers API
      summary: List workers
      description: >-
        Lists the workers that are connected and keep their lease, ordered by
        id, with the pools they serve, the plugin types they may run, their
        capacity and the slots in use at their last heartbeat
      operationId: list
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiResponseListWorkerInfo'
components:
  schemas:
    ApiResponseListWorkerInfo:
      type: object
      description: >-
        Unified API response wrapper for both success and error responses.
        Success responses include data field; error responses include error,
        path, and errors fields.
      properties:
        timestamp:
          type: string
          format: date-time
          description: The time the response was generated
        status:
          type: integer
          format: int32
          description: The HTTP status code
          example: 200
        message:
          type: string
          description: A human-readable message
          example: Operation successful
        data:
          type: array
          description: The response data
          items:
            $ref: '#/components/schemas/WorkerInfo'
        error:
          type: string
          description: The HTTP status error name
          example: Bad Request
        path:
          type: string
          description: The request path
          example: /api/files
        errors:
          type: array
          description: The list of field validation errors
          items:
            $ref: '#/components/schemas/FieldError'
    WorkerInfo:
      type: object
      properties:
        workerId:
          type: string
        pools:
          type: array
          items:
            type: string
          uniqueItems: true
        pluginTypes:
          type: array
          items:
            type: string
          uniqueItems: true
        capacity:
          type: integer
          format: int32
        usedSlots:
          type: integer
          format: int32
        draining:
          type: boolean
        registeredAt:
          type: string
          format: date-time
        leaseUntil:
          type: string
          format: date-time
    FieldError:
      type: object
      description: Field-specific validation error detail
      properties:
        field:
          type: string
          description: The name of the field that failed validation
          example: sessionId
        message:
          type: string
          description: The validation error message explaining the failure
          example: 'Session not found: ''unknown-session'''
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key sent as `Authorization: Bearer <key>`. Needed only when the
        server has a key configured.
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: The same API key sent as `X-API-Key`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.