> ## 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.

# Worker capacity

> worker capacity. GET /api/v1/workers/capacity. 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/capacity
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/capacity:
    get:
      tags:
        - Compute and workers
      summary: worker capacity
      description: >-
        worker capacity. GET /api/v1/workers/capacity. Uses the same payload,
        validation, revision checks and response as the unified HTTP API.
      operationId: worker_capacity
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/kernel_controller_src_pools_status_rs_ComputeStatus
          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:
    kernel_controller_src_pools_status_rs_ComputeStatus:
      properties:
        admission:
          $ref: >-
            #/components/schemas/kernel_controller_src_admission_mod_rs_AdmissionStatus
        profiles:
          items:
            $ref: >-
              #/components/schemas/kernel_controller_src_pools_status_rs_PoolStatus
          type: array
      required:
        - admission
        - profiles
      type: object
    ApiError:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
    kernel_controller_src_admission_mod_rs_AdmissionStatus:
      properties:
        draining:
          type: boolean
        limit:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        unfinished_tasks:
          minimum: 0
          type: integer
      required:
        - draining
        - unfinished_tasks
        - limit
      type: object
    kernel_controller_src_pools_status_rs_PoolStatus:
      properties:
        busy:
          minimum: 0
          type: integer
        draining:
          minimum: 0
          type: integer
        failures:
          items:
            $ref: >-
              #/components/schemas/kernel_controller_src_pools_status_rs_PoolFailure
          type: array
        idle:
          minimum: 0
          type: integer
        is_default:
          type: boolean
        name:
          type: string
        paused:
          type: boolean
        previous_resources_workers:
          minimum: 0
          type: integer
        provisioner:
          type: string
        queued:
          minimum: 0
          type: integer
        recovering:
          minimum: 0
          type: integer
        resources:
          $ref: '#/components/schemas/shared_common_src_lib_rs_ComputeRequirements'
        revision:
          minimum: 0
          type: integer
        sizing:
          $ref: >-
            #/components/schemas/shared_common_src_execution_pools_rs_DeploymentPoolSizing
        starting:
          minimum: 0
          type: integer
      required:
        - name
        - revision
        - provisioner
        - resources
        - previous_resources_workers
        - sizing
        - queued
        - busy
        - idle
        - starting
        - recovering
        - draining
        - failures
        - paused
        - is_default
      type: object
    kernel_controller_src_pools_status_rs_PoolFailure:
      properties:
        allocation_id:
          $ref: '#/components/schemas/shared_common_src_lib_rs_AllocationId'
        message:
          anyOf:
            - type: string
            - type: 'null'
        retry_allowed:
          type: boolean
      required:
        - allocation_id
        - message
        - retry_allowed
      type: object
    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_execution_pools_rs_DeploymentPoolSizing:
      oneOf:
        - allOf:
            - properties:
                mode:
                  const: fixed
              required:
                - mode
              type: object
            - properties:
                workers:
                  minimum: 0
                  type: integer
              required:
                - workers
              type: object
        - allOf:
            - properties:
                mode:
                  const: autoscaling
              required:
                - mode
              type: object
            - properties:
                idle_timeout_seconds:
                  minimum: 1
                  type: integer
                max_workers:
                  minimum: 1
                  type: integer
                min_workers:
                  minimum: 0
                  type: integer
              required:
                - min_workers
                - max_workers
                - idle_timeout_seconds
              type: object
    shared_common_src_lib_rs_AllocationId:
      format: uuid
      type: string
    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

````

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