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

# Get Runtime Requirements

> Get detailed requirements for a specific runtime.

Returns model compatibility requirements, required configuration fields,
and other validation rules for the specified runtime.



## OpenAPI

````yaml https://control-plane.kubiya.ai/api/openapi.json get /api/v1/runtimes/{runtime_id}/requirements
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/runtimes/{runtime_id}/requirements:
    get:
      tags:
        - Runtimes
      summary: Get Runtime Requirements
      description: |-
        Get detailed requirements for a specific runtime.

        Returns model compatibility requirements, required configuration fields,
        and other validation rules for the specified runtime.
      operationId: get_runtime_requirements_api_v1_runtimes__runtime_id__requirements_get
      parameters:
        - name: runtime_id
          in: path
          required: true
          schema:
            type: string
            title: Runtime Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeRequirementsInfo'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    RuntimeRequirementsInfo:
      properties:
        model_requirement:
          $ref: '#/components/schemas/ModelRequirementInfo'
        required_config_fields:
          items:
            type: string
          type: array
          title: Required Config Fields
        recommended_config_fields:
          items:
            type: string
          type: array
          title: Recommended Config Fields
        max_history_length:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max History Length
        requires_system_prompt:
          type: boolean
          title: Requires System Prompt
          default: false
        requires_tools:
          type: boolean
          title: Requires Tools
          default: false
      type: object
      required:
        - model_requirement
      title: RuntimeRequirementsInfo
      description: Requirements specification for a runtime
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ModelRequirementInfo:
      properties:
        description:
          type: string
          title: Description
          description: Human-readable description
        supported_providers:
          items:
            type: string
          type: array
          title: Supported Providers
          description: Supported model providers
        supported_families:
          items:
            type: string
          type: array
          title: Supported Families
          description: Supported model families
        examples:
          items:
            type: string
          type: array
          title: Examples
          description: Example valid model IDs
      type: object
      required:
        - description
        - supported_providers
        - supported_families
        - examples
      title: ModelRequirementInfo
      description: Model requirements for a runtime
    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>)'

````