Thanks to visit codestin.com
Credit goes to docs.rendi.dev

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>'
[
  {
    "command_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-01-01T00:00:00Z",
    "status": "SUCCESS"
  }
]

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"

​
storage_quota_used
number | null

Amount of storage quota used in GB

Required range: x >= 0
Example:

5.2

​
processing_quota_used
number | null

Amount of processing quota used in GB

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"