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/ant-media:ant-media-filters-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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: Ant Media Server REST API Reference Filters API
  description: Ant Media Server REST API Reference
  contact:
    name: Ant Media Info
    url: https://antmedia.io
    email: contact@antmedia.io
  license:
    name: Apache 2.0
    url: http://www.apache.org
  version: V2.0
servers:
- url: https://test.antmedia.io:5443/Sandbox/rest/
  description: test server
tags:
- name: Filters
paths:
  /v2/filters/create:
    post:
      summary: Creates or update the filter
      operationId: create
      requestBody:
        description: Filter object with the updates
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterConfiguration'
      responses:
        '200':
          description: Filter created or updated
      tags:
      - Filters
  /v2/filters/room-mcu-filter/{roomId}:
    post:
      summary: Creates MCU filter for non MCU room
      operationId: createMCU
      parameters:
      - name: roomId
        in: path
        description: Room Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: MCU filter created for room
      tags:
      - Filters
    delete:
      summary: Deletes MCU filter for non MCU room
      operationId: deleteMCU
      parameters:
      - name: roomId
        in: path
        description: Room Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: MCU filter deleted for room
      tags:
      - Filters
  /v2/filters/{id}:
    delete:
      summary: Delete the filter according to the filterId
      operationId: delete
      parameters:
      - name: id
        in: path
        description: Filter id for deleting filter
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Filter deleted
      tags:
      - Filters
  /v2/filters/list/{offset}/{size}:
    get:
      summary: Returns the list of filters effective in the application
      operationId: getFilters
      parameters:
      - name: offset
        in: path
        description: This is the offset of the list, it is useful for pagination. If you want to use sort mechanism, we recommend using Mongo DB.
        required: true
        schema:
          type: integer
          format: int32
      - name: size
        in: path
        description: Number of items that will be fetched. If there is not enough item in the datastore, returned list size may less then this value
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: List of filters returned
      tags:
      - Filters
  /v2/filters/mcu-filter/{id}:
    delete:
      summary: Reset the default MCU filter
      operationId: resetMCUFilter
      parameters:
      - name: id
        in: path
        description: Filter object with the updates
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Default MCU filter reset
      tags:
      - Filters
  /v2/filters/mcu-filter:
    put:
      summary: Set a filter specific to the MCU room
      operationId: setCustomMCUFilter
      requestBody:
        description: Filter object with the updates
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterConfiguration'
      responses:
        '200':
          description: Custom MCU filter set
      tags:
      - Filters
  /v2/filters/mcu-plugin-type:
    put:
      summary: Set the plugin type of the MCU function
      operationId: setPluginType
      parameters:
      - name: type
        in: query
        description: 'Change the plugin type for a filter: synchronous | asynchronous (default) | lastpoint'
        schema:
          type: string
      responses:
        '200':
          description: MCU plugin type set
      tags:
      - Filters
components:
  schemas:
    FilterConfiguration:
      type: object
      properties:
        filterId:
          type: string
        inputStreams:
          type: array
          items:
            type: string
        outputStreams:
          type: array
          items:
            type: string
        videoFilter:
          type: string
        audioFilter:
          type: string
        type:
          type: string
        videoEnabled:
          type: boolean
        audioEnabled:
          type: boolean
externalDocs:
  url: https://antmedia.io