API Reference

Submits a new processing job for an asset.

post
https://localhost:44395/api/admin/job

Behavior: Creates and submits a new processing job using the provided job model, returning the generated job identifier.

Authorization: No authorization required.

Side Effects: A new processing job is created and queued for execution.

Error Scenarios: Returns an error if the job submission fails.

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

The job submission model containing processing parameters.

Represents the input model for submitting a media processing job.

string | null

Gets or sets the external identifier for correlating the job with an external system.

string
required
length ≥ 1

Gets or sets the name of the S3 bucket containing the source media file.

string
required
length ≥ 1

Gets or sets the S3 object key of the source media file.

string
required
length ≥ 1

Gets or sets the URL to call when the job completes.

boolean

Gets or sets a value indicating whether to replace an existing job with the same identifier.

string | null

Gets or sets the URL of the source asset for processing.

requestedTasks
array of strings | null

Gets or sets the list of processing tasks to perform on the media file.

requestedTasks
requestedTranscodeProfiles
array of strings | null

Gets or sets the list of transcode profile names to apply to the media file.

requestedTranscodeProfiles
string | null

Gets or sets the access token for authenticating with external services during processing.

string | null

Gets or sets the URL for retrieving asset details during processing.

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

Generated from available request content types

Allowed:
Response

Updated about 20 hours ago

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

Updated about 20 hours ago