Poll FFmpeg Command

Get Command Status

curl --request GET \
  --url https://api.rendi.dev/v1/commands/{command_id} \
  --header 'X-API-KEY: <api-key>'

{
  "command_id": "123e4567-e89b-12d3-a456-426614174000",
  "command_type": "FFMPEG_COMMAND",
  "ffmpeg_command_run_seconds": 19.58051347732544,
  "original_request": {
    "ffmpeg_command": "-i {{in_1}} -ss 00:00 -to 00:30 -filter_complex \"[0:v]split=2[vid1][vid2];[vid1]scale=trunc(oh*a/2)*2:320:force_original_aspect_ratio=decrease,pad=trunc(oh*a/2)*2:320:-1:-1[320p];[vid2]scale=trunc(oh*a/2)*2:180:force_original_aspect_ratio=decrease,pad=trunc(oh*a/2)*2:180:-1:-1[180p]\" -map [320p] -map 0:a -c:a copy -c:v libx264 -preset medium {{out_1}}  -map [180p] -map 0:a -c:a copy -c:v libx264 -preset medium {{out_2}}",
    "input_files": {
      "in_1": "https://storage.rendi.dev/sample/sample.avi"
    },
    "max_command_run_seconds": 300,
    "output_files": {
      "out_1": "output_320p.mp4",
      "out_2": "output_180p.mp4"
    },
    "vcpu_count": 8
  },
  "output_files": {
    "out_1": {
      "bitrate_audio_kb": 242.349609375,
      "bitrate_video_kb": 370.5654296875,
      "codec": "h264",
      "duration": 30,
      "file_format": "mp4",
      "file_id": "f775b15d-67e9-4235-b89f-4bb33c0a5f57",
      "file_type": "video",
      "frame_rate": 24,
      "height": 320,
      "is_varying_frame_rate": false,
      "mime_type": "video/mp4",
      "pixel_format": "yuv420p",
      "size_mbytes": 2.2677812576293945,
      "storage_url": "https://storage.rendi.dev/files/224ea098-5c10-419b-8a77-707d89443c56/42c95292-d953-4b5a-8a58-cf1513363a33/output_320p.mp4",
      "timebase": "1/25",
      "width": 568
    },
    "out_2": {
      "bitrate_audio_kb": 239.9833984375,
      "bitrate_video_kb": 160.955078125,
      "codec": "h264",
      "duration": 596.459,
      "file_format": "mp4",
      "file_id": "9df00eca-3221-49c6-8a64-07850c9a5921",
      "file_type": "video",
      "frame_rate": 24,
      "height": 180,
      "is_varying_frame_rate": false,
      "mime_type": "video/mp4",
      "pixel_format": "yuv420p",
      "size_mbytes": 29.620187759399414,
      "storage_url": "https://storage.rendi.dev/files/224ea098-5c10-419b-8a77-707d89443c56/42c95292-d953-4b5a-8a58-cf1513363a33/output_180p.mp4",
      "timebase": "1/25",
      "width": 320
    }
  },
  "status": "SUCCESS",
  "total_processing_seconds": 24.955581,
  "vcpu_count": 8
}

GET

commands

{command_id}

Get Command Status

curl --request GET \
  --url https://api.rendi.dev/v1/commands/{command_id} \
  --header 'X-API-KEY: <api-key>'

{
  "command_id": "123e4567-e89b-12d3-a456-426614174000",
  "command_type": "FFMPEG_COMMAND",
  "ffmpeg_command_run_seconds": 19.58051347732544,
  "original_request": {
    "ffmpeg_command": "-i {{in_1}} -ss 00:00 -to 00:30 -filter_complex \"[0:v]split=2[vid1][vid2];[vid1]scale=trunc(oh*a/2)*2:320:force_original_aspect_ratio=decrease,pad=trunc(oh*a/2)*2:320:-1:-1[320p];[vid2]scale=trunc(oh*a/2)*2:180:force_original_aspect_ratio=decrease,pad=trunc(oh*a/2)*2:180:-1:-1[180p]\" -map [320p] -map 0:a -c:a copy -c:v libx264 -preset medium {{out_1}}  -map [180p] -map 0:a -c:a copy -c:v libx264 -preset medium {{out_2}}",
    "input_files": {
      "in_1": "https://storage.rendi.dev/sample/sample.avi"
    },
    "max_command_run_seconds": 300,
    "output_files": {
      "out_1": "output_320p.mp4",
      "out_2": "output_180p.mp4"
    },
    "vcpu_count": 8
  },
  "output_files": {
    "out_1": {
      "bitrate_audio_kb": 242.349609375,
      "bitrate_video_kb": 370.5654296875,
      "codec": "h264",
      "duration": 30,
      "file_format": "mp4",
      "file_id": "f775b15d-67e9-4235-b89f-4bb33c0a5f57",
      "file_type": "video",
      "frame_rate": 24,
      "height": 320,
      "is_varying_frame_rate": false,
      "mime_type": "video/mp4",
      "pixel_format": "yuv420p",
      "size_mbytes": 2.2677812576293945,
      "storage_url": "https://storage.rendi.dev/files/224ea098-5c10-419b-8a77-707d89443c56/42c95292-d953-4b5a-8a58-cf1513363a33/output_320p.mp4",
      "timebase": "1/25",
      "width": 568
    },
    "out_2": {
      "bitrate_audio_kb": 239.9833984375,
      "bitrate_video_kb": 160.955078125,
      "codec": "h264",
      "duration": 596.459,
      "file_format": "mp4",
      "file_id": "9df00eca-3221-49c6-8a64-07850c9a5921",
      "file_type": "video",
      "frame_rate": 24,
      "height": 180,
      "is_varying_frame_rate": false,
      "mime_type": "video/mp4",
      "pixel_format": "yuv420p",
      "size_mbytes": 29.620187759399414,
      "storage_url": "https://storage.rendi.dev/files/224ea098-5c10-419b-8a77-707d89443c56/42c95292-d953-4b5a-8a58-cf1513363a33/output_180p.mp4",
      "timebase": "1/25",
      "width": 320
    }
  },
  "status": "SUCCESS",
  "total_processing_seconds": 24.955581,
  "vcpu_count": 8
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

command_id

string

required

The UUID of the FFmpeg command to check status for

Response

Successful Response

Response model for FFmpeg command status.

Contains information about the command execution status, any errors that occurred, output files generated, and the original request details.

command_id

string

required

Unique identifier for the submitted command

status

enum<string>

required

Current status of the FFmpeg command

Available options:

QUEUED,

PROCESSING,

PREPARED_FFMPEG_COMMAND,

FAILED,

SUCCESS

command_type

enum<string>

required

Type of command that was run

Available options:

FFMPEG_COMMAND,

FFMPEG_CHAINED_COMMANDS

original_request

Original Request · object

required

The original request that was sent to the server

error_status

string | null

Status of any error that occurred during command execution

Example:

"UNREACHABLE_INPUT_FILE"

error_message

string | null

Error details if the command failed

Example:

"Input file url https://rendi.dev/example does not have a valid file name in its' end."

total_processing_seconds

number | null

Processing time, in seconds, since receiving the command, this includes network times, parsing times, and FFMPEG command execution time

ffmpeg_command_run_seconds

number | null

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

vcpu_count

integer | null

Number of virtual CPUs used for the command

output_files

Output Files · object

Dictionary mapping file aliases to their output file storage

Show child attributes

output_files.{key}

RendiStoredFile · object

Represents a file stored by rendi. Could either be an uploaded file or a file generated by running a command.

This model contains metadata about files stored in rendi storage, including file details, media information, and storage location.

Show child attributes

output_files.{key}.file_id

string

required

Unique identifier for the stored file

output_files.{key}.storage_url

string | null

URL where the file is stored

Example:

"https://storage.rendi.dev/123e4567-e89b-12d3-a456-426614174000/output.avi"

output_files.{key}.status

enum<string> | null

Status of the file

Available options:

QUEUED,

DOWNLOADING,

DOWNLOADED,

FAILED,

STORED

Example:

"STORED"

output_files.{key}.rendi_store_type

enum<string> | null

Type of storage of the file in rendi

Available options:

INPUT,

OUTPUT,

STORED_FILE

Example:

"STORED_FILE"

output_files.{key}.error_status

string | null

Status of any error that occurred during file processing

Example:

"UNREACHABLE_INPUT_FILE"

output_files.{key}.external_error_message

string | null

Error details if the file failed to be processed

Example:

"Input file url https://rendi.dev/example is not reachable."

output_files.{key}.is_deleted

boolean | null

Whether the file has been deleted

Example:

false

output_files.{key}.size_mbytes

number | null

Size of the output file in megabytes

Example:

15.2

output_files.{key}.original_file_url

string | null

URL of the original file

Example:

"https://somehwereonline.stored.com/file_to_store.mp4"

output_files.{key}.duration

number | null

Duration of the media file in seconds

Example:

30.5

output_files.{key}.file_type

string | null

Type of the media file (video, audio, image, subtitles, etc.)

Example:

"video"

output_files.{key}.file_format

string | null

Format/container of the media file

Example:

"avi"

output_files.{key}.width

integer | null

Width of the video in pixels

Example:

1920

output_files.{key}.height

integer | null

Height of the video in pixels

Example:

1080

output_files.{key}.codec

string | null

Codec used for the media file

Example:

"msmpeg4v2"

output_files.{key}.timebase

string | null

How time is represented in the media file

Example:

"1/25"

output_files.{key}.pixel_format

string | null

How the pixel data is stored in the media file

Example:

"yuv420p"

output_files.{key}.mime_type

string | null

MIME type of the media file

Example:

"video/mp4"

output_files.{key}.frame_rate

number | null

Frame rate of the video in frames per second

Example:

30

output_files.{key}.bitrate_video_kb

number | null

Video bitrate in kilobits per second

Example:

4000

output_files.{key}.bitrate_audio_kb

number | null

Audio bitrate in kilobits per second

Example:

128

output_files.{key}.video_profile_level

string | null

Video profile level

Example:

"main"

output_files.{key}.is_varying_frame_rate

boolean | null

Whether the video has a variable frame rate

Example:

false

Example:

{
  "out_1": {
    "bitrate_audio_kb": 242.349609375,
    "bitrate_video_kb": 370.5654296875,
    "codec": "h264",
    "duration": 30,
    "file_format": "mp4",
    "file_id": "f775b15d-67e9-4235-b89f-4bb33c0a5f57",
    "file_type": "video",
    "frame_rate": 24,
    "height": 320,
    "is_varying_frame_rate": false,
    "mime_type": "video/mp4",
    "pixel_format": "yuv420p",
    "size_mbytes": 2.2677812576293945,
    "storage_url": "https://storage.rendi.dev/files/224ea098-5c10-419b-8a77-707d89443c56/42c95292-d953-4b5a-8a58-cf1513363a33/output_320p.mp4",
    "timebase": "1/25",
    "width": 568
  },
  "out_2": {
    "bitrate_audio_kb": 239.9833984375,
    "bitrate_video_kb": 160.955078125,
    "codec": "h264",
    "duration": 596.459,
    "file_format": "mp4",
    "file_id": "9df00eca-3221-49c6-8a64-07850c9a5921",
    "file_type": "video",
    "frame_rate": 24,
    "height": 180,
    "is_varying_frame_rate": false,
    "mime_type": "video/mp4",
    "pixel_format": "yuv420p",
    "size_mbytes": 29.620187759399414,
    "storage_url": "https://storage.rendi.dev/files/224ea098-5c10-419b-8a77-707d89443c56/42c95292-d953-4b5a-8a58-cf1513363a33/output_180p.mp4",
    "timebase": "1/25",
    "width": 320
  }
}

Run Chained FFmpeg Commands FFprobe and store a file

⌘I

API Documentation

Endpoint Examples

Authorizations

Path Parameters

Response