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

# Create deployment



## OpenAPI

````yaml /reference/openapi.yaml post /api/v1/deployments
openapi: 3.1.0
info:
  title: ConverSimple public HTTP contracts
  version: '2026-10-02'
  description: >-
    Current management routes and the deferred Existing Concierge Voice
    callback. The transcript hook is configured by the customer and described
    under webhooks.
servers:
  - url: https://app.conversimple.com
    description: Production app
security: []
tags:
  - name: Agents
  - name: Deployments
  - name: API keys
  - name: Existing concierge voice
paths:
  /api/v1/deployments:
    post:
      tags:
        - Deployments
      summary: Create deployment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentCreate'
      responses:
        '201':
          description: Created deployment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentResponse'
      security:
        - customerKey: []
components:
  schemas:
    DeploymentCreate:
      type: object
      required:
        - agent_id
      properties:
        agent_id:
          type: string
          format: uuid
        environment:
          type: string
          description: Defaults to widget
        call_direction:
          type: string
        channel_config:
          type: object
          additionalProperties: true
        engagement_rules:
          type: object
          additionalProperties: true
    DeploymentResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/Deployment'
    Deployment:
      type: object
      required:
        - id
        - agent_id
        - environment
        - status
      properties:
        id:
          type: string
          format: uuid
        agent_id:
          type: string
          format: uuid
        agent_name:
          type:
            - string
            - 'null'
        environment:
          type: string
        status:
          type: string
        call_direction:
          type:
            - string
            - 'null'
        engagement_rules:
          type: object
          additionalProperties: true
        channel_config:
          type: object
          additionalProperties: true
        runtime_config:
          type: object
          additionalProperties: true
        deployed_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    customerKey:
      type: http
      scheme: bearer
      description: Customer API key from Settings → API

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.