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

# Start Worker For Queue

> Start a worker for a specific queue.

This endpoint is called by the CLI with: kubiya worker start --queue-id={queue_id}

Returns all configuration needed for the worker to connect to Temporal.



## OpenAPI

````yaml https://control-plane.kubiya.ai/api/openapi.json post /api/v1/worker-queues/{queue_id}/start
openapi: 3.1.0
info:
  title: Agent Control Plane API
  description: Multi-tenant agent orchestration with Temporal workflows
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
tags:
  - name: health
    description: 🏥 **Health & Status** - Check API health and availability
  - name: authentication
    description: 🔐 **Authentication** - Token validation and auth management
  - name: agents
    description: 🤖 **Agents** - Create and manage AI agents with custom capabilities
  - name: skills
    description: 🛠️ **Tool Sets** - Manage agent skills and tool configurations
  - name: integrations
    description: 🔌 **Integrations** - Connect to external services (Kubiya managed)
  - name: custom-integrations
    description: >-
      ⚙️ **Custom Integrations** - User-defined integration instances with env
      vars, secrets, and files
  - name: integration-templates
    description: >-
      📦 **Integration Templates** - Pre-configured templates for common
      services (PostgreSQL, Redis, MongoDB, etc.)
  - name: secrets
    description: 🔑 **Secrets** - Secure credential storage and retrieval
  - name: teams
    description: 👥 **Teams** - Team management and collaboration
  - name: workflows
    description: 📊 **Workflows** - Multi-step automation and orchestration
  - name: executions
    description: ▶️ **Executions** - Track and monitor workflow runs
  - name: jobs
    description: ⏰ **Jobs** - Scheduled and webhook-triggered tasks
  - name: policies
    description: 🛡️ **Policies** - Access control and security policies
  - name: analytics
    description: 📈 **Analytics** - Usage metrics and performance monitoring
  - name: projects
    description: 📁 **Projects** - Project organization and management
  - name: environments
    description: 🌍 **Environments** - Environment configuration (dev, staging, prod)
  - name: models
    description: 🧠 **Models** - LLM model configuration and management
  - name: runtimes
    description: ⚡ **Runtimes** - Agent execution runtime environments
  - name: workers
    description: 👷 **Workers** - Worker registration and heartbeat monitoring
  - name: storage
    description: 💾 **Storage** - File storage and cloud integration
  - name: context-graph
    description: 🕸️ **Context Graph** - Knowledge graph and context management
  - name: temporal-workflows
    description: >-
      ⚙️ **Temporal Workflows** - Background workflows for context graph
      ingestion, connector operations, and scheduled jobs
  - name: templates
    description: 📝 **Templates** - Reusable configuration templates
paths:
  /api/v1/worker-queues/{queue_id}/start:
    post:
      summary: Start Worker For Queue
      description: >-
        Start a worker for a specific queue.


        This endpoint is called by the CLI with: kubiya worker start
        --queue-id={queue_id}


        Returns all configuration needed for the worker to connect to Temporal.
      operationId: start_worker_for_queue_api_v1_worker_queues__queue_id__start_post
      parameters:
        - name: queue_id
          in: path
          required: true
          schema:
            type: string
            title: Queue Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/control_plane_api__app__routers__worker_queues__WorkerStartRequest
              default: {}
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkerStartResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    control_plane_api__app__routers__worker_queues__WorkerStartRequest:
      properties:
        worker_sdk_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Worker Sdk Version
        system_info:
          anyOf:
            - $ref: '#/components/schemas/WorkerSystemInfo'
            - type: 'null'
        control_plane_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Control Plane Url
      type: object
      title: WorkerStartRequest
      description: Worker start request with SDK version and system info
    WorkerStartResponse:
      properties:
        worker_id:
          type: string
          title: Worker Id
        task_queue_name:
          type: string
          title: Task Queue Name
        temporal_namespace:
          type: string
          title: Temporal Namespace
        temporal_host:
          type: string
          title: Temporal Host
        temporal_api_key:
          type: string
          title: Temporal Api Key
        organization_id:
          type: string
          title: Organization Id
        control_plane_url:
          type: string
          title: Control Plane Url
        heartbeat_interval:
          type: integer
          title: Heartbeat Interval
        litellm_api_url:
          type: string
          title: Litellm Api Url
        litellm_api_key:
          type: string
          title: Litellm Api Key
        queue_name:
          type: string
          title: Queue Name
        environment_name:
          type: string
          title: Environment Name
        queue_id:
          type: string
          title: Queue Id
        queue_ephemeral:
          type: boolean
          title: Queue Ephemeral
          default: false
        queue_single_execution:
          type: boolean
          title: Queue Single Execution
          default: false
        redis_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Redis Url
        redis_password:
          anyOf:
            - type: string
            - type: 'null'
          title: Redis Password
        redis_enabled:
          type: boolean
          title: Redis Enabled
          default: false
        websocket_enabled:
          type: boolean
          title: Websocket Enabled
          default: true
        websocket_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Websocket Url
        websocket_features:
          items:
            type: string
          type: array
          title: Websocket Features
        nats_config:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Nats Config
        control_plane_sdk_version:
          type: string
          title: Control Plane Sdk Version
      type: object
      required:
        - worker_id
        - task_queue_name
        - temporal_namespace
        - temporal_host
        - temporal_api_key
        - organization_id
        - control_plane_url
        - heartbeat_interval
        - litellm_api_url
        - litellm_api_key
        - queue_name
        - environment_name
        - queue_id
        - control_plane_sdk_version
      title: WorkerStartResponse
      description: Worker start configuration
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WorkerSystemInfo:
      properties:
        hostname:
          anyOf:
            - type: string
            - type: 'null'
          title: Hostname
        platform:
          anyOf:
            - type: string
            - type: 'null'
          title: Platform
        os_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Os Name
        os_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Os Version
        python_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Python Version
        cli_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Cli Version
        sdk_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Sdk Version
        pid:
          anyOf:
            - type: integer
            - type: 'null'
          title: Pid
        cwd:
          anyOf:
            - type: string
            - type: 'null'
          title: Cwd
        supported_runtimes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Supported Runtimes
        llm_gateway_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Llm Gateway Url
        docker_available:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Docker Available
        docker_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Docker Version
        cpu_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cpu Count
        cpu_percent:
          anyOf:
            - type: number
            - type: 'null'
          title: Cpu Percent
        memory_total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Memory Total
        memory_used:
          anyOf:
            - type: integer
            - type: 'null'
          title: Memory Used
        memory_percent:
          anyOf:
            - type: number
            - type: 'null'
          title: Memory Percent
        disk_total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Disk Total
        disk_used:
          anyOf:
            - type: integer
            - type: 'null'
          title: Disk Used
        disk_percent:
          anyOf:
            - type: number
            - type: 'null'
          title: Disk Percent
        uptime_seconds:
          anyOf:
            - type: number
            - type: 'null'
          title: Uptime Seconds
      type: object
      title: WorkerSystemInfo
      description: Worker system information
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Enter your Kubiya API token (format: Bearer <token>)'

````