---
title: "List Workers"
method: GET
path: "/v1/workers"
tags: ["Workers"]
---

# List Workers

`GET /v1/workers`

Returns a list of all registered workers in the runtime. Workers are configurable processing units that can perform tasks like load balancing between models or implementing fallback strategies.

## Query parameters

- `format` 'json' | 'csv'

## Response `200`

List of workers in JSON format

- WorkerListResponse — Response wrapper for the `/v1/workers` endpoint.
  - `data` WorkerInfo[], required — The list of workers
    - `description` string, nullable — A description of what the worker does
    - `is_llm` boolean, required — Whether this worker can be used as an LLM model
    - `name` string, required — The name of the worker
    - `status` union — Represents the status of a component (e.g. dataset, model, etc). The `Error` variant optionally carries a human-readable error message describing what caused the component to enter the error state. Use [`ComponentStatus::error`] for an error without a message, or [`ComponentStatus::error_with_message`] to include one.
      - 'Initializing' — The component is initializing and not yet ready
      - 'Ready' — The component is ready to accept connections
      - 'Disabled' — The component is disabled and not running
      - object — An error occurred in the component, with an optional error message
        - `Error` string, nullable, required — An error occurred in the component, with an optional error message
      - 'Refreshing' — The component is in the process of refreshing its state
      - 'ShuttingDown' — The component is in the process of shutting down
      - 'NotLoaded' — The component is configured but not loaded yet
  - `object` string, required — The type of the response (always `list`)

## Other responses

- `500` — Internal server error occurred while processing workers

## Changes

> 53 revisions in range; 26 could not be searched.

- **2025-03-18** `dd94571fef79` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/spiceai/apis/runtime/changes/v1/workers/get.md)

---

[API](https://skmtc.dev/spiceai/apis/runtime.md) · [All operations](https://skmtc.dev/spiceai/apis/runtime/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/spiceai/runtime/revisions/fb597a4eaa56/schema)
