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

# initializeWebRTCRoom

> Calls a action at the path meetings/webrtc/index.js:initializeWebRTCRoom



## OpenAPI

````yaml api-reference/convex-openapi.yaml post /api/run/meetings/webrtc/index/initializeWebRTCRoom
openapi: 3.0.3
info:
  title: Connvo Convex API
  version: 1.0.0
  description: >-
    HTTP interface for Connvo's Convex backend, exposing vetted query, mutation,
    and action endpoints.
servers:
  - url: https://Connvo-dev.convex.cloud
    description: Dev Convex deployment
  - url: https://Connvo-staging.convex.cloud
    description: Staging Convex deployment
  - url: https://Connvo-prod.convex.cloud
    description: Prod Convex deployment
security:
  - bearerAuth: []
tags:
  - name: Users
    description: Identity, profile, and authentication operations for Connvo users.
  - name: Meetings
    description: Scheduling, managing, and retrieving meeting data.
  - name: Transcripts
    description: Endpoints for accessing call transcripts and transcription controls.
  - name: Insights
    description: AI-generated insights, summaries, and analytics derived from meetings.
  - name: Prompts
    description: Prompt management and AI conversation guidance.
  - name: Notes
    description: Collaborative meeting notes and follow-up documentation.
  - name: WebRTC
    description: Real-time communication, session signalling, and media utilities.
  - name: System
    description: General system endpoints such as health checks and diagnostics.
paths:
  /api/run/meetings/webrtc/index/initializeWebRTCRoom:
    post:
      tags:
        - Meetings
      summary: initializeWebRTCRoom
      description: Calls a action at the path meetings/webrtc/index.js:initializeWebRTCRoom
      operationId: postApiRunMeetingsWebrtcIndexInitializeWebRTCRoom
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Request_meetings.webrtc.index.initializeWebRTCRoom
        required: true
      responses:
        '200':
          description: Convex executed your request and returned a result
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Response_meetings.webrtc.index.initializeWebRTCRoom
        '400':
          description: Failed operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
        '500':
          description: Convex Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    Request_meetings.webrtc.index.initializeWebRTCRoom:
      type: object
      required:
        - args
      properties:
        args:
          type: object
          required:
            - meetingId
          properties:
            maxParticipants:
              type: number
            meetingId:
              type: string
              description: ID from table "meetings"
    Response_meetings.webrtc.index.initializeWebRTCRoom:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - success
            - error
        errorMessage:
          type: string
        errorData:
          type: object
        value:
          type: object
          required:
            - features
            - provider
            - roomId
            - success
          properties:
            features:
              type: object
              required:
                - chat
                - maxParticipants
                - recording
                - screenSharing
                - transcription
              properties:
                chat:
                  type: boolean
                maxParticipants:
                  type: number
                recording:
                  type: boolean
                screenSharing:
                  type: boolean
                transcription:
                  type: boolean
            iceServers:
              type: array
              items:
                type: object
                required:
                  - urls
                properties:
                  credential:
                    type: string
                  urls:
                    oneOf:
                      - type: string
                      - type: array
                        items:
                          type: string
                  username:
                    type: string
            provider:
              oneOf:
                - type: string
                  enum:
                    - webrtc
                - type: string
                  enum:
                    - getstream
            roomId:
              type: string
            success:
              type: boolean
    FailedResponse:
      type: object
      properties: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Standard user authentication token issued via WorkOS. Provide as
        `Authorization: Bearer <user-token>`.

````