List Commands

GET /api/v1/commands

Retrieve a paginated list of your commands, ordered by creation date (newest first). Optionally filter by status to find commands in a specific state.

Authentication

Requires API key via X-API-KEY header.

Request

Headers

Header	Type	Required	Description
`X-API-KEY`	`string`	Yes	Your API key with `ffsk_` prefix

Query parameters

Parameter	Type	Required	Default	Description
`limit`	`number`	No	`50`	Number of commands to return. Maximum `100`.
`offset`	`number`	No	`0`	Number of commands to skip for pagination.
`status`	`string`	No	--	Filter by status: `QUEUED`, `PROCESSING`, `SUCCESS`, or `FAILED`.

Response

200 OK

{
  commands: CommandPollResponse[];
  limit: number;
  offset: number;
}

Field	Type	Description
`commands`	`CommandPollResponse[]`	Array of command objects. See Get Command for the full `CommandPollResponse` shape.
`limit`	`number`	The limit value used for this request.
`offset`	`number`	The offset value used for this request.

Error responses

Status	Error	Description
`400`	`INVALID_REQUEST`	Invalid query parameters (e.g., limit exceeds 100, invalid status value).
`401`	`UNAUTHORIZED`	Missing or invalid API key.
`429`	`RATE_LIMITED`	Too many requests. Retry after the period indicated in the `Retry-After` header.

Examples

curl

# List the 20 most recent commands
curl "https://renderio.dev/api/v1/commands?limit=20" \
  -H "X-API-KEY: ffsk_your_api_key_here"

# List failed commands with pagination
curl "https://renderio.dev/api/v1/commands?status=FAILED&limit=10&offset=0" \
  -H "X-API-KEY: ffsk_your_api_key_here"

JavaScript (fetch)

const params = new URLSearchParams({
  limit: "20",
  status: "SUCCESS",
});

const response = await fetch(
  `https://renderio.dev/api/v1/commands?${params}`,
  {
    headers: {
      "X-API-KEY": "ffsk_your_api_key_here",
    },
  },
);

const { commands, limit, offset } = await response.json();
console.log(`Fetched ${commands.length} commands (offset: ${offset})`);

for (const cmd of commands) {
  console.log(`${cmd.command_id} - ${cmd.status}`);
}

Python (requests)

import requests

response = requests.get(
    "https://renderio.dev/api/v1/commands",
    headers={
        "X-API-KEY": "ffsk_your_api_key_here",
    },
    params={
        "limit": 20,
        "status": "SUCCESS",
    },
)

data = response.json()
print(f"Fetched {len(data['commands'])} commands (offset: {data['offset']})")

for cmd in data["commands"]:
    print(f"{cmd['command_id']} - {cmd['status']}")

List Commands

On this page