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 Watermark Profile API

The Stream Watermark Profile API from APIs.io Engineering Platform — 2 operation(s) for stream watermark profile.

This API exposes 4 operations across 2 paths, and defines 20 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.

4 operations 2 paths 20 schemas 1 DELETE2 GET1 POST

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 Watermark Profile 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 4

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

Stream Watermark Profile 4
GET
/accounts/{account_id}/stream/watermarks
APIs.io Engineering Platform List watermark profiles
stream-watermark-profile-list-watermark-profiles 1 param → 4XX200
POST
/accounts/{account_id}/stream/watermarks
APIs.io Engineering Platform Create watermark profiles via basic upload
stream-watermark-profile-create-watermark-profiles-via-basic-upload 1 param body → 4XX200
DELETE
/accounts/{account_id}/stream/watermarks/{identifier}
APIs.io Engineering Platform Delete watermark profiles
stream-watermark-profile-delete-watermark-profiles 2 params body → 4XX200
GET
/accounts/{account_id}/stream/watermarks/{identifier}
APIs.io Engineering Platform Watermark profile details
stream-watermark-profile-watermark-profile-details 2 params → 4XX200

Schemas 20

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

stream_watermark_response_collection
stream_watermark_size
number
The size of the image in bytes.
stream_api-response-common
object
3 properties 3 required
stream_messages
array
stream_watermark_basic_upload
object
6 properties 1 required
stream_padding
number
The whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 indicates no padding, and 1.0 indicates a fully padded video…
stream_position
string
The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.
stream_watermark_response_single
stream_width
integer
The width of the image in pixels.
stream_api-response-single
object
stream_account_identifier
string
The account identifier tag.
stream_name
string
A short description of the watermark profile.
stream_watermark_created
string
The date and a time a watermark profile was created.
stream_opacity
number
The translucency of the image. A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is alre…
stream_api-response-common-failure
object
4 properties 4 required
stream_watermarks
object
11 properties
stream_downloadedFrom
string
The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
stream_scale
number
The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no sc…
stream_watermark_identifier
string
The unique identifier for a watermark profile.
stream_height
integer
The height of the image in pixels.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-stream-watermark-profile-api-openapi.yml Raw ↑