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

# Create new version of agent

> Create a new version of an existing agent definition by providing updated agent properties and a commit message.



## OpenAPI

````yaml /openapi.json post /simulate/agent-definitions/{agent_id}/versions/create/
openapi: 3.0.0
info:
  title: FutureAGI Unified API
  version: 1.0.0
  description: >-
    Complete API documentation for FutureAGI platform - Simulate module
    (scenario management, agent definitions, test executions, call analytics)
    and Model Hub Evaluations API (evaluation templates, playgrounds, metrics,
    and execution tracking)
  contact:
    email: support@futureagi.com
servers:
  - url: https://api.futureagi.com
    description: Production API
security: []
tags:
  - name: Health
    description: Health check operations for monitoring server status
  - name: Authentication
    description: User authentication and token management
  - name: Scenarios
    description: Test scenario management and execution
  - name: Agent Definitions
    description: Agent definition CRUD operations
  - name: Agent Versions
    description: Agent version control and management
  - name: Simulator Agents
    description: Simulator agent operations
  - name: Run Tests
    description: Test execution management
  - name: Test Executions
    description: Test execution tracking and analytics
  - name: Call Executions
    description: Individual call execution details
  - name: Call Transcripts
    description: Transcript management and retrieval
  - name: Personas
    description: Persona management for testing
  - name: Analytics
    description: Analytics and reporting
  - name: Export Simulate
    description: Data export operations
  - name: Datasets
    description: >-
      Operations related to datasets, including creation, modification, and data
      management.
  - name: Eval Groups
    description: Evaluation group management
  - name: Eval Templates
    description: Base evaluation template operations
  - name: Custom Eval Templates
    description: Custom evaluation template CRUD operations
  - name: Eval Playground
    description: Test and run evaluations in playground environment
  - name: Eval Logs & Metrics
    description: Evaluation logs, metrics, and execution tracking
  - name: Eval Configuration
    description: Evaluation configuration and templates retrieval
  - name: API Keys
    description: API key management
  - name: Prompt Workbench
    description: Prompt template version labeling and lookup by name, version, or label
paths:
  /simulate/agent-definitions/{agent_id}/versions/create/:
    post:
      tags:
        - Agent Versions
      summary: Create new version of agent
      description: >-
        Create a new version of an existing agent definition by providing
        updated agent properties and a commit message.
      operationId: createAgentVersion
      parameters:
        - name: agent_id
          in: path
          required: true
          description: A UUID string identifying the agent definition.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                agent_type:
                  type: string
                  enum:
                    - voice
                    - text
                  description: Type of the agent.
                agent_name:
                  type: string
                  description: Name of the agent.
                provider:
                  type: string
                  description: Provider for the agent (e.g., vapi, retell).
                api_key:
                  type: string
                  format: uuid
                  description: API key for the agent provider.
                assistant_id:
                  type: string
                  description: External identifier for the assistant.
                description:
                  type: string
                  description: New description for the agent.
                language:
                  type: string
                  description: >-
                    Language of the agent (ISO 639-1 code). For example, en for
                    English.
                knowledge_base:
                  type: string
                  format: uuid
                  nullable: true
                  description: ID of the knowledge base to associate with the agent.
                contact_number:
                  type: string
                  description: >-
                    Contact number for the agent including country code. For
                    example, +1xxxxxxxxxx for USA, +91xxxxxxxxxx for India, etc.
                inbound:
                  type: boolean
                  description: Specifies if the agent handles inbound communication.
                commit_message:
                  type: string
                  description: Commit message for this new version.
                observability_enabled:
                  type: boolean
                  description: Enable or disable observability for the agent.
            examples:
              example-1:
                summary: Example payload for creating a new agent version
                value:
                  agent_type: voice
                  agent_name: test-agiii
                  provider: vapi
                  api_key: <api_key>
                  assistant_id: <assistant_id>
                  description: <description>
                  language: en
                  knowledge_base: null
                  contact_number: <contact_number>
                  inbound: true
                  commit_message: <commit_message>
                  observability_enabled: true
      responses:
        '201':
          description: Agent version created successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Agent version created successfully
                  version:
                    $ref: '#/components/schemas/AgentVersion'
        '400':
          description: Invalid data for agent update.
        '401':
          description: Authentication credentials were not provided.
        '404':
          description: Agent definition not found.
        '500':
          description: Internal server error.
      security:
        - ApiKeyAuth: []
          SecretKeyAuth: []
components:
  schemas:
    AgentVersion:
      type: object
      properties:
        id:
          type: string
          format: uuid
        version_number:
          type: integer
        version_name:
          type: string
          nullable: true
        version_name_display:
          type: string
        status:
          type: string
        status_display:
          type: string
        score:
          type: number
          nullable: true
        test_count:
          type: integer
        pass_rate:
          type: number
          nullable: true
        description:
          type: string
        commit_message:
          type: string
        release_notes:
          type: string
          nullable: true
        agent_definition:
          type: string
          format: uuid
        organization:
          type: string
          format: uuid
        configuration_snapshot:
          type: object
        is_active:
          type: boolean
        is_latest:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        API Key for authentication. Click
        [here](https://app.futureagi.com/dashboard/keys) to access API Key
    SecretKeyAuth:
      type: apiKey
      in: header
      name: X-Secret-Key
      description: >-
        Secret Key for authentication. Click
        [here](https://app.futureagi.com/dashboard/keys) to access Secret Key

````