Presets

Get a preset

Changed on

One preset plus tools: a ready-to-merge request fragment for each tool it can be delivered into, keyed by tool name. Auth is optional; a Bearer token also resolves the account's private presets.

get/presets/{id}

Request

  • Base URL: https://api.varg.ai/v2
  • URL: https://api.varg.ai/v2/presets/{id}
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

idstring required
Example:preset_5f4dcc3b5aa7

Preset id (preset_<12hex>).

Response

The preset

idstring required

Canonical preset reference (preset_<12hex>).

kindstring required

Preset layer. Currently always provider_value.

typestring required

Which parameter the preset fills (for example voice, style).

namespacestring required

Whose id system minted the value (for example elevenlabs, higgsfield, fal).

namestring required
descriptionstring nullable required
preview_urlstring nullable required

Sample audio or image for the preset.

metadataobject required

Filterable attributes. Keys vary by type; values are strings or arrays of strings.

status'active' | 'deprecated' required
toolsobject required

Ready-to-merge request fragment per tool, keyed by tool name. A fragment with a broken mapping is returned as { "_error": "<message>" }.

Example response

{
  "id": "preset_5f4dcc3b5aa7",
  "kind": "provider_value",
  "type": "voice",
  "namespace": "elevenlabs",
  "name": "Brian",
  "tools": {
    "speech": {
      "voice": "preset_5f4dcc3b5aa7"
    }
  }
}

Changes