API Reference
Bitmovin PlatformPlaybackEncodingBitmovin Dashboard

Create Live Analysis

post
https://api.bitmovin.com/v1/ai-scene-analysis/live-analyses

Creates a Live Analysis. Start the Analysis using the start operation.
If creation fails after an Analysis resource has been created, the error response includes
a Location header identifying the Analysis so its failure details can be retrieved.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Live Analysis configuration

Configuration for a Live Analysis. Each recording and analysis destination references an existing Encoding Output or provides an inline Output definition. Inline Outputs are created synchronously. Within this request, identical complete inline Output definitions, including credentials, are created once and reused across all destinations; destination paths and ACLs do not affect that reuse.

string

Name of the Analysis

string
required
length between 3 and 20
^[a-zA-Z]+$

Key used to publish the RTMP stream. When the Live Analysis is RUNNING, the Get Live Analysis details response returns the current value in ingest.streamKey.

string
enum

Region in which the AI analysis runs. EXTERNAL is not supported yet.

recording
object
required

Destinations for the stream recording

outputs
array of objects
required
length ≥ 1

Destinations for cumulative AI analysis results

outputs*
string
required

ID of an existing Encoding Output owned by the organization. Set either this property or output, but not both.

output
object

Inline definition of a concrete, publicly creatable Encoding Output to create synchronously. Only properties defined by the selected concrete Output type are accepted; internal types and properties are not supported. Deprecated properties that remain supported by the Encoding Output creation API are accepted. Set either this property or outputId, but not both. Put ACL entries on the destination-level acl property, not in this resource definition. The created Output is an ordinary reusable Encoding resource and is not automatically deleted with the Live Analysis or after provisioning failure.

string
required

Subdirectory where files are written. This destination setting is not part of the inline Output resource definition.

acl
array of objects

Determines accessibility of files written to this destination. Only applies to Output types that support ACLs. Defaults to PUBLIC_READ if the list is empty.

acl
Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?