Get Preset

GET /api/v1/presets/:presetId

Retrieve a single preset by its ID. Returns the preset if it belongs to your account or is a system preset.

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

Path parameters

Parameter	Type	Required	Description
`presetId`	`string`	Yes	The unique identifier of the preset.

Response

200 OK

Returns a PresetResponse object. See Create Preset for the full schema.

interface PresetResponse {
  preset_id: string;
  name: string;
  description: string | null;
  is_system: boolean;
  command_type: "FFMPEG_COMMAND" | "CHAINED_COMMAND" | "MULTIPLE_COMMAND";
  ffmpeg_command: string | null;
  ffmpeg_commands: string[] | null;
  input_file_keys: string[];
  output_file_definitions: Record<string, string>;
  metadata: Record<string, string | number | boolean> | null;
  created_at: string;
  updated_at: string;
}

Error responses

Status	Error	Description
`401`	`UNAUTHORIZED`	Missing or invalid API key.
`404`	`NOT_FOUND`	Preset does not exist or does not belong to your account.
`429`	`RATE_LIMITED`	Too many requests. Retry after the period indicated in the `Retry-After` header.

Examples

curl

curl https://renderio.dev/api/v1/presets/prs_abc123 \
  -H "X-API-KEY: ffsk_your_api_key_here"

JavaScript (fetch)

const presetId = "prs_abc123";

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

const preset = await response.json();
console.log(`Preset: ${preset.name} (type: ${preset.command_type})`);

Python (requests)

import requests

preset_id = "prs_abc123"

response = requests.get(
    f"https://renderio.dev/api/v1/presets/{preset_id}",
    headers={"X-API-KEY": "ffsk_your_api_key_here"},
)

preset = response.json()
print(f"Preset: {preset['name']} (type: {preset['command_type']})")

Get Preset

On this page