API Reference

Creates a new annotation on an asset.

post
https://localhost:44395/api/asset//annotation

Behavior: Adds a new annotation (marker, comment, or note) to the specified asset. Annotations can include timecodes for video assets, spatial coordinates for images, and descriptive text. The created annotation is returned with its generated ID.

Authorization: Requires a valid Bearer token.

Side Effects: A new annotation record is created for the asset.

Error Scenarios: Returns 400 if the request body is missing. Returns 401 if the caller is not authenticated.

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

The unique identifier of the asset to annotate.

Body Params

The annotation details including text, timecode, and position.

Represents a request to add a new annotation to a media asset, defining a time range and associated properties.

uuid | null

Gets or sets the unique identifier of the annotation; if null, a new identifier will be generated.

string | null

Gets or sets the timecode where the annotation begins.

string | null

Gets or sets the timecode where the annotation ends.

properties
object | null

Gets or sets the dictionary of custom properties associated with the annotation.

uuid

Gets or sets the content identifier used internally for processing.

string | null

Gets or sets the URL of the image associated with the annotation, used internally for processing.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Updated about 21 hours ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 21 hours ago