v1

latestOpenAPI 3.1.02026-07-26132249.4 KB

API

FFmpeg Commands

Get list of commands sent

Get the statuses of a previously submitted FFmpeg commands, ordered by creation time - descending.

get/v1/commands

Query parameters

limitinteger

Maximum number of commands to return

offsetinteger

Number of commands to skip before starting to collect the result set

Response

Successful Response

command_idstring required

Unique identifier for the submitted command

environment_namestring nullable

The environment this command was created in (e.g., 'main', 'test', 'dev').

storage_quota_usednumber nullable

Amount of storage quota used in MB

processing_quota_usednumber nullable

Amount of processing quota used in MB

output_file_countinteger nullable

Number of output files generated by the command

error_statusstring nullable

Status of any error that occurred during command execution

error_messagestring nullable

Error details if the command failed

status'QUEUED' | 'PROCESSING' | 'PREPARED_FFMPEG_COMMAND' | 'FAILED' | 'SUCCESS' required

created_atstring date-time

Time when the command was created, in UTC

ffmpeg_command_run_secondsnumber nullable

The exact time the specific FFMPEG command took on our servers, in seconds

processing_secondsnumber nullable

Total processing time from queue to finish, in seconds (finished_at - queued_at)

Example response

[
  {
    "command_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-01-01T00:00:00Z",
    "environment_name": "main",
    "ffmpeg_command_run_seconds": 19.58,
    "output_file_count": 2,
    "processing_quota_used": 2.4,
    "processing_seconds": 24.96,
    "status": "SUCCESS",
    "storage_quota_used": 0.85
  }
]