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

# List workers

> list workers. GET /api/v1/workers. Uses the same payload, validation, revision checks and response as the unified HTTP API.

ReferenceApplies to: Unified engine deployments

## Related guidance

[Addresses and access](https://docs.e6data.com/transformation/http/access.md) · [Request identity](https://docs.e6data.com/transformation/http/request-identity.md) · [Errors and recovery](https://docs.e6data.com/transformation/http/errors.md) · [Pagination and results](https://docs.e6data.com/transformation/http/results.md)


## OpenAPI

````yaml openapi/transformation.json GET /api/v1/workers
openapi: 3.1.0
info:
  description: >-
    HTTP contracts for the Unified engine. Requests use the connected
    deployment's access model and configured owner. Response examples are
    illustrative; inspect your engine response in your client. SQL-managed
    secrets, credentials, streaming pipelines and maintenance run through
    session operations.
  title: Laminar Unified HTTP API
  version: v1
servers:
  - url: https://engine.example.com
    description: >-
      Example engine origin. Replace it with your deployment URL and any API
      mount prefix.
security: []
paths:
  /api/v1/workers:
    get:
      tags:
        - Compute and workers
      summary: list workers
      description: >-
        list workers. GET /api/v1/workers. Uses the same payload, validation,
        revision checks and response as the unified HTTP API.
      operationId: list_workers
      parameters:
        - in: query
          name: continuation_token
          required: false
          schema:
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: >-
              Page size, bounded by the server. For query results this counts
              Arrow batches, default 1.
            minimum: 1
            type: integer
        - in: query
          name: q
          required: false
          schema:
            type: string
        - in: query
          name: state
          required: false
          schema:
            enum:
              - Requested
              - Provisioning
              - WaitingWorker
              - Idle
              - Busy
              - Releasing
              - Released
              - Failed
              - OutcomeUnknown
        - in: query
          name: workload_id
          required: false
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  continuation_token:
                    type:
                      - string
                      - 'null'
                  items:
                    items:
                      $ref: >-
                        #/components/schemas/app_api_src_service_workers_rs_WorkerView
                    type: array
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              example:
                error:
                  code: invalid_request
                  message: Check the request fields
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A rejected or failed request. Inspect error.code before retrying.
components:
  schemas:
    app_api_src_service_workers_rs_WorkerView:
      allOf:
        - $ref: >-
            #/components/schemas/kernel_controller_src_workers_inventory_rs_WorkerDetails
        - properties:
            workload_kind:
              anyOf:
                - $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadKind'
                - type: 'null'
          required:
            - workload_kind
          type: object
    ApiError:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
    kernel_controller_src_workers_inventory_rs_WorkerDetails:
      allOf:
        - $ref: >-
            #/components/schemas/kernel_controller_src_workers_inventory_rs_WorkerRecord
        - properties:
            allocation:
              anyOf:
                - $ref: >-
                    #/components/schemas/kernel_provisioner_core_src_models_rs_AllocationDetails
                - type: 'null'
            connected:
              anyOf:
                - type: boolean
                - type: 'null'
            metadata_available:
              type: boolean
          required:
            - connected
            - allocation
            - metadata_available
          type: object
    shared_common_src_lib_rs_WorkloadKind:
      oneOf:
        - const: Standalone
          type: string
        - const: Streaming
          type: string
        - const: SessionOperation
          type: string
    kernel_controller_src_workers_inventory_rs_WorkerRecord:
      properties:
        allocation_id:
          $ref: '#/components/schemas/shared_common_src_lib_rs_AllocationId'
        allocation_status:
          $ref: >-
            #/components/schemas/kernel_provisioner_core_src_models_rs_AllocationStatus
        compute_requirements:
          $ref: '#/components/schemas/shared_common_src_lib_rs_ComputeRequirements'
        created_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        current_task:
          anyOf:
            - $ref: >-
                #/components/schemas/kernel_controller_src_workers_inventory_rs_WorkerTaskRecord
            - type: 'null'
        deployment_profile:
          anyOf:
            - type: string
            - type: 'null'
        execution_target:
          $ref: '#/components/schemas/shared_common_src_lib_rs_ExecutionTarget'
        last_seen_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        ready:
          type: boolean
        ready_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        registered_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        released_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        required_features:
          items:
            type: string
          type: array
        state:
          type: string
        supported_features:
          items:
            type: string
          type: array
        task_count:
          minimum: 0
          type: integer
        worker_id:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_WorkerId'
            - type: 'null'
        worker_scope:
          $ref: '#/components/schemas/shared_common_src_lib_rs_WorkerScope'
        workload_id:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadId'
            - type: 'null'
        workload_run_id:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadRunId'
            - type: 'null'
      required:
        - allocation_id
        - worker_id
        - workload_id
        - workload_run_id
        - deployment_profile
        - worker_scope
        - execution_target
        - compute_requirements
        - required_features
        - supported_features
        - allocation_status
        - state
        - created_at
        - registered_at
        - ready_at
        - ready
        - last_seen_at
        - released_at
        - task_count
        - current_task
      type: object
    kernel_provisioner_core_src_models_rs_AllocationDetails:
      properties:
        allocation_id:
          $ref: '#/components/schemas/shared_common_src_lib_rs_AllocationId'
        compute_requirements:
          $ref: '#/components/schemas/shared_common_src_lib_rs_ComputeRequirements'
        created_at:
          $ref: '#/components/schemas/shared_common_src_time_rs_WallClockTimestamp'
        failure:
          anyOf:
            - type: string
            - type: 'null'
        launch_started_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        lifecycle:
          items:
            $ref: >-
              #/components/schemas/kernel_provisioner_core_src_models_rs_AllocationLifecycleEvent
          type: array
        profile:
          anyOf:
            - type: string
            - type: 'null'
        provider:
          type: string
        provider_resource_id:
          anyOf:
            - type: string
            - type: 'null'
        provisioner:
          anyOf:
            - type: string
            - type: 'null'
        release_requested_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        resource_metadata:
          additionalProperties:
            type: string
          type: object
        startup:
          $ref: >-
            #/components/schemas/kernel_provisioner_core_src_startup_rs_StartupProgress
        startup_window:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_execution_startup_rs_WorkerStartupWindow
            - type: 'null'
        status:
          $ref: >-
            #/components/schemas/kernel_provisioner_core_src_models_rs_AllocationStatus
        updated_at:
          $ref: '#/components/schemas/shared_common_src_time_rs_WallClockTimestamp'
      required:
        - startup
        - startup_window
        - provisioner
        - profile
        - allocation_id
        - provider
        - provider_resource_id
        - resource_metadata
        - compute_requirements
        - status
        - failure
        - created_at
        - updated_at
        - launch_started_at
        - release_requested_at
        - lifecycle
      type: object
    shared_common_src_lib_rs_AllocationId:
      format: uuid
      type: string
    kernel_provisioner_core_src_models_rs_AllocationStatus:
      oneOf:
        - const: Requested
          type: string
        - const: Provisioning
          type: string
        - const: Provisioned
          type: string
        - const: Failed
          type: string
        - const: ReleaseRequested
          type: string
        - const: Releasing
          type: string
        - const: Released
          type: string
        - const: OutcomeUnknown
          type: string
    shared_common_src_lib_rs_ComputeRequirements:
      properties:
        cpu_millicores:
          minimum: 1
          type: integer
        memory_bytes:
          minimum: 1
          type: integer
        tuning:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_compute_rs_ComputeTuning'
            - type: 'null'
      required:
        - cpu_millicores
        - memory_bytes
      type: object
    shared_common_src_time_rs_WallClockTimestamp:
      properties:
        unix_millis:
          type: integer
      required:
        - unix_millis
      type: object
    kernel_controller_src_workers_inventory_rs_WorkerTaskRecord:
      properties:
        assignment_id:
          description: >-
            Serialized AssignmentId; provider-specific fields retain their
            original JSON representation.
          x-rust-type: AssignmentId
        attempt_number:
          minimum: 1
          type: integer
        created_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        failure:
          anyOf:
            - type: string
            - type: 'null'
        finished_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        name:
          type: string
        started_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        status:
          $ref: >-
            #/components/schemas/kernel_controller_src_attempts_model_rs_TaskRunStatus
        task_attempt_id:
          $ref: '#/components/schemas/shared_common_src_lib_rs_TaskAttemptId'
        task_run_id:
          $ref: '#/components/schemas/shared_common_src_lib_rs_TaskRunId'
        worker_status:
          anyOf:
            - description: >-
                Serialized TaskExecutionStatus; provider-specific fields retain
                their original JSON representation.
              x-rust-type: TaskExecutionStatus
            - type: 'null'
        workload_id:
          $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadId'
        workload_run_id:
          $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadRunId'
      required:
        - workload_id
        - workload_run_id
        - task_run_id
        - task_attempt_id
        - assignment_id
        - name
        - attempt_number
        - status
        - worker_status
        - created_at
        - started_at
        - finished_at
        - failure
      type: object
    shared_common_src_lib_rs_ExecutionTarget:
      oneOf:
        - const: DataFusion
          type: string
        - const: DuckDb
          type: string
    shared_common_src_lib_rs_WorkerId:
      format: uuid
      type: string
    shared_common_src_lib_rs_WorkerScope:
      oneOf:
        - const: Task
          type: string
        - const: Workload
          type: string
        - const: Deployment
          type: string
    shared_common_src_lib_rs_WorkloadId:
      format: uuid
      type: string
    shared_common_src_lib_rs_WorkloadRunId:
      format: uuid
      type: string
    kernel_provisioner_core_src_models_rs_AllocationLifecycleEvent:
      properties:
        at:
          $ref: '#/components/schemas/shared_common_src_time_rs_WallClockTimestamp'
        failure:
          anyOf:
            - type: string
            - type: 'null'
        status:
          $ref: >-
            #/components/schemas/kernel_provisioner_core_src_models_rs_AllocationStatus
      required:
        - status
        - at
        - failure
      type: object
    kernel_provisioner_core_src_startup_rs_StartupProgress:
      properties:
        attempts:
          minimum: 0
          type: integer
        exhausted:
          type: boolean
        last_error:
          anyOf:
            - type: string
            - type: 'null'
        retry_at_millis:
          anyOf:
            - type: integer
            - type: 'null'
      required:
        - attempts
        - retry_at_millis
        - last_error
        - exhausted
      type: object
    shared_common_src_execution_startup_rs_WorkerStartupWindow:
      properties:
        deadline_millis:
          type: integer
        policy:
          $ref: >-
            #/components/schemas/shared_common_src_execution_startup_rs_WorkerStartupPolicy
        started_at_millis:
          type: integer
      required:
        - policy
        - started_at_millis
        - deadline_millis
      type: object
    shared_common_src_compute_rs_ComputeTuning:
      properties:
        batch_rows:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        file_read_concurrency:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        input_prefetch_batches:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        native_parquet_scan:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            False always uses connector-produced Arrow batches. Omitted keeps
            the native Parquet capability enabled when the source can supply it
            safely.
        output_buffer_batches:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        query_memory_bytes:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        spill_bytes:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: >-
            Zero disables disk spill. The directory is controlled by the
            deployment.
        threads:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        write_batch_rows:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        write_parallelism:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
      required:
        - threads
        - query_memory_bytes
        - batch_rows
        - write_batch_rows
        - write_parallelism
        - spill_bytes
        - output_buffer_batches
        - file_read_concurrency
        - input_prefetch_batches
      type: object
    kernel_controller_src_attempts_model_rs_TaskRunStatus:
      oneOf:
        - const: Cancelling
          type: string
        - const: Cancelled
          type: string
        - const: Pending
          type: string
        - const: Planning
          type: string
        - const: Queued
          type: string
        - const: Provisioning
          type: string
        - const: WaitingWorker
          type: string
        - const: Running
          type: string
        - const: Committing
          type: string
        - const: WaitingRetry
          type: string
        - const: Succeeded
          type: string
        - const: Failed
          type: string
        - const: Skipped
          type: string
        - const: OutcomeUnknown
          type: string
    shared_common_src_lib_rs_TaskAttemptId:
      format: uuid
      type: string
    shared_common_src_lib_rs_TaskRunId:
      format: uuid
      type: string
    shared_common_src_execution_startup_rs_WorkerStartupPolicy:
      properties:
        max_attempts:
          minimum: 1
          type: integer
        retry_delay_seconds:
          minimum: 1
          type: integer
        retry_multiplier:
          minimum: 1
          type: integer
        timeout_seconds:
          minimum: 1
          type: integer
      required:
        - max_attempts
        - retry_delay_seconds
        - retry_multiplier
        - timeout_seconds
      type: object

````

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