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

# Promote an agent prompt version

> Make a saved version the agent's live configuration — the rollback action. Copies the version's prompt, model, settings, and cost cap back onto the agent, bumps the agent's version counter, and mints a fresh forward-only history row so the audit timeline stays monotonic. When a pinned eval suite or red-team safety gate is configured, the candidate is scored first and the promote is refused with 422 on a regression. If separation-of-duties approval is enabled, the author cannot promote their own version (403). Requires an owner, admin, or developer role.



## OpenAPI

````yaml /openapi.yaml post /api/v1/agents/{id}/versions/{vid}/promote
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/agents/{id}/versions/{vid}/promote:
    post:
      tags:
        - Agents
      summary: Promote an agent prompt version
      description: >-
        Make a saved version the agent's live configuration — the rollback
        action. Copies the version's prompt, model, settings, and cost cap back
        onto the agent, bumps the agent's version counter, and mints a fresh
        forward-only history row so the audit timeline stays monotonic. When a
        pinned eval suite or red-team safety gate is configured, the candidate
        is scored first and the promote is refused with 422 on a regression. If
        separation-of-duties approval is enabled, the author cannot promote
        their own version (403). Requires an owner, admin, or developer role.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
          description: Identifier of the agent to promote a version for.
        - schema:
            type: string
          in: path
          name: vid
          required: true
          description: Identifier of the version to make live.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                confirm:
                  type: boolean
                  default: false
                  description: >-
                    Records whether the operator confirmed the promotion in the
                    UI diff dialog.
                note:
                  type: string
                  maxLength: 1000
                  description: Optional note describing why the version was promoted.
            example:
              confirm: true
              note: Rolling back the refund-policy regression
      responses:
        '200':
          description: The version was promoted and a new live version minted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      agent_id:
                        type: string
                      promoted_from_version_id:
                        type: string
                      promoted_from_version_number:
                        type: integer
                      new_version:
                        $ref: '#/components/schemas/AgentPromptVersion'
                      promotion_gate:
                        type: object
                        nullable: true
                        additionalProperties: true
                        description: >-
                          Eval-suite gate report when the regression gate ran,
                          else null.
                      red_team_gate:
                        type: object
                        nullable: true
                        additionalProperties: true
                        description: >-
                          Red-team safety gate report when the safety gate ran,
                          else null.
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
components:
  schemas:
    AgentPromptVersion:
      type: object
      description: >-
        An immutable checkpoint of an agent's versioned configuration, minted on
        save, promote, or branch. Captures the prompt, model, and settings
        snapshot for a single version so it can be diffed or restored later.
      additionalProperties: true
      properties:
        id:
          type: string
        agent_id:
          type: string
        version_number:
          type: integer
        system_prompt:
          type: string
          nullable: true
        model:
          type: string
        temperature:
          type: number
          nullable: true
        max_tokens:
          type: integer
          nullable: true
        tools:
          type: array
          items:
            type: object
            additionalProperties: true
        knowledge_base_ids:
          type: array
          nullable: true
          items:
            type: string
        safety_config:
          type: object
          nullable: true
          additionalProperties: true
        config:
          type: object
          nullable: true
          additionalProperties: true
        max_cost_per_conversation_cents:
          type: integer
          nullable: true
          description: Per-conversation LLM spend cap in cents, or null when uncapped.
        branch:
          type: string
          nullable: true
          description: Experiment-line label when the version is on a branch, else null.
        label:
          type: string
          nullable: true
          description: Optional operator bookmark on this version.
        parent_version_id:
          type: string
          nullable: true
        created_by_user_id:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````