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

# startRecording

> layout, and audio settings. Only available for paid tier meetings using GetStream.
Only the meeting host can start recording. Includes rate limiting (max 3 starts
per minute) and tracks recording metadata. Updates meeting state to reflect
active recording. Includes circuit breaker and retry logic for resilience.



## OpenAPI

````yaml api-reference/convex-openapi.yaml post /api/run/meetings/stream/index/startRecording
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/stream/index/startRecording:
    post:
      tags:
        - Meetings
      summary: startRecording
      description: >-
        layout, and audio settings. Only available for paid tier meetings using
        GetStream.

        Only the meeting host can start recording. Includes rate limiting (max 3
        starts

        per minute) and tracks recording metadata. Updates meeting state to
        reflect

        active recording. Includes circuit breaker and retry logic for
        resilience.
      operationId: postApiRunMeetingsStreamIndexStartRecording
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Request_meetings.stream.index.startRecording
            example:
              args:
                meetingId: meeting_123example
                recordingConfig:
                  mode: available
                  audioOnly: false
                  quality: 720p
                  layout: grid
        required: true
      responses:
        '200':
          description: Convex executed your request and returned a result
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Response_meetings.stream.index.startRecording
              example:
                status: success
                errorMessage: ''
                errorData: {}
                value:
                  recordingId: recording_1704067200000
                  recordingUrl: >-
                    https://stream-recordings.example.com/recording_1704067200000.mp4
                  success: true
        '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.stream.index.startRecording:
      type: object
      required:
        - args
      properties:
        args:
          type: object
          required:
            - meetingId
          properties:
            meetingId:
              type: string
              description: ID from table "meetings"
            recordingConfig:
              type: object
              properties:
                audioOnly:
                  type: boolean
                layout:
                  oneOf:
                    - type: string
                      enum:
                        - grid
                    - type: string
                      enum:
                        - spotlight
                    - type: string
                      enum:
                        - single-participant
                mode:
                  oneOf:
                    - type: string
                      enum:
                        - available
                    - type: string
                      enum:
                        - disabled
                quality:
                  oneOf:
                    - type: string
                      enum:
                        - 360p
                    - type: string
                      enum:
                        - 720p
                    - type: string
                      enum:
                        - 1080p
    Response_meetings.stream.index.startRecording:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - success
            - error
        errorMessage:
          type: string
        errorData:
          type: object
        value:
          type: object
          required:
            - recordingId
            - success
          properties:
            recordingId:
              type: string
            recordingUrl:
              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>`.

````