Response body for ProcessFileAndSave operations where the File Processing API operation is asynchronous (e.g. a video transcoding job).
{ },}
{ "async": true, "jobUrl": "https://api.bytescale.com/v2/accounts/W142hJk/jobs/ProcessFileJob/01HA255YE6H6DEETJ5M6595ZDA", "jobDocs": "https://www.bytescale.com/docs/job-api/GetJob", "jobId": "01HA255YE6H6DEETJ5M6595ZDA", "jobType": "ProcessFileJob", "accountId": "W142hJk", "created": 1694437145030, "lastUpdated": 1694437145030, "status": "Running", "summary": {}}
Your account ID.
This is visible on the settings page:
https://www.bytescale.com/dashboard/settings
Example: "A623uY2"
Type: String
Length: 7
Required: Yes
True for asynchronous file processing operations (e.g. video transcoding).
For asynchronous operations, the response body will contain information about the background job that's processing the file, which can then be polled via the GetJob operation.
Type: Boolean
Value:
Required: Yes
The time this job was created in epoch milliseconds (since midnight 1 January 1970, UTC).
Example: 1615680311115
Type: Integer
Minimum: 0
Required: Yes
Machine-readable error code.
Example: "error_code"
Type: String
Min Length: 1
Max Length: 255
Required: Yes
Additional machine-readable details relating to the error.
Required: No
Human-readable error message.
Example: "Error message."
Type: String
Min Length: 1
Required: Yes
Link to the documentation that describes how to get a job's status from its job ID.
Type: String
Value: "https://www.bytescale.com/docs/job-api/GetJob"
Required: Yes
Unique ID for the job.
Example: "01ARZ3NDEKTSV4RRFFQ69G5FAV"
Type: String
Length: 26
Required: Yes
Type of the job.
Example: "ExampleJob"
Type: String
Allowed Values: "CopyFileBatchJob", "CopyFolderBatchJob", "DeleteFileBatchJob", "DeleteFolderBatchJob", "ProcessFileJob"
Required: Yes
URL for the job's status.
You can GET this URL to retrieve the job's status.
You must authorize your GET request with a secret_* API key when accessing the URL.
Example: "https://api.bytescale.com/v2/accounts/FW25aki/jobs/ExampleJob/01ARZ3NDEKTSV4RRFFQ69G5FAV"
Type: String
Min Length: 1
Max Length: 255
Required: Yes
The time this job was updated in epoch milliseconds (since midnight 1 January 1970, UTC).
Example: 1615680311115
Type: Integer
Minimum: 0
Required: Yes
The job's status.
Type: String
Allowed Values: "Cancelled", "Cancelling", "Created", "Failed", "Pending", "Rollback", "Running", "Succeeded"
Required: Yes
The summary and jobType together define the work the job will perform / has performed.
Type: JsonObject
Required: Yes
This website uses cookies. By continuing you are consenting to the use of cookies per our cookie policy.
This website requires a modern web browser -- the latest versions of these browsers are supported: