---
updatedAt: 2026-08-05T08:16:47.000Z
agentTools:
  siteIndex: https://developer.bitmovin.com/llms.txt
  projectIndex: https://developer.bitmovin.com/encoding/llms.txt
---

# List Azure Speech to captions Filters

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Live Encoding API",
    "description": "Bitmovins API Reference Description",
    "version": "3.0",
    "termsOfService": "https://bitmovin.com",
    "contact": {
      "name": "Bitmovin Inc",
      "url": "https://bitmovin.com",
      "email": "support@bitmovin.com"
    }
  },
  "servers": [
    {
      "url": "https://api.bitmovin.com/v1",
      "description": "Bitmovin Server",
      "variables": {}
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    },
    {
      "ApiKeyAuth": [],
      "TenantOrgId": []
    }
  ],
  "paths": {
    "/encoding/filters/azure-speech-to-captions": {
      "get": {
        "tags": [
          "Azure Speech To Captions Filter"
        ],
        "summary": "List Azure Speech to captions Filters",
        "operationId": "LiveGetEncodingFiltersAzureSpeechToCaptions",
        "x-bitmovin": {
          "product": "live"
        },
        "parameters": [
          {
            "name": "offset",
            "in": "query",
            "description": "Index of the first item to return, starting at 0. Default is 0",
            "style": "form",
            "schema": {
              "type": "integer",
              "example": "0"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Maximum number of items to return. Default is 25, maximum is 100",
            "style": "form",
            "schema": {
              "type": "integer",
              "example": "25"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "Filter filters by name",
            "style": "form",
            "schema": {
              "type": "string",
              "example": "name"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ResponseEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "properties": {
                            "result": {
                              "allOf": [
                                {
                                  "$ref": "#/components/schemas/PaginationResponse"
                                },
                                {
                                  "properties": {
                                    "items": {
                                      "description": "List of Azure Speech to captions Filters",
                                      "items": {
                                        "$ref": "#/components/schemas/AzureSpeechToCaptionsFilter"
                                      }
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseError"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "description": "Your Bitmovin API key",
        "name": "X-Api-Key",
        "in": "header"
      },
      "TenantOrgId": {
        "type": "apiKey",
        "description": "Your Bitmovin account organization",
        "name": "X-Tenant-Org-Id",
        "in": "header"
      }
    },
    "schemas": {
      "BitmovinResource": {
        "title": "BitmovinResource",
        "allOf": [
          {
            "$ref": "#/components/schemas/BitmovinResponse"
          },
          {
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of the resource. Can be freely chosen by the user.",
                "example": "Name of the resource"
              },
              "description": {
                "type": "string",
                "description": "Description of the resource. Can be freely chosen by the user.",
                "example": "Description of the resource"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "description": "Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ",
                "example": "2016-06-25T20:09:23.69Z"
              },
              "modifiedAt": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "description": "Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ",
                "example": "2016-06-25T20:09:23.69Z"
              },
              "customData": {
                "type": "string",
                "writeOnly": true,
                "description": "User-specific meta data. This can hold anything.",
                "additionalProperties": {
                  "type": "object"
                }
              }
            }
          }
        ]
      },
      "BitmovinResponse": {
        "title": "BitmovinResponse",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true,
            "description": "Id of the resource",
            "example": "cb90b80c-8867-4e3b-8479-174aa2843f62"
          }
        }
      },
      "AzureSpeechServicesCredentials": {
        "title": "AzureSpeechServicesCredentials",
        "required": [
          "subscriptionKey"
        ],
        "properties": {
          "subscriptionKey": {
            "type": "string",
            "description": "Azure Speech Services resource key\n",
            "example": "qhfwm24amag3xunttqzl307gpthvh3vt",
            "writeOnly": true
          }
        }
      },
      "AzureSpeechToCaptionsProfanity": {
        "title": "AzureSpeechToCaptionsProfanity",
        "type": "string",
        "default": "MASKED",
        "enum": [
          "MASKED",
          "REMOVED",
          "RAW"
        ],
        "x-enum-elements": [
          {
            "name": "MASKED"
          },
          {
            "name": "REMOVED"
          },
          {
            "name": "RAW"
          }
        ]
      },
      "AzureSpeechToCaptionsSettings": {
        "title": "AzureSpeechToCaptionsSettings",
        "required": [
          "subscriptionKey"
        ],
        "properties": {
          "azureSpeechServicesCredentials": {
            "description": "Credential settings to access Azure Speech Services\n",
            "writeOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/AzureSpeechServicesCredentials"
              }
            ]
          },
          "region": {
            "type": "string",
            "description": "Azure Speech Services Region Identifier. The list of speech service supported regions can be\nfound at Azure's official documentation.\n",
            "example": "westeurope"
          },
          "apiEndpoint": {
            "type": "string",
            "description": "Azure Speech Services API endpoint. This information can be found in Azure's Speech resource data.\n",
            "example": "https://westeurope.api.cognitive.microsoft.com/"
          },
          "language": {
            "type": "string",
            "description": "Azure Speech to captions supported language (IETF BCP 47 language tag).\nThe list of supported languages can be found at Azure's official documentation.\n",
            "example": "en-US",
            "default": "en-US"
          },
          "captionDelay": {
            "type": "integer",
            "format": "int64",
            "description": "How many MILLISECONDS to delay the display of each caption, to mimic a real-time experience.\nThe minimum value is 0.\n",
            "default": 100,
            "example": 100
          },
          "captionRemainTime": {
            "type": "integer",
            "format": "int64",
            "description": "How many MILLISECONDS a caption should remain on screen if it is not replaced by another.\nThe minimum value is 0.\n",
            "default": 1000,
            "example": 1000
          },
          "captionMaxLineLength": {
            "type": "integer",
            "format": "int64",
            "description": "The maximum number of characters per line for a caption. \nThe minimum value is 20.\n",
            "default": 40,
            "example": 40
          },
          "captionLines": {
            "type": "integer",
            "format": "int64",
            "description": "The number of lines for a caption.\nThe minimum value is 1.\n",
            "default": 2,
            "example": 2
          },
          "profanityOption": {
            "description": "The profanity filter options are:\n\n- Masked: Replaces letters in profane words with asterisk (*) characters.\n- Raw: Include the profane words verbatim.\n- Removed: Removes profane words.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/AzureSpeechToCaptionsProfanity"
              }
            ]
          }
        }
      },
      "AzureSpeechToCaptionsFilter": {
        "title": "AzureSpeechToCaptionsFilter",
        "required": [
          "azureSpeechToCaptionsSettings"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/Filter"
          },
          {
            "properties": {
              "azureSpeechToCaptionsSettings": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/AzureSpeechToCaptionsSettings"
                  }
                ]
              }
            }
          }
        ]
      },
      "Filter": {
        "title": "Filter",
        "required": [
          "type"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/BitmovinResource"
          }
        ]
      },
      "Link": {
        "title": "Link",
        "required": [
          "href"
        ],
        "properties": {
          "href": {
            "type": "string",
            "description": "webpage target URL",
            "example": "https://bitmovin.com/encoding-documentation/bitmovin-api/#/reference/encoding/manifests/add-period"
          },
          "title": {
            "type": "string",
            "description": "Short description of the linked page",
            "example": "how to add a period to a manifest"
          }
        }
      },
      "Message": {
        "title": "Message",
        "required": [
          "type",
          "text"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/BitmovinResponse"
          },
          {
            "properties": {
              "type": {
                "description": "Message type giving a hint on the importance of the message (log level)",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessageType"
                  }
                ]
              },
              "text": {
                "type": "string",
                "description": "Message text",
                "example": "field must not be empty"
              },
              "field": {
                "type": "string",
                "description": "Name of the field to which the message is referring to",
                "example": "manifestId"
              },
              "links": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Link"
                },
                "description": "collection of links to webpages containing further information on the topic"
              },
              "more": {
                "type": "object",
                "description": "Service-specific information"
              },
              "date": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp when the message occurred",
                "example": "2016-06-25T20:09:23.69Z"
              }
            }
          }
        ]
      },
      "MessageType": {
        "title": "MessageType",
        "type": "string",
        "enum": [
          "ERROR",
          "WARNING",
          "INFO",
          "DEBUG",
          "TRACE"
        ]
      },
      "PaginationResponse": {
        "title": "PaginationResponse",
        "properties": {
          "totalCount": {
            "type": "integer",
            "format": "int64",
            "readOnly": true
          },
          "offset": {
            "type": "integer",
            "format": "int32",
            "readOnly": true
          },
          "limit": {
            "type": "integer",
            "format": "int32",
            "readOnly": true
          },
          "previous": {
            "type": "string",
            "readOnly": true
          },
          "next": {
            "type": "string",
            "readOnly": true
          },
          "items": {
            "type": "array",
            "readOnly": true,
            "items": {
              "type": "object"
            }
          }
        }
      },
      "ResponseEnvelope": {
        "title": "ResponseEnvelope",
        "required": [
          "requestId",
          "status",
          "data"
        ],
        "properties": {
          "requestId": {
            "type": "string",
            "readOnly": true,
            "description": "Unique correlation id",
            "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333"
          },
          "status": {
            "description": "Response status information",
            "readOnly": true,
            "example": "SUCCESS",
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ]
          },
          "data": {
            "description": "Response information",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/ResultWrapper"
              }
            ]
          },
          "more": {
            "type": "object",
            "description": "Additional endpoint specific information"
          }
        }
      },
      "ResponseError": {
        "title": "ResponseError",
        "required": [
          "requestId",
          "status",
          "data"
        ],
        "properties": {
          "requestId": {
            "type": "string",
            "readOnly": true,
            "description": "Unique correlation id",
            "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333"
          },
          "status": {
            "description": "Response status information",
            "readOnly": true,
            "example": "ERROR",
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ]
          },
          "data": {
            "description": "Response information",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseErrorData"
              }
            ]
          }
        }
      },
      "ResponseErrorData": {
        "title": "ResponseErrorData",
        "required": [
          "code",
          "message",
          "developerMessage"
        ],
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32",
            "readOnly": true,
            "description": "Contains an error code as defined in https://bitmovin.com/encoding-documentation/bitmovin-api/#/introduction/api-error-codes\n",
            "example": 1005
          },
          "message": {
            "type": "string",
            "readOnly": true,
            "description": "General error message"
          },
          "developerMessage": {
            "type": "string",
            "readOnly": true,
            "description": "More detailed message meant for developers"
          },
          "links": {
            "type": "array",
            "readOnly": true,
            "items": {
              "$ref": "#/components/schemas/Link"
            },
            "description": "collection of links to webpages containing further information on the topic"
          },
          "details": {
            "type": "array",
            "readOnly": true,
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "description": "collection of messages containing more detailed information on the cause of the error"
          }
        }
      },
      "ResponseStatus": {
        "title": "ResponseStatus",
        "type": "string",
        "enum": [
          "SUCCESS",
          "ERROR"
        ]
      },
      "ResultWrapper": {
        "title": "ResultWrapper",
        "properties": {
          "result": {
            "type": "object",
            "readOnly": true
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Azure Speech To Captions Filter"
    }
  ]
}
```