openapi: 3.0.0
info:
  title: Cloudflare Realtime API
  version: "1.0"
externalDocs:
  description: Find out more about Cloudflare Realtime
  url: https://developers.cloudflare.com/realtime/
servers:
  - url: https://rtc.live.cloudflare.com/v1
paths:
  /apps/{appId}/sessions/new:
    post:
      tags:
        - New Session
      summary: Create a new PeerConnection
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
        - in: query
          name: thirdparty
          schema:
            type: boolean
          description: Session is intended to connect to an ICE-lite peer like a third party SFU/server
        - in: query
          name: correlationId
          schema:
            type: string
          description: Associate session to an user-provided correlation id
      responses:
        "201":
          description: Created
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/NewSessionResponse"
                  - example:
                      sessionId: e017a2629c754fedc1f7d8587e06d126
  /apps/{appId}/adapters/websocket/new:
    post:
      tags:
        - Create adapter(s)
      summary: Create WebSocket adapter(s) for ingest or stream
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NewAdapterRequest"
            examples:
              local_ingest:
                description: Ingest audio from a WebSocket endpoint to create a new WebRTC track
                value:
                  tracks:
                    - location: local
                      trackName: tts-track
                      endpoint: wss://example.com/ingest
                      inputCodec: pcm
                      mode: buffer
              remote_stream_audio:
                description: Stream an existing WebRTC audio track to a WebSocket endpoint
                value:
                  tracks:
                    - location: remote
                      sessionId: 2a45361d5fd7cc14eface0587c276c94
                      trackName: mic-track
                      endpoint: wss://example.com/stream-audio
                      outputCodec: pcm
                      mode: stream
              remote_stream_video:
                description: Stream an existing WebRTC video track as JPEG to a WebSocket endpoint
                value:
                  tracks:
                    - location: remote
                      sessionId: 2a45361d5fd7cc14eface0587c276c94
                      trackName: camera-track
                      endpoint: wss://example.com/stream-video
                      outputCodec: jpeg
                      mode: stream
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
      responses:
        "200":
          description: OK
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/NewAdapterResponse"
              examples:
                local_ingest:
                  value:
                    tracks:
                      - trackName: tts-track
                        adapterId: 4e66a9d5a35e4a0899f6f8d0b63a35c1
                        sessionId: d6f73f6f0c6645a7bb8f74e3fcb00a2f
                        endpoint: wss://example.com/ingest
                remote_stream:
                  value:
                    tracks:
                      - trackName: mic-track
                        adapterId: 2b2ff7d2e17a4d638be5b6e3075ed6ce
                        endpoint: wss://example.com/stream-audio
        "503":
          description: Service unavailable. No adapter could be created.
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/NewAdapterResponse"
              example:
                tracks:
                  - trackName: mic-track
                    errorCode: adapter_unavailable
                    errorDescription: Failed to create adapter
  /apps/{appId}/adapters/websocket/close:
    post:
      tags:
        - Close adapter(s)
      summary: Close WebSocket adapter(s)
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CloseAdapterRequest"
            example:
              tracks:
                - adapterId: 4e66a9d5a35e4a0899f6f8d0b63a35c1
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
      responses:
        "200":
          description: OK
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CloseAdapterResponse"
              example:
                tracks:
                  - adapterId: 4e66a9d5a35e4a0899f6f8d0b63a35c1
                    bytesProcessed: 83492
        "503":
          description: Service unavailable. No adapter could be closed.
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CloseAdapterResponse"
              example:
                tracks:
                  - adapterId: 4e66a9d5a35e4a0899f6f8d0b63a35c1
                    errorCode: adapter_not_found
                    errorDescription: Adapter not found
  /apps/{appId}/sessions/{sessionId}/tracks/new:
    post:
      tags:
        - Add a track
      summary: Solve the given track object(s) and add the track(s) to the WebRTC session
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TracksRequest"
            examples:
              local_tracks:
                description: Share a track to be played by remote peers
                value:
                  sessionDescription:
                    sdp: |
                      v=0
                      o=- 0 0 IN IP4 127.0.0.1
                      s=-
                      c=IN IP4 127.0.0.1
                      t=0 0
                      m=audio 4000 RTP/AVP 111
                      a=rtpmap:111 OPUS/48000/2
                      m=video 4002 RTP/AVP 96
                      a=rtpmap:96 VP8/90000
                      ...
                    type: offer
                  tracks:
                    - location: local
                      mid: "4"
                      trackName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
              remote_tracks:
                description: Play a track from a remote peer
                value:
                  tracks:
                    - location: remote
                      sessionId: 2a45361d5fd7cc14eface0587c276c94
                      trackName: 2e037563-a35d-4bf6-a9ee-2d474cbb9a58
              push_track_with_bidirectional_stream:
                description: Share a track through a bidirectional transceiver
                value:
                  sessionDescription:
                    sdp: |
                      v=0
                      o=- 0 0 IN IP4 127.0.0.1
                      s=-
                      c=IN IP4 127.0.0.1
                      t=0 0
                      m=audio 4000 RTP/AVP 111
                      a=rtpmap:111 OPUS/48000/2
                      m=video 4002 RTP/AVP 96
                      a=rtpmap:96 VP8/90000
                      ...
                    type: offer
                  tracks:
                    - location: local
                      mid: "0"
                      trackName: mic-1
                      bidirectionalMediaStream: true
                      kind: "audio"
              push_track_without_an_offer:
                description: SFU can generate an offer to push a local track
                value:
                  tracks:
                    - location: local
                      trackName: mic-1
                      kind: "audio"
              push_tracks_with_autodiscover:
                description: SFU detects any new track in the offered SDP
                value:
                  autoDiscover: true
                  sessionDescription:
                    sdp: |
                      v=0
                      o=- 0 0 IN IP4 127.0.0.1
                      s=-
                      c=IN IP4 127.0.0.1
                      t=0 0
                      m=audio 4000 RTP/AVP 111
                      a=rtpmap:111 OPUS/48000/2
                      m=video 4002 RTP/AVP 96
                      a=rtpmap:96 VP8/90000
                      ...
                    type: offer
              pull_track_with_bidirectional_stream:
                description: Pull a track through an existing bidirectional transceiver identified by a mid
                value:
                  tracks:
                    - location: remote
                      mid: "#mic-1"
                      sessionId: 2a45361d5fd7cc14eface0587c276c94
                      trackName: generated-audio
                      kind: "audio"
              remote_track_with_simulcast:
                description: Pull a remote track with simulcast preferences
                value:
                  tracks:
                    - location: remote
                      sessionId: 2a45361d5fd7cc14eface0587c276c94
                      trackName: simulcast-video-track
                      simulcast:
                        preferredRid: "h"
                        priorityOrdering: "asciibetical"
                        ridNotAvailabl: "asciibetical"
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
        - in: path
          name: sessionId
          schema:
            type: string
          required: true
          description: Current PeerConnection session ID
      responses:
        "200":
          description: OK
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TracksResponse"
              examples:
                local_tracks:
                  value:
                    requiresImmediateRenegotiation: false
                    tracks:
                      - trackName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
                        mid: "4"
                    sessionDescription:
                      sdp: |
                        v=0
                        o=- 0 0 IN IP4 127.0.0.1
                        s=-
                        c=IN IP4 127.0.0.1
                        t=0 0
                        m=audio 4000 RTP/AVP 111
                        a=rtpmap:111 OPUS/48000/2
                        m=video 4002 RTP/AVP 96
                        a=rtpmap:96 VP8/90000
                        ...
                      type: answer
                remote_tracks:
                  value:
                    requiresImmediateRenegotiation: true
                    tracks:
                      - sessionId: 2a45361d5fd7cc14eface0587c276c94
                        trackName: 2e037563-a35d-4bf6-a9ee-2d474cbb9a58
                        mid: "7"
                    sessionDescription:
                      sdp: |
                        v=0
                        o=- 0 0 IN IP4 127.0.0.1
                        s=-
                        c=IN IP4 127.0.0.1
                        t=0 0
                        m=audio 4000 RTP/AVP 111
                        a=rtpmap:111 OPUS/48000/2
                        m=video 4002 RTP/AVP 96
                        a=rtpmap:96 VP8/90000
                        ...
                      type: offer
                remote_tracks_with_simulcast:
                  value:
                    requiresImmediateRenegotiation: true
                    tracks:
                      - sessionId: 2a45361d5fd7cc14eface0587c276c94
                        trackName: simulcast-video-track
                        mid: "5"
                        simulcast:
                          preferredRid: "h"
                          priorityOrdering: "asciibetical"
                          ridNotAvailabl: "asciibetical"
                    sessionDescription:
                      sdp: |
                        v=0
                        o=- 0 0 IN IP4 127.0.0.1
                        s=-
                        c=IN IP4 127.0.0.1
                        t=0 0
                        m=video 4002 RTP/AVP 96
                        a=rtpmap:96 VP8/90000
                        a=simulcast:recv f;h;q
                        a=rid:f recv
                        a=rid:h recv
                        a=rid:q recv
                        ...
                      type: offer
  /apps/{appId}/sessions/{sessionId}/renegotiate:
    put:
      tags:
        - Renegotiate WebRTC session
      summary: When a previous response has requiresImmediateRenegotiation, you must renegotiate
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RenegotiateRequest"
            example:
              sessionDescription:
                sdp: |
                  v=0
                  o=- 0 0 IN IP4 127.0.0.1
                  s=-
                  c=IN IP4 127.0.0.1
                  t=0 0
                  m=audio 4000 RTP/AVP 111
                  a=rtpmap:111 OPUS/48000/2
                  m=video 4002 RTP/AVP 96
                  a=rtpmap:96 VP8/90000
                  ...
                  type: answer
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
        - in: path
          name: sessionId
          schema:
            type: string
          required: true
      responses:
        "200":
          description: OK
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RenegotiateResponse"
              example: {}
  /apps/{appId}/sessions/{sessionId}/tracks/close:
    put:
      tags:
        - Close a track
      summary: Close a local or remote track
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: "#/components/schemas/CloseTracksRequest"
                - example:
                    tracks:
                      - mid: "7"
                    sessionDescription:
                      sdp: |
                        v=0
                        o=- 0 0 IN IP4 127.0.0.1
                        s=-
                        c=IN IP4 127.0.0.1
                        t=0 0
                        m=audio 4000 RTP/AVP 111
                        a=rtpmap:111 OPUS/48000/2
                        m=video 4002 RTP/AVP 96
                        a=rtpmap:96 VP8/90000
                        ...
                      type: offer
                    force: false
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
        - in: path
          name: sessionId
          schema:
            type: string
          required: true
      responses:
        "200":
          description: OK
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CloseTracksResponse"
              example:
                sessionDescription:
                  sdp: |
                    v=0
                    o=- 0 0 IN IP4 127.0.0.1
                    s=-
                    c=IN IP4 127.0.0.1
                    t=0 0
                    m=audio 4000 RTP/AVP 111
                    a=rtpmap:111 OPUS/48000/2
                    m=video 4002 RTP/AVP 96
                    a=rtpmap:96 VP8/90000
                    ...
                  type: answer
                requiresImmediateRenegotiation: false
                tracks:
                  - mid: "7"
  /apps/{appId}/sessions/{sessionId}/tracks/update:
    put:
      tags:
        - Change tracks
      summary: Change tracks by reusing existing transceivers
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateTracksRequest"
            examples:
              reuse_transceiver:
                description: Reuse an existing transceiver for a new track
                value:
                  tracks:
                    - location: "remote"
                      sessionId: "2a45361d5fd7cc14eface0587c276c94"
                      trackName: "other-track-name"
                      mid: "7"
              reuse_with_simulcast:
                description: Reuse an existing transceiver with new simulcast preferences
                value:
                  tracks:
                    - location: "remote"
                      sessionId: "2a45361d5fd7cc14eface0587c276c94"
                      trackName: "simulcast-track"
                      mid: "8"
                      simulcast:
                        preferredRid: "h"
                        priorityOrdering: "asciibetical"
                        ridNotAavailable: "asciibetical"
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
        - in: path
          name: sessionId
          schema:
            type: string
          required: true
          description: Current PeerConnection session ID
      responses:
        "200":
          description: OK
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UpdateTracksResponse"
              examples:
                success:
                  value:
                    requiresImmediateRenegotiation: false
                    tracks:
                      - mid: "7"
                        sessionId: "2a45361d5fd7cc14eface0587c276c94"
                        trackName: "new-track-name"
  /apps/{appId}/sessions/{sessionId}/datachannels/establish:
    post:
      tags:
        - Establish a data channel transport
      summary: Pull a server events channel to establish a data channel transport. It only allows to pull the server-events channel
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EstablishDataChannelsTransportRequest"
            examples:
              ask_for_an_offer:
                description: Ask for an offer to pull the server-events channel
                value:
                  datachannel:
                    location: remote
                    dataChannelName: server-events
              send_an_offer:
                description: Send an offer with an application media section to pull the server-events channel
                value:
                  datachannel:
                    location: remote
                    dataChannelName: server-events
                  sessionDescription:
                    sdp: |
                      v=0
                      o=- 0 0 IN IP4 127.0.0.1
                      s=-
                      c=IN IP4 127.0.0.1
                      t=0 0
                      m=application 9 UDP/DTLS/SCTP webrtc-datachannel
                      ...
                    type: offer
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
        - in: path
          name: sessionId
          schema:
            type: string
          required: true
          description: Current PeerConnection session ID
      responses:
        "200":
          description: OK
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EstablishDataChannelsTransportResponse"
              examples:
                ask_for_an_offer:
                  value:
                    requiresImmediateRenegotiation: true
                    datachannel:
                      location: remote
                      dataChannelName: server-events
                      id: 0
                send_an_offer:
                  value:
                    requiresImmediateRenegotiation: false
                    datachannel:
                      location: remote
                      dataChannelName: server-events
                      id: 0
                    sessionDescription:
                      sdp: |
                        v=0
                        o=- 0 0 IN IP4 127.0.0.1
                        s=-
                        c=IN IP4 127.0.0.1
                        t=0 0
                        m=application 9 UDP/DTLS/SCTP webrtc-datachannel
                        ...
                      type: answer
  /apps/{appId}/sessions/{sessionId}/datachannels/new:
    post:
      tags:
        - Add data channel(s)
      summary: Solve the given data channel object(s) and add the data channel(s) to the WebRTC session. It requires to have a data channels transport established
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DataChannelsRequest"
            examples:
              local_datachannels:
                description: Share a data channel to be consumed by remote peers
                value:
                  dataChannels:
                    - location: local
                      dataChannelName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
              local_datachannels_unordered:
                description: Share a reliable unordered data channel
                value:
                  dataChannels:
                    - location: local
                      dataChannelName: player-state
                      ordered: false
              local_datachannels_unreliable:
                description: Share an unreliable unordered data channel for high-frequency state
                value:
                  dataChannels:
                    - location: local
                      dataChannelName: player-state
                      ordered: false
                      maxRetransmits: 0
              remote_datachannels:
                description: Consume a remote data channel
                value:
                  dataChannels:
                    - location: remote
                      waitForAck: true
                      sessionId: "2a45361d5fd7cc14eface0587c276c94"
                      dataChannelName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
              remote_datachannels_can_reply:
                description: Consume a remote data channel and admit reverse traffic to the publisher
                value:
                  dataChannels:
                    - location: remote
                      canReply: true
                      sessionId: "2a45361d5fd7cc14eface0587c276c94"
                      dataChannelName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
              remote_datachannels_unordered:
                description: Consume a remote reliable unordered data channel
                value:
                  dataChannels:
                    - location: remote
                      sessionId: "2a45361d5fd7cc14eface0587c276c94"
                      dataChannelName: player-state
                      ordered: false
              remote_datachannels_unreliable:
                description: Consume a remote unreliable unordered data channel
                value:
                  dataChannels:
                    - location: remote
                      sessionId: "2a45361d5fd7cc14eface0587c276c94"
                      dataChannelName: player-state
                      ordered: false
                      maxRetransmits: 0
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
        - in: path
          name: sessionId
          schema:
            type: string
          required: true
          description: Current PeerConnection session ID
      responses:
        "200":
          description: OK
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataChannelsResponse"
              examples:
                local_datachannels:
                  value:
                    dataChannels:
                      - dataChannelName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
                        location: local
                        id: 3
                remote_datachannels:
                  value:
                    dataChannels:
                      - sessionId: 2a45361d5fd7cc14eface0587c276c94
                        location: remote
                        dataChannelName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
                        id: 4
  /apps/{appId}/sessions/{sessionId}/datachannels/update:
    put:
      tags:
        - Update data channel(s)
      summary: Update flags on already pulled remote data channel(s), such as granting or revoking canReply
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DataChannelsRequest"
            examples:
              grant_can_reply:
                description: Grant return-to-publisher admission on a pulled remote data channel
                value:
                  dataChannels:
                    - location: remote
                      canReply: true
                      sessionId: "2a45361d5fd7cc14eface0587c276c94"
                      dataChannelName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
              revoke_can_reply:
                description: Revoke return-to-publisher admission
                value:
                  dataChannels:
                    - location: remote
                      canReply: false
                      sessionId: "2a45361d5fd7cc14eface0587c276c94"
                      dataChannelName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
        - in: path
          name: sessionId
          schema:
            type: string
          required: true
          description: Current PeerConnection session ID (the subscriber session that pulled the channel)
      responses:
        "200":
          description: OK
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataChannelsResponse"
              examples:
                grant_can_reply:
                  value:
                    dataChannels:
                      - sessionId: 2a45361d5fd7cc14eface0587c276c94
                        location: remote
                        dataChannelName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
                        canReply: true
                        id: 4
  /apps/{appId}/sessions/{sessionId}/datachannels/close:
    put:
      tags:
        - Close data channel(s)
      summary: Close local or remote data channel(s)
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: "#/components/schemas/CloseDataChannelsRequest"
                - example:
                    dataChannels:
                      - id: 2
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
        - in: path
          name: sessionId
          schema:
            type: string
          required: true
      responses:
        "200":
          description: OK
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CloseDataChannelsResponse"
              example:
                dataChannels:
                  - location: remote
                    sessionId: 2a45361d5fd7cc14eface0587c276c94
                    dataChannelName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
                    id: 2
  /apps/{appId}/sessions/{sessionId}:
    get:
      tags:
        - Get session state
      summary: Return the list of tracks associated to the session
      security:
        - secret: []
      parameters:
        - in: path
          name: appId
          schema:
            type: string
          required: true
          description: WebRTC application ID
        - in: path
          name: sessionId
          schema:
            type: string
          required: true
      responses:
        "200":
          description: OK
          headers:
            vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetSessionStateResponse"
              example:
                tracks:
                  - location: local
                    mid: "2"
                    trackName: 1a037563-c35c-4bf6-a9ee-2b474cbb9a51
                    status: active
                  - location: remote
                    mid: "7"
                    sessionId: 2a45361d5fd7cc14eface0587c276c94
                    trackName: 2e037563-a35d-4bf6-a9ee-2d474cbb9a58
                    status: active

components:
  securitySchemes:
    secret:
      type: http
      scheme: bearer
  schemas:
    SessionDescription:
      type: object
      properties:
        sdp:
          type: string
        type:
          type: string
          enum:
            - answer
            - offer
    TrackObject:
      type: object
      properties:
        location:
          type: string
          enum:
            - local
            - remote
          description: If you want to share a track, it should be local. If you want to play a track shared by a remote agent, it should be remote
        mid:
          type: string
          description: mid associated to track's transceiver. It also can be prefixed with \# to reference an existing transceiver by its trackName
        sessionId:
          type: string
          description: Session ID of the track owner. It should be set for remote tracks only
        trackName:
          type: string
          description: Given name for the track
        bidirectionalMediaStream:
          type: boolean
          description: Make the associated transceiver bidirectional. This option works only when the SFU generates the offer
        kind:
          type: string
          description: Give a hint to the SFU about the transceiver kind. This is required when the SFU generates the offer
        simulcast:
          type: object
          description: Simulcast configuration for the track
          properties:
            preferredRid:
              type: string
              description: Preferred RID for simulcast streams
            priorityOrdering:
              type: string
              enum:
                - none
                - asciibetical
              default: none
              description: Controls what happens if there is not enough network resources available to send the preferredRid. 'none' means keep sending even if not enough bandwidth, 'asciibetical' uses a-z order to determine priority where a is most desirable and z is least desirable.
            ridNotAvailable:
              type: string
              enum:
                - none
                - asciibetical
              default: none
              description: Controls what happens when the rid currently being used or preferredRid is no longer being sent by the publisher. 'none' means do nothing, 'asciibetical' uses the next available layer after sorting the layers a-z.
    CloseTrackObject:
      type: object
      properties:
        mid:
          type: string
          description: mid associated to the track's transceiver to close
    TracksRequest:
      type: object
      properties:
        sessionDescription:
          $ref: "#/components/schemas/SessionDescription"
        tracks:
          type: array
          items:
            $ref: "#/components/schemas/TrackObject"
        autoDiscover:
          type: boolean
          description: Assign a random track name to any new track in the offered SDP
    TracksResponse:
      type: object
      properties:
        errorCode:
          type: string
        errorDescription:
          type: string
        requiresImmediateRenegotiation:
          type: boolean
        sessionDescription:
          $ref: "#/components/schemas/SessionDescription"
        tracks:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TrackObject"
              - properties:
                  errorCode:
                    type: string
                  errorDescription:
                    type: string
    NewSessionRequest:
      type: object
      properties:
        sessionDescription:
          $ref: "#/components/schemas/SessionDescription"
    NewSessionResponse:
      required:
        - sessionId
      type: object
      properties:
        errorCode:
          type: string
        errorDescription:
          type: string
        sessionDescription:
          type: object
          properties:
            sdp:
              type: string
            type:
              type: string
              enum:
                - answer
                - offer
        sessionId:
          type: string
    CloseTracksRequest:
      type: object
      properties:
        sessionDescription:
          $ref: "#/components/schemas/SessionDescription"
        tracks:
          type: array
          items:
            $ref: "#/components/schemas/CloseTrackObject"
        force:
          type: boolean
          description: True if you want to stop just the data flow for the tracks, no WebRTC renegotiation
    CloseTracksResponse:
      type: object
      properties:
        errorCode:
          type: string
        errorDescription:
          type: string
        sessionDescription:
          $ref: "#/components/schemas/SessionDescription"
        tracks:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/CloseTrackObject"
              - properties:
                  errorCode:
                    type: string
                  errorDescription:
                    type: string
        requiresImmediateRenegotiation:
          type: boolean
    GetSessionStateResponse:
      type: object
      properties:
        errorCode:
          type: string
        errorDescription:
          type: string
        tracks:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TrackObject"
              - properties:
                  status:
                    type: string
                    enum:
                      - active
                      - inactive
                      - waiting
    RenegotiateRequest:
      type: object
      properties:
        sessionDescription:
          $ref: "#/components/schemas/SessionDescription"
    RenegotiateResponse:
      type: object
      properties:
        errorCode:
          type: string
        errorDescription:
          type: string
        sessionDescription:
          $ref: "#/components/schemas/SessionDescription"
    ChangeTracksRequest:
      type: object
      properties:
        tracks:
          type: object
          additionalProperties:
            allOf:
              - $ref: "#/components/schemas/TrackObject"
          description: Map of track IDs to track objects for changing tracks
        sessionDescription:
          $ref: "#/components/schemas/SessionDescription"
    UpdateTracksRequest:
      type: object
      properties:
        tracks:
          type: array
          items:
            $ref: "#/components/schemas/TrackObject"
          description: Array of track objects for updating tracks
        sessionDescription:
          $ref: "#/components/schemas/SessionDescription"
    UpdateTracksResponse:
      type: object
      properties:
        errorCode:
          type: string
        errorDescription:
          type: string
        requiresImmediateRenegotiation:
          type: boolean
        tracks:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TrackObject"
              - properties:
                  errorCode:
                    type: string
                  errorDescription:
                    type: string
          description: Array of track objects with results
    AdapterObject:
      type: object
      properties:
        location:
          type: string
          enum:
            - local
            - remote
          description: Use local to ingest media from an external endpoint. Use remote to stream media from an existing WebRTC track.
        sessionId:
          type: string
          description: Session ID of the track owner. Required for remote adapters.
        trackName:
          type: string
          description: Track name to ingest into or stream from.
        endpoint:
          type: string
          description: WebSocket endpoint URL.
        outputCodec:
          type: string
          enum:
            - pcm
            - jpeg
          description: Codec for outgoing media on remote adapters. Use pcm for audio or jpeg for video.
        inputCodec:
          type: string
          enum:
            - pcm
          description: Codec for incoming media on local adapters.
        mode:
          type: string
          enum:
            - stream
            - buffer
          description: Adapter mode. Use buffer for local adapters and stream for remote adapters.
        adapterId:
          type: string
          description: Unique identifier of the adapter instance.
    AdapterStatObject:
      type: object
      properties:
        adapterId:
          type: string
          description: Unique identifier of the adapter instance.
        bytesProcessed:
          type: number
          description: Number of bytes processed before the adapter closed.
    NewAdapterRequest:
      type: object
      properties:
        tracks:
          type: array
          items:
            $ref: "#/components/schemas/AdapterObject"
    NewAdapterResponse:
      type: object
      properties:
        errorCode:
          type: string
        errorDescription:
          type: string
        tracks:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/AdapterObject"
              - properties:
                  errorCode:
                    type: string
                  errorDescription:
                    type: string
    CloseAdapterRequest:
      type: object
      properties:
        tracks:
          type: array
          items:
            type: object
            properties:
              adapterId:
                type: string
                description: Adapter identifier to close.
    CloseAdapterResponse:
      type: object
      properties:
        errorCode:
          type: string
        errorDescription:
          type: string
        tracks:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/AdapterStatObject"
              - properties:
                  errorCode:
                    type: string
                  errorDescription:
                    type: string
    DataChannelObject:
      type: object
      properties:
        location:
          type: string
          enum:
            - local
            - remote
          description: Choose local to broadcast into the given dataChannelName. Choose remote to consume a broadcast from someone else
        sessionId:
          type: string
          description: Session ID of the data channel owner. It should be set for remote data channels only
        dataChannelName:
          type: string
          description: Given name for the data channel
        ordered:
          type: boolean
          default: true
          description: >
            When true (default), messages are delivered in send order. When false, messages may
            arrive out of order. A delayed message does not block later messages. Set on both
            local (publisher) and remote (subscriber) DataChannels, and mirror the value on
            createDataChannel().
        maxRetransmits:
          type: integer
          minimum: 0
          description: >
            Maximum number of times the WebRTC transport may retransmit a message after the first
            send. 0 means no retransmits (unreliable). Omit for unlimited retransmits (reliable).
            Mutually exclusive with maxPacketLifeTime. Set on both local and remote DataChannels,
            and mirror the value on createDataChannel().
        maxPacketLifeTime:
          type: integer
          minimum: 0
          description: >
            Maximum time in milliseconds that the WebRTC transport may spend trying to deliver a
            message before giving up. Omit for unlimited lifetime (reliable). Mutually exclusive
            with maxRetransmits. Set on both local and remote DataChannels, and mirror the value
            on createDataChannel().
        waitForAck:
          type: boolean
          default: false
          description: >
            For remote DataChannels only. When true, the SFU holds delivery to this subscriber
            until the subscriber sends its first message on this DataChannel (the acknowledgment).
            The acknowledgment is consumed by the SFU and is not forwarded. It must arrive within
            30 seconds of creating the remote DataChannel; otherwise the SFU tears down the gated
            channel. Ignored for local DataChannels.
        canReply:
          type: boolean
          default: false
          description: >
            For remote DataChannels only. When true, this subscriber may send reverse traffic on
            the DataChannel to the publisher. Reverse messages are delivered only to the publisher
            and are not fanned out to other subscribers. At most one subscriber may hold canReply
            for a given publisher DataChannel at a time; granting canReply to another subscriber
            replaces the previous selection. Set on datachannels/new at pull time, or grant and
            revoke later with datachannels/update. Ignored for local DataChannels.
        id:
          type: number
          description: Data channel id
    DataChannelsRequest:
      type: object
      properties:
        dataChannels:
          type: array
          items:
            $ref: "#/components/schemas/DataChannelObject"
    DataChannelsResponse:
      type: object
      properties:
        errorCode:
          type: string
        errorDescription:
          type: string
        dataChannels:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/DataChannelObject"
              - properties:
                  errorCode:
                    type: string
                  errorDescription:
                    type: string
    EstablishDataChannelsTransportRequest:
      type: object
      properties:
        sessionDescription:
          $ref: "#/components/schemas/SessionDescription"
        dataChannel:
          $ref: "#/components/schemas/DataChannelObject"
    EstablishDataChannelsTransportResponse:
      type: object
      properties:
        errorCode:
          type: string
        errorDescription:
          type: string
        sessionDescription:
          $ref: "#/components/schemas/SessionDescription"
        requiresImmediateRenegotiation:
          type: boolean
        dataChannel:
          $ref: "#/components/schemas/DataChannelObject"
    CloseDataChannelsRequest:
      type: object
      properties:
        dataChannels:
          type: array
          items:
            $ref: "#/components/schemas/DataChannelObject"
    CloseDataChannelsResponse:
      type: object
      properties:
        errorCode:
          type: string
        errorDescription:
          type: string
        dataChannels:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/DataChannelObject"
              - properties:
                  errorCode:
                    type: string
                  errorDescription:
                    type: string