Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Stream Subtitles/Captions API

The Stream Subtitles/Captions API from APIs.io Engineering Platform — 4 operation(s) for stream subtitles/captions.

This API exposes 6 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

6 operations 4 paths 14 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Stream Subtitles/Captions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Stream Subtitles/Captions 6
GET
/accounts/{account_id}/stream/{identifier}/captions
APIs.io Engineering Platform List captions or subtitles
stream-subtitles/-captions-list-captions-or-subtitles 2 params → 4XX200
DELETE
/accounts/{account_id}/stream/{identifier}/captions/{language}
APIs.io Engineering Platform Delete captions or subtitles
stream-subtitles/-captions-delete-captions-or-subtitles 3 params body → 4XX200
GET
/accounts/{account_id}/stream/{identifier}/captions/{language}
APIs.io Engineering Platform List captions or subtitles for a provided language
stream-subtitles/-captions-get-caption-or-subtitle-for-language 3 params → 4XX200
PUT
/accounts/{account_id}/stream/{identifier}/captions/{language}
APIs.io Engineering Platform Upload captions or subtitles
stream-subtitles/-captions-upload-captions-or-subtitles 3 params body → 4XX200
POST
/accounts/{account_id}/stream/{identifier}/captions/{language}/generate
APIs.io Engineering Platform Generate captions or subtitles for a provided language via AI
stream-subtitles/-captions-generate-caption-or-subtitle-for-language 3 params → 4XX200
GET
/accounts/{account_id}/stream/{identifier}/captions/{language}/vtt
APIs.io Engineering Platform Return WebVTT captions for a provided language
stream-subtitles/-captions-get-vtt-caption-or-subtitle 3 params body → 4XX200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are stream_api-response-common-failure (4 properties), stream_captions (4 properties), stream_api-response-common (3 properties), stream_caption_basic_upload (1 property). Each schema is shown below with its type and property counts.

stream_caption_basic_upload
object
1 property 1 required
stream_api-response-single
object
stream_generated_caption
boolean
Whether the caption was generated via AI.
stream_schemas-identifier
string
Identifier
stream_language_response_single
stream_language_response_collection
stream_api-response-common-failure
object
4 properties 4 required
stream_api-response-common
object
3 properties 3 required
stream_label
string
The language label displayed in the native language to users.
stream_language
string
The language tag in BCP 47 format.
stream_messages
array
stream_caption_status
string
The status of a generated caption.
stream_captions
object
4 properties
stream_identifier
string
A Cloudflare-generated unique identifier for a media item.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-stream-subtitles-captions-api-openapi.yml Raw ↑