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

# Create a room-config template

> Save a new reusable room-config template for the calling tenant. Owner/admin/developer only; scoped on video:write. Template names must be unique within the tenant (case-insensitive) and the library is capped at 100 templates per tenant. The config preset carries only non-secret room knobs — recording-storage credentials and consent receipts are never persisted on a template.



## OpenAPI

````yaml /openapi.yaml post /api/v1/video/room-templates
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
paths:
  /api/v1/video/room-templates:
    post:
      tags:
        - Video
      summary: Create a room-config template
      description: >-
        Save a new reusable room-config template for the calling tenant.
        Owner/admin/developer only; scoped on video:write. Template names must
        be unique within the tenant (case-insensitive) and the library is capped
        at 100 templates per tenant. The config preset carries only non-secret
        room knobs — recording-storage credentials and consent receipts are
        never persisted on a template.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - name
                - config
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                  description: >-
                    Tenant-supplied label rendered in the template picker.
                    Unique within the tenant (case-insensitive).
                description:
                  type: string
                  maxLength: 500
                  description: Optional operator description.
                config:
                  $ref: '#/components/schemas/VideoRoomTemplateConfig'
      responses:
        '201':
          description: The saved room-config template.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      template:
                        $ref: '#/components/schemas/VideoRoomTemplate'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '400':
          description: >-
            A field failed validation, a duplicate template name, or the
            per-tenant template cap was reached.
        '422':
          description: Request body failed schema validation.
components:
  schemas:
    VideoRoomTemplateConfig:
      type: object
      description: >-
        The reusable, NON-SECRET room-config preset stored on a video
        room-config template. Every field is optional and maps 1:1 to the
        identically-named POST /video/rooms-scheduled room-create knob; an empty
        object is a valid 'all defaults' preset. Unknown keys are rejected, and
        secret-bearing fields (BYO recording-storage credentials, consent
        receipts) are intentionally never part of a template.
      additionalProperties: false
      properties:
        max_participants:
          type: integer
          minimum: 2
          maximum: 300
          description: >-
            Per-room participant cap. Further bounded by your plan's tier cap
            when a room is instantiated.
        max_duration_minutes:
          type: integer
          minimum: 5
          maximum: 1440
          description: >-
            Auto-expire rooms created from this template after this many
            minutes.
        recording_enabled:
          type: boolean
          description: Auto-start recording when a room is created from this template.
        recording_format:
          type: string
          enum:
            - composite
            - tracks
            - both
          description: >-
            Egress recording layout. Meaningful only when recording_enabled is
            true.
        recording_output:
          $ref: '#/components/schemas/VideoRecordingOutput'
        simulcast:
          type: boolean
          description: Enable simulcast (multiple spatial layers per publisher).
        spatial_layers:
          type: integer
          minimum: 1
          maximum: 3
          description: Number of simulcast spatial layers.
        max_bitrate_kbps:
          type: integer
          minimum: 100
          maximum: 8000
          description: Per-publisher max video bitrate in kbps.
        video_codec:
          type: string
          enum:
            - vp8
            - h264
            - vp9
            - av1
          description: Preferred publisher video codec.
        svc_scalability_mode:
          type: string
          enum:
            - L1T1
            - L1T2
            - L1T3
            - L2T1
            - L2T2
            - L2T3
            - L3T1
            - L3T2
            - L3T3
            - L3T3_KEY
          description: SVC scalability mode. Only valid when video_codec is vp9 or av1.
        e2ee:
          type: boolean
          description: Enable end-to-end encryption for room media.
        e2ee_key_provider:
          type: string
          enum:
            - shared_passphrase
            - per_participant
          description: How E2EE keys are provisioned.
        virtual_background:
          type: string
          enum:
            - 'off'
            - allowed
            - required
          description: Virtual-background policy for participants.
        noise_suppression:
          type: string
          enum:
            - 'off'
            - allowed
            - required
          description: Noise-suppression policy for participants.
        spatial_audio:
          type: string
          enum:
            - 'off'
            - allowed
            - required
          description: Spatial-audio policy for participants.
        audio_only:
          type: boolean
          description: Create audio-only rooms from this template.
        captions_required:
          type: boolean
          description: >-
            Mandate live captions. Instantiating on a deployment without the
            caption service configured returns 503.
        region:
          type: string
          enum:
            - auto
            - eu
            - us
          description: >-
            Preferred media region; auto lets the platform choose at room-create
            time.
        waiting_room:
          type: boolean
          description: >-
            Arm the waiting-room lobby by default on rooms made from this
            template.
        waiting_room_auto_promote:
          type: boolean
          description: >-
            FIFO auto-promote the next lobby attendee when a publish seat frees.
            Meaningful only when waiting_room is true.
    VideoRoomTemplate:
      type: object
      description: >-
        A saved, reusable video room-config template ('meeting template') for a
        tenant, pairing a human label + optional description with a NON-SECRET
        room-config preset that new rooms can be instantiated from. Stored per
        tenant; no recording-storage credentials or consent receipts are ever
        persisted on a template.
      required:
        - id
        - name
        - description
        - config
        - created_at
        - updated_at
        - created_by
      additionalProperties: false
      properties:
        id:
          type: string
          description: The vrtpl_-prefixed template id minted on creation.
        name:
          type: string
          maxLength: 120
          description: >-
            Tenant-supplied label rendered in the template picker (e.g. 'Sales
            demo').
        description:
          type:
            - string
            - 'null'
          maxLength: 500
          description: Optional operator description; null when unset.
        config:
          $ref: '#/components/schemas/VideoRoomTemplateConfig'
        created_at:
          type: string
          format: date-time
          description: ISO 8601 creation timestamp.
        updated_at:
          type: string
          format: date-time
          description: ISO 8601 last-update timestamp.
        created_by:
          type:
            - string
            - 'null'
          description: Platform user id of the creating operator; null for API-key callers.
    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
    VideoRecordingOutput:
      type: object
      description: >-
        Optional egress recording-output encoding override. Supply a preset OR
        the advanced fields (mutually exclusive); omitting the object preserves
        the egress defaults (H264_MAIN / 1080p / 4500kbps). width and height
        must be supplied together.
      additionalProperties: false
      properties:
        preset:
          type: string
          enum:
            - h264_720p_30
            - h264_720p_60
            - h264_1080p_30
            - h264_1080p_60
            - portrait_h264_720p_30
            - portrait_h264_720p_60
            - portrait_h264_1080p_30
            - portrait_h264_1080p_60
          description: >-
            A named encoding preset. Mutually exclusive with the advanced fields
            below.
        video_codec:
          type: string
          enum:
            - h264_baseline
            - h264_main
            - h264_high
            - vp8
          description: Egress-output video codec (VP9/AV1 are publisher-input only).
        width:
          type: integer
          minimum: 160
          maximum: 3840
          description: Output width in pixels; must be supplied together with height.
        height:
          type: integer
          minimum: 120
          maximum: 2160
          description: Output height in pixels; must be supplied together with width.
        framerate:
          type: integer
          minimum: 1
          maximum: 60
          description: Output frame rate.
        video_bitrate_kbps:
          type: integer
          minimum: 100
          maximum: 20000
          description: Output video bitrate in kbps.
  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_*)

````