Options

GET /options

Return the full option vocabulary the engine understands — device and city presets, op/filter/noise names, output formats, the bundled starter recipes, and the request limits. Read this at runtime so your integration never hardcodes a vocabulary that could drift from the engine.

Requires authentication.

Response — 200 OK

{
  "devices": [ … ],
  "deviceModels": [ … ],
  "cities": [ … ],
  "countryCodes": [ … ],
  "ops": [ … ],
  "filters": [ … ],
  "noiseTypes": [ … ],
  "strengthLevels": ["light", "medium", "strong"],
  "outputFormats": [ … ],
  "starterRecipes": [
    { "id": "full-refresh", "copies": 5, "nodeCount": 7 },
    { "id": "iphone-noise-mult10", "copies": 10, "nodeCount": 5 },
    { "id": "strip-warp-output", "copies": 3, "nodeCount": 4 }
  ],
  "limits": { "maxCopies": 50, "maxUploadBytes": 104857600 }
}

Field	Type	Notes
devices	array	Device presets for metadata reauthoring.
deviceModels	array	Known device model strings.
cities	array	City presets for GPS placement.
countryCodes	array	Country codes for GPS placement.
ops	array	The node op vocabulary usable in a recipeConfig.
filters	array	Filter names.
noiseTypes	array	Noise type names.
strengthLevels	array	Customer-facing strength levels.
outputFormats	array	Supported output container formats.
starterRecipes	array	Bundled presets: { id, copies, nodeCount }. Use id as recipeId.
limits	object	maxCopies and maxUploadBytes — the hard request ceilings.

Use starterRecipes[].id as the recipeId on POST /jobs, and ops / filters / noiseTypes when authoring a full recipeConfig (see Configuring your own settings).