Skip to main content
API docs by Redocly

Media API (v1)

Download OpenAPI specification:Download

EncodingPresets

Create an encoding preset

Authorizations:
Cloudmix
Request Body schema: application/json
name
required
string
description
string or null
required
object (CreatePresetEncodingProfileDto)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "encodingProfile": {
    }
}

Response samples

Content type
application/json
{
  • "encodingPresetId": "107e66cb-75e1-4c28-99f2-42649b92366b"
}

List encoding presets

Authorizations:
Cloudmix
query Parameters
PageIndex
integer <int32>
PageSize
integer <int32> [ 1 .. 50 ]
Array of objects (EncodingPresetOrderByFieldDtoOrderByReqDto)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "totalCount": 0
}

Update an encoding preset

Authorizations:
Cloudmix
path Parameters
encodingPresetId
required
string <uuid>
Request Body schema: application/json
name
string or null
description
string or null
object (UpdatePresetEncodingProfileDto)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "encodingProfile": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get an encoding preset

Authorizations:
Cloudmix
path Parameters
encodingPresetId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "encodingPresetId": "107e66cb-75e1-4c28-99f2-42649b92366b",
  • "name": "string",
  • "description": "string",
  • "encodingProfile": {
    },
  • "isReadOnly": true
}

Delete an encoding preset

Authorizations:
Cloudmix
path Parameters
encodingPresetId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

LiveInputs

Create a live input

Authorizations:
Cloudmix
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "liveInputId": "f9376e27-e7ac-413f-995e-354cceb3bf42"
}

List live inputs

Authorizations:
Cloudmix
query Parameters
PageIndex
integer <int32>
PageSize
integer <int32> [ 1 .. 50 ]
Array of objects (LiveInputOrderByFieldDtoOrderByReqDto)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "totalCount": 0
}

Get a live input

Authorizations:
Cloudmix
path Parameters
liveInputId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "liveInputId": "f9376e27-e7ac-413f-995e-354cceb3bf42",
  • "name": "string",
  • "protocols": [
    ],
  • "status": "connected",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastUpdatedAt": "2019-08-24T14:15:22Z"
}

Update a live input

Authorizations:
Cloudmix
path Parameters
liveInputId
required
string <uuid>
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete a live input

Authorizations:
Cloudmix
path Parameters
liveInputId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

LiveOutputs

Create a live output

Authorizations:
Cloudmix
Request Body schema: application/json
name
required
string
required
object (StreamingProtocol)
object (CreateLiveOutputEncodingProfileDto)
encodingPresetId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "protocol": {
    },
  • "encodingProfile": {
    },
  • "encodingPresetId": "107e66cb-75e1-4c28-99f2-42649b92366b"
}

Response samples

Content type
application/json
{
  • "liveOutputId": "15a35d33-23b3-4437-80c7-0ddbc2c6eb4c"
}

List live outputs

Authorizations:
Cloudmix
query Parameters
PageIndex
integer <int32>
PageSize
integer <int32> [ 1 .. 50 ]
Array of objects (LiveOutputOrderByFieldDtoOrderByReqDto)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "totalCount": 0
}

Update a live output

Authorizations:
Cloudmix
path Parameters
liveOutputId
required
string <uuid>
Request Body schema: application/json
name
string or null
object (StreamingProtocol)
object (UpdateLiveOutputEncodingProfileDto)
encodingPresetId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "protocol": {
    },
  • "encodingProfile": {
    },
  • "encodingPresetId": "107e66cb-75e1-4c28-99f2-42649b92366b"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get a live output

Authorizations:
Cloudmix
path Parameters
liveOutputId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "liveOutputId": "15a35d33-23b3-4437-80c7-0ddbc2c6eb4c",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastUpdatedAt": "2019-08-24T14:15:22Z",
  • "protocol": {
    },
  • "encodingProfile": {
    },
  • "encodingPresetId": "107e66cb-75e1-4c28-99f2-42649b92366b"
}

Delete a live output

Authorizations:
Cloudmix
path Parameters
liveOutputId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Projects

Create a project

Authorizations:
Cloudmix
Request Body schema: application/json
name
required
string
description
string
required
object (MediaFormat)
object (Workflow)
defaultRegion
required
string
defaultReleaseChannel
string or null
defaultEnginePool
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "mediaFormat": {
    },
  • "workflow": {
    },
  • "defaultRegion": "string",
  • "defaultReleaseChannel": "string",
  • "defaultEnginePool": "string"
}

Response samples

Content type
application/json
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

List projects

Authorizations:
Cloudmix
query Parameters
PageIndex
integer <int32>
PageSize
integer <int32> [ 1 .. 50 ]
Array of objects (ProjectOrderByFieldDtoOrderByReqDto)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "totalCount": 0
}

Update a project

Authorizations:
Cloudmix
path Parameters
projectId
required
string <uuid>
Request Body schema: application/json
name
string or null
description
string or null
object (MediaFormat)
object (Workflow)
defaultRegion
string or null
defaultReleaseChannel
string or null
defaultEnginePool
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "mediaFormat": {
    },
  • "workflow": {
    },
  • "defaultRegion": "string",
  • "defaultReleaseChannel": "string",
  • "defaultEnginePool": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get a project

Authorizations:
Cloudmix
path Parameters
projectId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "name": "string",
  • "description": "string",
  • "mediaFormat": {
    },
  • "workflow": {
    },
  • "defaultRegion": "string",
  • "defaultReleaseChannel": "string",
  • "defaultEnginePool": "string",
  • "status": "starting",
  • "workflowSessionId": "42a071b4-3252-4bd6-b1f4-e326e9644cbc",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastUpdatedAt": "2019-08-24T14:15:22Z"
}

Delete a project

Authorizations:
Cloudmix
path Parameters
projectId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Start a project

Authorizations:
Cloudmix
path Parameters
projectId
required
string <uuid>
Request Body schema: application/json
enginePool
string or null
region
string or null
object (EngineSpecifications)
releaseChannel
string or null
engineId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "enginePool": "string",
  • "region": "string",
  • "minSpecifications": {
    },
  • "releaseChannel": "string",
  • "engineId": "1d1171e5-21f6-46a2-a7f3-79a56b93fba8"
}

Response samples

Content type
application/json
{
  • "workflowSessionId": "42a071b4-3252-4bd6-b1f4-e326e9644cbc"
}

Stop a project

Authorizations:
Cloudmix
path Parameters
projectId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Usage

Get workflow session usage

Authorizations:
Cloudmix
query Parameters
required
object (DateTimeTimestampDto)
required
object (DateTimeTimestampDto)
PageIndex
integer <int32>
PageSize
integer <int32> [ 1 .. 50 ]

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "totalCount": 0
}

Get total workflow session duration

Authorizations:
Cloudmix
query Parameters
required
object (DateTimeTimestampDto)
required
object (DateTimeTimestampDto)

Responses

Response samples

Content type
application/json
{
  • "totalDuration": "string"
}

WorkflowSessions

Get a workflow session

Authorizations:
Cloudmix
path Parameters
workflowSessionId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "workflowSessionId": "42a071b4-3252-4bd6-b1f4-e326e9644cbc",
  • "name": "string",
  • "workflow": {
    },
  • "mediaFormat": {
    },
  • "status": "starting",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "stoppedAt": "2019-08-24T14:15:22Z",
  • "engineId": "1d1171e5-21f6-46a2-a7f3-79a56b93fba8",
  • "parentResource": {
    }
}

List workflow sessions

Authorizations:
Cloudmix
query Parameters
PageIndex
integer <int32>
PageSize
integer <int32> [ 1 .. 50 ]
Status
string (WorkflowSessionStatus)
Enum: "starting" "active" "stopping" "stopped" "failed"
ParentResourceId
string <uuid>
Array of objects (WorkflowSessionOrderByFieldDtoOrderByReqDto)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "totalCount": 0
}

Add a component to a workflow session

Authorizations:
Cloudmix
path Parameters
workflowSessionId
required
string <uuid>
Request Body schema: application/json
required
object (Component)
tokenExpiry
string or null <date-span>
lobbyPassword
string or null
Array of objects (AudioVideoInputPad)
type
required
string
componentId
required
string
displayName
string or null

Responses

Request samples

Content type
application/json
{
  • "component": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Update a component in a workflow session

Authorizations:
Cloudmix
path Parameters
workflowSessionId
required
string <uuid>
componentId
required
string
Request Body schema: application/json
required
object
additional property
object (JsonNode)
object (JsonNode)

Responses

Request samples

Content type
application/json
{
  • "values": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Remove a component from a workflow session

Authorizations:
Cloudmix
path Parameters
workflowSessionId
required
string <uuid>
componentId
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Add a link to a workflow session

Authorizations:
Cloudmix
path Parameters
workflowSessionId
required
string <uuid>
Request Body schema: application/json
required
object (Link)
required
object (PadReference)
required
object (PadReference)

Responses

Request samples

Content type
application/json
{
  • "link": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Remove a link from a workflow session

Authorizations:
Cloudmix
path Parameters
workflowSessionId
required
string <uuid>
linkId
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Execute a command on a workflow session

Authorizations:
Cloudmix
path Parameters
workflowSessionId
required
string <uuid>
Request Body schema: application/json
required
object (RemoteCommand)
componentId
string or null

Responses

Request samples

Content type
application/json
{
  • "command": {
    },
  • "componentId": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

MediaExports

List all media exports

Authorizations:
Cloudmix
query Parameters
PageIndex
integer <int32>
PageSize
integer <int32> [ 1 .. 50 ]
Array of objects (MediaExportOrderByFieldDtoOrderByReqDto)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "totalCount": 0
}

Get a media export

Authorizations:
Cloudmix
path Parameters
mediaExportId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "mediaExportId": "091dd9b1-73d3-4cbd-aa8d-5480d62a36d2",
  • "format": "mp4",
  • "status": "processing"
}

Delete a media export

Authorizations:
Cloudmix
path Parameters
mediaExportId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Download a media export

Authorizations:
Cloudmix
path Parameters
mediaExportId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

MediaItemClips

Create a media item clip

Authorizations:
Cloudmix
Request Body schema: application/json
name
required
string
mediaItemId
required
string <uuid>
inTime
required
string <date-span>
outTime
required
string <date-span>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "mediaItemId": "4f8ad02a-e871-4be1-b126-4101e272c59a",
  • "inTime": "string",
  • "outTime": "string"
}

Response samples

Content type
application/json
{
  • "mediaItemClipId": "f2d31313-b296-44a7-859a-c10b22f05aef"
}

List media item clips

Authorizations:
Cloudmix
query Parameters
PageIndex
integer <int32>
PageSize
integer <int32> [ 1 .. 50 ]
Array of objects (MediaItemClipOrderByFieldDtoOrderByReqDto)
MediaItemId
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "totalCount": 0
}

Update a media item clip

Authorizations:
Cloudmix
path Parameters
mediaItemClipId
required
string <uuid>
Request Body schema: application/json
name
string or null
inTime
string or null <date-span>
outTime
string or null <date-span>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "inTime": "string",
  • "outTime": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get a media item clip

Authorizations:
Cloudmix
path Parameters
mediaItemClipId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "mediaItemClipId": "f2d31313-b296-44a7-859a-c10b22f05aef",
  • "name": "string",
  • "mediaItem": {
    },
  • "inTime": "string",
  • "outTime": "string",
  • "exports": [
    ]
}

Delete a media item clip

Authorizations:
Cloudmix
path Parameters
mediaItemClipId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Create a media item clip export

Authorizations:
Cloudmix
path Parameters
mediaItemClipId
required
string <uuid>
Request Body schema: application/json
format
required
string (MediaExportFormat)
Value: "mp4"

Responses

Request samples

Content type
application/json
{
  • "format": "mp4"
}

Response samples

Content type
application/json
{
  • "mediaExportId": "091dd9b1-73d3-4cbd-aa8d-5480d62a36d2"
}

List media item clip exports

Authorizations:
Cloudmix
path Parameters
mediaItemClipId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Recordings

Update a recording

Authorizations:
Cloudmix
path Parameters
recordingId
required
string <uuid>
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get a recording

Authorizations:
Cloudmix
path Parameters
recordingId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "recordingId": "bbd0b35c-32e1-4c5f-b1be-7f8fdbe015f2",
  • "name": "string",
  • "workflowSessionId": "42a071b4-3252-4bd6-b1f4-e326e9644cbc",
  • "mediaItem": {
    },
  • "startedAt": "2019-08-24T14:15:22Z",
  • "stoppedAt": "2019-08-24T14:15:22Z",
  • "componentId": "string",
  • "padName": "string"
}

Delete a recording

Authorizations:
Cloudmix
path Parameters
recordingId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

List recordings

Authorizations:
Cloudmix
query Parameters
PageIndex
integer <int32>
PageSize
integer <int32> [ 1 .. 50 ]
Array of objects (RecordingOrderByFieldDtoOrderByReqDto)
WorkflowSessionId
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "totalCount": 0
}

Regions

List available regions

Authorizations:
Cloudmix
query Parameters
PageIndex
integer <int32>
PageSize
integer <int32> [ 1 .. 50 ]

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "totalCount": 0
}

Get region details

Authorizations:
Cloudmix
path Parameters
regionName
required
string

Responses

Response samples

Content type
application/json
{
  • "regionName": "string",
  • "friendlyName": "string"
}