Wavestream API (1.29.0)

Download OpenAPI specification:Download

E-mail: contact@wavestreamlabs.com URL: https://www.wavestreamlabs.com License: MIT Terms of Service

This site will describe wavestream api and show you some client examples in multiple languages.

Ping

Checking service reachability

Pinging the service

Checking service reachability. If a 200 is sent back, the service is up and reachable, however, it does not mean that the service is healthy.

Responses

Response samples

Content type

application/json

{"Status": "OK"
}

Video

Video processing operations

Create a new video

Create a new video.

Authorizations:

apiKeyAuth

Request Body schema: application/json

video to create in the system

title required	string The title of the video
description	string The description of the video
skipProcessing	boolean Default: false Flag to disable (skip) the processing steps
accessType	string Default: "public" Enum: "public" "private" define the accessType of the video, if private the video URI can only be accessed with a signed url

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"skipProcessing": false,
"accessType": "public"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"status": "empty",
"skipProcessing": false,
"accessType": "public",
"transcodedAt": "2019-08-24T14:15:22Z",
"errorMessage": "string",
"destinationUri": "http://example.com",
"input": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"format": "string",
"videoCodec": "string",
"audioCodec": "string",
"quality": "string",
"uri": "http://example.com",
"duration": 0,
"width": 0,
"height": 0,
"bitrate": "string",
"aspectRatio": "string",
"size": 0
},
"outputs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"format": "string",
"videoCodec": "string",
"audioCodec": "string",
"quality": "string",
"masterPlaylistUri": "http://example.com",
"uri": "http://example.com",
"duration": 0,
"width": 0,
"height": 0,
"bitrate": 0,
"aspectRatio": "string",
"posterUri": "string",
"size": 0
}
],
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Index of videos

Authorizations:

apiKeyAuth

query Parameters

title	string <string> The video title. By default, all the titles that contains the string provided will be returned. Use eq() if you want to get an exact match.
createdAt	string <string> The date to compare with creation date. Use date format yyyy-mm-yy, use gt(), lt() before the date for greater than or less than.
updateddAt	string <string> The date to compare with the last update date. Use date format yyyy-mm-yy, use gt(), lt() before the date for greater than or less than.
sort	string <string> Use to sort results. You can specify by which value it will be sorted. example - "sort=title:asc" "sort=createdAt:desc"
page	integer <int32> The number of the page you want to get. Default value = 1
pageSize	integer <int32> The number of element a page can contains. Default value = 10

Responses

Response samples

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"status": "empty",
"skipProcessing": false,
"accessType": "public",
"transcodedAt": "2019-08-24T14:15:22Z",
"errorMessage": "string",
"destinationUri": "http://example.com",
"input": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"format": "string",
"videoCodec": "string",
"audioCodec": "string",
"quality": "string",
"uri": "http://example.com",
"duration": 0,
"width": 0,
"height": 0,
"bitrate": "string",
"aspectRatio": "string",
"size": 0
},
"outputs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"format": "string",
"videoCodec": "string",
"audioCodec": "string",
"quality": "string",
"masterPlaylistUri": "http://example.com",
"uri": "http://example.com",
"duration": 0,
"width": 0,
"height": 0,
"bitrate": 0,
"aspectRatio": "string",
"posterUri": "string",
"size": 0
}
],
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {"page": 0,
"pageSize": 0,
"totalNbOfItems": 0
}
}

Update a video

Update a video.

Authorizations:

apiKeyAuth

path Parameters

videoId

required

string <uuid>

the uuid of the video

Request Body schema: application/json

video to update in the system

title	string The title of the video
description	string The description of the video
skipProcessing	boolean Default: false Flag to disable (skip) the processing steps
accessType	string Default: "public" Enum: "public" "private" define the accessType of the video, if private the video URI can only be accessed with a signed url

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"skipProcessing": false,
"accessType": "public"
}

Response samples

Content type

application/problem+json

{"type": "urn:problem-type:belgif:payloadTooLarge",
"href": "https://www.belgif.be/specification/rest/api-guide/problems/payloadTooLarge.html",
"title": "Payload Too Large",
"status": 413,
"detail": "Request message must not be larger than 10 MB",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
"limit": 10485760
}

Delete a video

Delete the video matching the given id

Authorizations:

apiKeyAuth

path Parameters

videoId

required

string <uuid>

the uuid of the video

Responses

Response samples

Content type

application/problem+json

{"type": "urn:problem-type:belgif:payloadTooLarge",
"href": "https://www.belgif.be/specification/rest/api-guide/problems/payloadTooLarge.html",
"title": "Payload Too Large",
"status": 413,
"detail": "Request message must not be larger than 10 MB",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
"limit": 10485760
}

Get a video

Fetch a single video

Authorizations:

apiKeyAuth

path Parameters

videoId

required

string <uuid>

the uuid of the video

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"status": "empty",
"skipProcessing": false,
"accessType": "public",
"transcodedAt": "2019-08-24T14:15:22Z",
"errorMessage": "string",
"destinationUri": "http://example.com",
"input": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"format": "string",
"videoCodec": "string",
"audioCodec": "string",
"quality": "string",
"uri": "http://example.com",
"duration": 0,
"width": 0,
"height": 0,
"bitrate": "string",
"aspectRatio": "string",
"size": 0
},
"outputs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"format": "string",
"videoCodec": "string",
"audioCodec": "string",
"quality": "string",
"masterPlaylistUri": "http://example.com",
"uri": "http://example.com",
"duration": 0,
"width": 0,
"height": 0,
"bitrate": 0,
"aspectRatio": "string",
"posterUri": "string",
"size": 0
}
],
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

User

User management operations

Get the user's info

Authorizations:

accessTokenAuth

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"auth0Id": "string",
"username": "string",
"email": "string",
"avatarUri": "http://example.com",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

App

App management operations

Index of applications

Authorizations:

accessTokenAuth

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"secretKey": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"s3AccessKey": "string",
"s3SecretKey": "string",
"s3Region": "string",
"s3Endpoint": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

Get an app

Fetch a single app

Authorizations:

accessTokenAuth

path Parameters

appId

required

string <string>

the id of the app

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"secretKey": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"s3AccessKey": "string",
"s3SecretKey": "string",
"s3Region": "string",
"s3Endpoint": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update an app

Update an app.

Authorizations:

accessTokenAuth

path Parameters

appId

required

string <string>

the id of the app

Request Body schema: application/json

app to update in the system

s3AccessKey	string The S3 access key
S3SecretKey	string The S3 secret key
S3Region	string The S3 region
S3Endpoint	string The S3 endpoint

Responses

Request samples

Payload

Content type

application/json

{"s3AccessKey": "string",
"S3SecretKey": "string",
"S3Region": "string",
"S3Endpoint": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"secretKey": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"s3AccessKey": "string",
"s3SecretKey": "string",
"s3Region": "string",
"s3Endpoint": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Renew the api key

Authorizations:

accessTokenAuth

path Parameters

appId

required

string <string>

the id of the app

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"secretKey": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"s3AccessKey": "string",
"s3SecretKey": "string",
"s3Region": "string",
"s3Endpoint": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Webhook

Webhook management operations

Create a new webhook

Create a new webhook.

Authorizations:

apiKeyAuth

Request Body schema: application/json

webhook to create in the system

events required	Array of strings (Event) Items Enum: "upload.complete" "transcoding.complete" Events which trigger the webhook
endpoint required	string Endpoint to send the query

Responses

Request samples

Payload

Content type

application/json

{"events": ["upload.complete"
],
"endpoint": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"events": ["upload.complete"
],
"endpoint": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Index of webhooks

Authorizations:

apiKeyAuth

query Parameters

endpoint	string <string> A text contained in the webhook endpoint.
createdAt	string <string> The date to compare with creation date. Use date format yyyy-mm-yy, use gt(), lt() before the date for greater than or less than.
updateddAt	string <string> The date to compare with the last update date. Use date format yyyy-mm-yy, use gt(), lt() before the date for greater than or less than.
sort	string <string> Use to sort results. You can specify by which value it will be sorted. example - "sort=title:asc" "sort=createdAt:desc"
pageSize	integer <int32> The number of element a page can contains. Default value = 10
page	integer <int32> The number of the page you want to get. Default value = 1

Responses

Response samples

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"events": ["upload.complete"
],
"endpoint": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {"page": 0,
"pageSize": 0,
"totalNbOfItems": 0
}
}

Update a webhook

Update a webhook.

Authorizations:

apiKeyAuth

path Parameters

webhookId

required

string <uuid>

the uuid of the webhook

Request Body schema: application/json

webhook to update in the system

events	Array of strings (Event) Items Enum: "upload.complete" "transcoding.complete" Events which trigger the webhook
endpoint	string Endpoint to send the query

Responses

Request samples

Payload

Content type

application/json

{"events": ["upload.complete"
],
"endpoint": "string"
}

Response samples

Content type

application/problem+json

{"type": "urn:problem-type:belgif:payloadTooLarge",
"href": "https://www.belgif.be/specification/rest/api-guide/problems/payloadTooLarge.html",
"title": "Payload Too Large",
"status": 413,
"detail": "Request message must not be larger than 10 MB",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
"limit": 10485760
}

Delete a webhook

Delete the webhook matching the given id

Authorizations:

apiKeyAuth

path Parameters

webhookId

required

string <uuid>

the uuid of the webhook

Responses

Response samples

Content type

application/problem+json

{"type": "urn:problem-type:belgif:payloadTooLarge",
"href": "https://www.belgif.be/specification/rest/api-guide/problems/payloadTooLarge.html",
"title": "Payload Too Large",
"status": 413,
"detail": "Request message must not be larger than 10 MB",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
"limit": 10485760
}

Get a webhook

Fetch a single webhook

Authorizations:

apiKeyAuth

path Parameters

webhookId

required

string <uuid>

the uuid of the webhook

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"events": ["upload.complete"
],
"endpoint": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Workflow

Deprecated, please use Workflow-definition and Workflow-execution instead.

Create a new workflow Deprecated

Create a new workflow.

Authorizations:

apiKeyAuth

Request Body schema: application/json

workflow to create

name required	string The name of the workflow
description	string The description of the workflow

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Index workflows Deprecated

Index workflows

Authorizations:

apiKeyAuth

query Parameters

sort	string <string> Use to sort results. You can specify by which value it will be sorted. example - "sort=title:asc" "sort=createdAt:desc"
page	integer <int32> The number of the page you want to get. Default value = 1
pageSize	integer <int32> The number of element a page can contains. Default value = 10

Responses

Response samples

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {"page": 0,
"pageSize": 0,
"totalNbOfItems": 0
}
}

Get a workflow Deprecated

Fetch a workflow

Authorizations:

apiKeyAuth

path Parameters

workflowId

required

string <uuid>

the uuid of the workflow

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update a workflow Deprecated

Update a workflow.

Authorizations:

apiKeyAuth

path Parameters

workflowId

required

string <uuid>

the uuid of the workflow

Request Body schema: application/json

workflow to update

name	string The name of the workflow
description	string The description of the workflow

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

Content type

application/problem+json

{"type": "urn:problem-type:belgif:payloadTooLarge",
"href": "https://www.belgif.be/specification/rest/api-guide/problems/payloadTooLarge.html",
"title": "Payload Too Large",
"status": 413,
"detail": "Request message must not be larger than 10 MB",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
"limit": 10485760
}

Delete a workflow Deprecated

Delete the workflow.

Authorizations:

apiKeyAuth

path Parameters

workflowId

required

string <uuid>

the uuid of the workflow

Responses

Response samples

Content type

application/problem+json

{"type": "urn:problem-type:belgif:payloadTooLarge",
"href": "https://www.belgif.be/specification/rest/api-guide/problems/payloadTooLarge.html",
"title": "Payload Too Large",
"status": 413,
"detail": "Request message must not be larger than 10 MB",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
"limit": 10485760
}

Execute a workflow Deprecated

(Deprecated) Execute a workflow. Use a POST request to /workflow-executions instead

Authorizations:

apiKeyAuth

path Parameters

workflowId

required

string <uuid>

the uuid of the workflow

Request Body schema: application/json

Params to be passed to the workflow which will be executed.

	object (AiaEncode)
	Array of objects (clipParams)
	Array of objects (overlayParamsDeprecated)
	object (publishParams)

Responses

Request samples

Payload

Content type

application/json

{"aiaEncode": {"videoId": "3524e86f-1bba-489a-bf6b-386ea1abbac0",
"inputBucket": "string",
"inputKey": "string"
},
"clips": [{"inputUri": "http://example.com",
"start": 0,
"end": 0,
"overlays": [{"pictureUri": "http://example.com",
"pictureBase64": "string",
"text": "string",
"textSize": 0,
"startTime": 0,
"endTime": 0,
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"rotation": 0
}
]
}
],
"overlays": [{"pictureUri": "http://example.com",
"pictureBase64": "string",
"text": "string",
"textSize": 0,
"startTime": 0,
"endTime": 0,
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"rotation": 0
}
],
"publish": {"inputUri": "string",
"outputDescription": "string",
"outputFilename": "string",
"outputTitle": "string",
"accessType": "private"
}
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "running",
"params": { },
"result": { },
"error": "string",
"workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
"workflow": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"appId": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"type": "clip",
"needs": ["string"
],
"status": "running",
"error": { },
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Run

Deprecated, please use Workflow-definition and Workflow-execution instead.

Index runs Deprecated

Index runs

Authorizations:

apiKeyAuth

query Parameters

sort	string <string> Use to sort results. You can specify by which value it will be sorted. example - "sort=title:asc" "sort=createdAt:desc"
page	integer <int32> The number of the page you want to get. Default value = 1
pageSize	integer <int32> The number of element a page can contains. Default value = 10

Responses

Response samples

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "running",
"params": { },
"result": { },
"error": "string",
"workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
"workflow": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"appId": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"type": "clip",
"needs": ["string"
],
"status": "running",
"error": { },
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
],
"pagination": {"page": 0,
"pageSize": 0,
"totalNbOfItems": 0
}
}

Get a run Deprecated

Fetch a single run

Authorizations:

apiKeyAuth

path Parameters

runId

required

string <uuid>

the uuid of the run

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "running",
"params": { },
"result": { },
"error": "string",
"workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
"workflow": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"appId": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"type": "clip",
"needs": ["string"
],
"status": "running",
"error": { },
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

WorkflowExecution

WorkflowExecution management operations

Index workflow executions

Authorizations:

apiKeyAuth

query Parameters

sort	string <string> Use to sort results. You can specify by which value it will be sorted. example - "sort=title:asc" "sort=createdAt:desc"
page	integer <int32> The number of the page you want to get. Default value = 1
pageSize	integer <int32> The number of element a page can contains. Default value = 10

Responses

Response samples

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "scheduled",
"error": "string",
"appId": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"params": "string",
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"type": null,
"needs": ["string"
],
"status": null,
"error": { },
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"params": {"inputUri": "http://example.com",
"start": 0,
"end": 0,
"overlays": [{"pictureUri": "http://example.com",
"pictureBase64": "string",
"text": "string",
"textSize": 0,
"startTime": 0,
"endTime": 0,
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"rotation": 0
}
]
},
"results": {"outputUri": "http://example.com"
}
}
]
}
],
"pagination": {"page": 0,
"pageSize": 0,
"totalNbOfItems": 0
}
}

Create a workflow execution

Create and execute a workflow.

Authorizations:

apiKeyAuth

Request Body schema: application/json

Params to be passed to the run which will be executed.

Array of any

Tasks to run

Array

label required	string user defined label, accept only alphanumeric characters, without spaces
type required	string clip
needs	Array of strings list of tasks that needs to run before this one as it depends on them. The values are tasks names defined earlier.
required	object (clipParams)

Responses

Request samples

Payload

Content type

application/json

{"tasks": [{"label": "string",
"type": null,
"needs": ["string"
],
"status": null,
"params": {"inputUri": "http://example.com",
"start": 0,
"end": 0,
"overlays": [{"pictureUri": "http://example.com",
"pictureBase64": "string",
"text": "string",
"textSize": 0,
"startTime": 0,
"endTime": 0,
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"rotation": 0
}
]
}
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "scheduled",
"error": "string",
"appId": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"params": "string",
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"type": null,
"needs": ["string"
],
"status": null,
"error": { },
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"params": {"inputUri": "http://example.com",
"start": 0,
"end": 0,
"overlays": [{"pictureUri": "http://example.com",
"pictureBase64": "string",
"text": "string",
"textSize": 0,
"startTime": 0,
"endTime": 0,
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"rotation": 0
}
]
},
"results": {"outputUri": "http://example.com"
}
}
]
}

Get a workflow execution

Fetch a single workflow execution

Authorizations:

apiKeyAuth

path Parameters

workflowExecutionId

required

string <uuid>

the uuid of the workflow execution Id

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "scheduled",
"error": "string",
"appId": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"params": "string",
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"type": null,
"needs": ["string"
],
"status": null,
"error": { },
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"params": {"inputUri": "http://example.com",
"start": 0,
"end": 0,
"overlays": [{"pictureUri": "http://example.com",
"pictureBase64": "string",
"text": "string",
"textSize": 0,
"startTime": 0,
"endTime": 0,
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"rotation": 0
}
]
},
"results": {"outputUri": "http://example.com"
}
}
]
}

Usage

Usage management operations

Index of usages

Authorizations:

apiKeyAuth

query Parameters

date	string <string> The usage date. Use date format yyyy-mm-yy, and gt(), lt() as operators.
page	integer <int32> The number of the page you want to get. Default value = 1
pageSize	integer <int32> The number of element a page can contains. Default value = 10
sort	string <string> Use to sort results. You can specify by which value it will be sorted. example - "sort=title:asc" "sort=createdAt:desc"

Responses

Response samples

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"date": "string",
"processing": {"quantity": 0,
"cost": "string"
},
"storage": {"quantity": 0,
"cost": "string"
},
"cdn": {"quantity": 0,
"cost": "string"
},
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {"page": 0,
"pageSize": 0,
"totalNbOfItems": 0
}
}

Video

id	string <uuid> The id of the video
title	string The title of the video
description	string The description of the video
status	string Default: "empty" Enum: "empty" "in_progress" "ready" "error" The status of the video
skipProcessing	boolean Default: false Flag to disable (skip) the processing steps
accessType	string Default: "public" Enum: "public" "private" define the accessType of the video, if private the video URI can only be accessed with a signed url
transcodedAt	string <date-time> date of transcoding
errorMessage	string A message describing the error if any
destinationUri	string <uri> Deprecated The uri of the main video output. Deprecated - Use videoOutputs instead
	object (VideoInput) Input file of the video
	Array of objects (VideoOutput) array of output files of the video
appId	string <string> Id of the app who owns this video
createdAt	string <date-time> Date of creation
updatedAt	string <date-time> Date of last update

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"status": "empty",
"skipProcessing": false,
"accessType": "public",
"transcodedAt": "2019-08-24T14:15:22Z",
"errorMessage": "string",
"destinationUri": "http://example.com",
"input": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"format": "string",
"videoCodec": "string",
"audioCodec": "string",
"quality": "string",
"uri": "http://example.com",
"duration": 0,
"width": 0,
"height": 0,
"bitrate": "string",
"aspectRatio": "string",
"size": 0
},
"outputs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"format": "string",
"videoCodec": "string",
"audioCodec": "string",
"quality": "string",
"masterPlaylistUri": "http://example.com",
"uri": "http://example.com",
"duration": 0,
"width": 0,
"height": 0,
"bitrate": 0,
"aspectRatio": "string",
"posterUri": "string",
"size": 0
}
],
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

User

id	string <uuid> The id of the user
auth0Id	string The id of the user in Auth0
username	string The username of the user
email	string The email of the user
avatarUri	string <uri> The avatar of the user (uri)
createdAt	string <date-time> Date of creation
updatedAt	string <date-time> Date of last update

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"auth0Id": "string",
"username": "string",
"email": "string",
"avatarUri": "http://example.com",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

App

id	string The id of the app
name	string The name of the app
secretKey	string The secretKey to use in API queries
userId	string <uuid> Id of the user who owns this app
s3AccessKey	string The access key for s3
s3SecretKey	string The secret key for s3
s3Region	string The region name for s3
s3Endpoint	string The Endpoint for s3
createdAt	string <date-time> Date of creation
updatedAt	string <date-time> Date of last update

{"id": "string",
"name": "string",
"secretKey": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"s3AccessKey": "string",
"s3SecretKey": "string",
"s3Region": "string",
"s3Endpoint": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Webhook

id	string <uuid> The id of the webhook
events	Array of strings (Event) Items Enum: "upload.complete" "transcoding.complete" Events which trigger the webhook
endpoint	string Endpoint to send the query
appId	string <string> Id of the app who owns this webhook
createdAt	string <date-time> Date of creation
updatedAt	string <date-time> Date of last update

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"events": ["upload.complete"
],
"endpoint": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Workflow

id required	string <uuid> The id of the workflow
name required	string The name of the workflow
description	string The description of the workflow
appId required	string <string> Id of the app who owns this workflow
createdAt required	string <date-time> Date of creation
updatedAt required	string <date-time> Date of last update

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Run

id required	string <uuid> The id of the run
status required	string Default: "running" Enum: "running" "completed" "failed" "canceled" "terminated" "continuedAsNew" "timedOut" The status of the run
params required	object The run input params - format depends on the executed workflow
result	object The run result - format depends on the executed workflow
error	string The error raised during the run
workflowId required	string <uuid> Deprecated The id of the workflow
required	object (Workflow) A workflow
appId required	string <string> Id of the app which owns this run
startedAt required	string <date-time> start time
endedAt	string <date-time> end time
createdAt required	string <date-time> Date of creation
updatedAt required	string <date-time> Date of last update
	Array of objects (_task)

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "running",
"params": { },
"result": { },
"error": "string",
"workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
"workflow": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"appId": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"type": "clip",
"needs": ["string"
],
"status": "running",
"error": { },
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Usage

id required	string <uuid> The id of the video
date required	string <string> Date
required	object (UsageProcessing) Processing Usage for an App
required	object (UsageStorage) Storage Usage for an App
required	object (UsageCdn) CDN Usage for an App
appId required	string <string> Id of the app who owns this usage
createdAt required	string <date-time> Date of creation
updatedAt required	string <date-time> Date of last update

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"date": "string",
"processing": {"quantity": 0,
"cost": "string"
},
"storage": {"quantity": 0,
"cost": "string"
},
"cdn": {"quantity": 0,
"cost": "string"
},
"appId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Problem

type	string <uri> Default: "about:blank" A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
href	string <uri> An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).
title	string A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
status	integer [ 400 .. 599 ) The HTTP status code.
detail	string A human-readable explanation specific to this occurrence of the problem.
instance	string A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
property name* additional property	any

{"type": "urn:problem-type:belgif:payloadTooLarge",
"href": "https://www.belgif.be/specification/rest/api-guide/problems/payloadTooLarge.html",
"title": "Payload Too Large",
"status": 413,
"detail": "Request message must not be larger than 10 MB",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
"limit": 10485760
}

InputValidationProblem

type	string <uri> Default: "about:blank" A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
href	string <uri> An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).
title	string A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
status	integer [ 400 .. 599 ) The HTTP status code.
detail	string A human-readable explanation specific to this occurrence of the problem.
instance	string A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
	Array of objects (InputValidationIssue) [ items non-empty ]
property name* additional property	any

{"type": "urn:problem-type:belgif:badRequest",
"href": "https://www.belgif.be/specification/rest/api-guide/problems/badRequest.html",
"title": "Bad Request",
"status": 400,
"detail": "The input message is incorrect",
"instance": "urn:uuid:123456-1234-1235-4567489798",
"limit": 10485760,
"issues": [{"type": "urn:problem-type:belgif:input-validation:schemaViolation",
"title": "Input isn't valid with respect to schema",
"detail": "enterpriseNumber abc should be numeric",
"in": "path",
"name": "enterpriseNumber",
"value": "abc"
},
{"type": "urn:problem-type:cbss:input-validation:replacedSsin",
"href": "https://api.ksz-bcss.fgov.be/problems/replacedSsin",
"title": "SSIN has been replaced. Use new ssin.",
"detail": "SSIN 12345678901 has been replaced by 23456789012",
"in": "body",
"name": "parent[0].ssin",
"value": "12345678901",
"replacedBy": "23456789012"
},
{"type": "urn:problem-type:cbss:input-validation:invalidPeriod",
"title": "period is invalid",
"detail": "endDate should be after startDate",
"in": "body",
"name": "period",
"value": {"startDate": "2020-12-31",
"endDate": "2020-01-01"
}
},
{"type": "urn:problem-type:cbss:input-validation:invalidSsin",
"title": "There is no person with the given SSIN",
"in": "path",
"name": "ssin",
"value": "12345678911"
}
]
}

InputValidationIssue

type	string <uri> Default: "about:blank" A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
href	string <uri> An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).
title	string A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
status	integer [ 400 .. 599 ) The HTTP status code.
detail	string A human-readable explanation specific to this occurrence of the problem.
instance	string A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
in	string Enum: "body" "header" "path" "query"
name	string
value	any
property name* additional property	any

{"type": "urn:problem-type:belgif:payloadTooLarge",
"href": "https://www.belgif.be/specification/rest/api-guide/problems/payloadTooLarge.html",
"title": "Payload Too Large",
"status": 413,
"detail": "Request message must not be larger than 10 MB",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
"limit": 10485760,
"in": "body",
"name": "string",
"value": null
}

WorkflowExecution

id	string <uuid> The id of the workflow execution
status	string Default: "running" Enum: "scheduled" "running" "completed" "failed" "canceled" The status of the workflow execution
error	string The error raised during the workflow execution
appId	string <string> Id of the app which owns this workflow execution
startedAt	string <date-time> start time
endedAt	string <date-time> end time
params	string <string> params sent to start this workflow execution
required	Array of any

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "scheduled",
"error": "string",
"appId": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"params": "string",
"tasks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"type": null,
"needs": ["string"
],
"status": null,
"error": { },
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"params": {"inputUri": "http://example.com",
"start": 0,
"end": 0,
"overlays": [{"pictureUri": "http://example.com",
"pictureBase64": "string",
"text": "string",
"textSize": 0,
"startTime": 0,
"endTime": 0,
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"rotation": 0
}
]
},
"results": {"outputUri": "http://example.com"
}
}
]
}