find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/roboflow-webrtc-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Roboflow Webrtc API
  version: 1.3.8
  contact:
    name: Roboflow Inc.
    url: https://roboflow.com/contact
    email: help@roboflow.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://roboflow.com/terms
  description: 'Operations tagged Webrtc across 2 of this provider''s published API definitions: roboflow-inference-openapi.json, roboflow-webrtc-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://serverless.roboflow.com
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Webrtc
paths:
  /webrtc/session/heartbeat:
    post:
      summary: WebRTC session heartbeat
      description: 'Receive heartbeat for an active WebRTC session.


        This endpoint is called periodically to indicate

        that their session is still active. The session will be removed from

        the quota count if no heartbeat is received within the TTL period.


        Requires api_key for authentication.'
      operationId: webrtc_session_heartbeat_webrtc_session_heartbeat_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebRTCSessionHeartbeatRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Webrtc Session Heartbeat Webrtc Session Heartbeat Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Webrtc
  /webrtc/session/heartbeat/end:
    post:
      summary: End WebRTC session
      description: 'End a WebRTC session and immediately free the quota slot.


        Requires api_key for authentication.'
      operationId: webrtc_session_end_webrtc_session_heartbeat_end_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebRTCSessionHeartbeatRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Webrtc Session End Webrtc Session Heartbeat End Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Webrtc
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    WebRTCSessionHeartbeatRequest:
      properties:
        session_id:
          type: string
          title: Session Id
        api_key:
          type: string
          title: Api Key
      type: object
      required:
      - session_id
      - api_key
      title: WebRTCSessionHeartbeatRequest
      description: Request body for WebRTC session heartbeat and end endpoints.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
x-refined-from:
- roboflow-inference-openapi.json
- roboflow-webrtc-api-openapi.yml