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

# Extract Variables

> Extract all variables from a template without validation or compilation.

Useful for:
- Analyzing templates before providing context
- Building UI autocomplete suggestions
- Determining required secrets/env vars



## OpenAPI

````yaml https://control-plane.kubiya.ai/api/openapi.json post /api/v1/templates/extract-variables
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/templates/extract-variables:
    post:
      tags:
        - templates
      summary: Extract Variables
      description: |-
        Extract all variables from a template without validation or compilation.

        Useful for:
        - Analyzing templates before providing context
        - Building UI autocomplete suggestions
        - Determining required secrets/env vars
      operationId: extract_variables_api_v1_templates_extract_variables_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplateExtractVariablesRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateExtractVariablesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TemplateExtractVariablesRequest:
      properties:
        template:
          type: string
          minLength: 1
          title: Template
          description: Template string to analyze
      type: object
      required:
        - template
      title: TemplateExtractVariablesRequest
      description: Request schema for extracting variables from a template.
      example:
        template: User {{user}} accessing {{.secret.database}} on {{.env.HOST}}
    TemplateExtractVariablesResponse:
      properties:
        variables:
          items:
            $ref: '#/components/schemas/TemplateVariableSchema'
          type: array
          title: Variables
          description: All variables found in template
        secrets:
          items:
            type: string
          type: array
          title: Secrets
          description: Secret names required
        env_vars:
          items:
            type: string
          type: array
          title: Env Vars
          description: Environment variable names required
        simple_vars:
          items:
            type: string
          type: array
          title: Simple Vars
          description: Simple variable names required
      type: object
      required:
        - variables
      title: TemplateExtractVariablesResponse
      description: Response schema for variable extraction endpoint.
      example:
        env_vars:
          - HOST
        secrets:
          - database
        simple_vars:
          - user
        variables:
          - display_name: user
            end: 13
            name: user
            raw: '{{user}}'
            start: 5
            type: simple
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TemplateVariableSchema:
      properties:
        name:
          type: string
          title: Name
          description: Variable name (e.g., 'api_key' or 'secret.github_token')
        type:
          type: string
          title: Type
          description: 'Variable type: ''simple'', ''secret'', or ''env'''
        raw:
          type: string
          title: Raw
          description: Raw template string (e.g., '{{.secret.api_key}}')
        start:
          type: integer
          title: Start
          description: Start position in template
        end:
          type: integer
          title: End
          description: End position in template
        display_name:
          type: string
          title: Display Name
          description: Display name without type prefix
      type: object
      required:
        - name
        - type
        - raw
        - start
        - end
        - display_name
      title: TemplateVariableSchema
      description: Schema for a template variable.
    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>)'

````