Skip to main content
GET
/
v1
/
commands
Get list of commands sent
curl --request GET \
  --url https://api.rendi.dev/v1/commands \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.rendi.dev/v1/commands"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.rendi.dev/v1/commands', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rendi.dev/v1/commands",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.rendi.dev/v1/commands"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-KEY", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.rendi.dev/v1/commands")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.rendi.dev/v1/commands")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "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
  }
]
{
"detail": "Invalid authorization key"
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

limit
integer
default:1000

Maximum number of commands to return

Required range: x <= 1000
offset
integer
default:0

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

Required range: x >= 0

Response

Successful Response

command_id
string
required

Unique identifier for the submitted command

Example:

"123e4567-e89b-12d3-a456-426614174000"

status
enum<string>
required

Current status of the FFmpeg command

Available options:
QUEUED,
PROCESSING,
PREPARED_FFMPEG_COMMAND,
FAILED,
SUCCESS
Example:

"SUCCESS"

environment_name
string | null

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

Example:

"main"

storage_quota_used
number | null

Amount of storage quota used in MB

Required range: x >= 0
Example:

5.2

processing_quota_used
number | null

Amount of processing quota used in MB

Required range: x >= 0
Example:

12.5

output_file_count
integer | null

Number of output files generated by the command

Required range: x >= 0
Example:

72

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."

created_at
string<date-time>

Time when the command was created, in UTC

Example:

"2024-01-01T00:00:00Z"

ffmpeg_command_run_seconds
number | null

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

processing_seconds
number | null

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