Tools

Get tool metadata

Changed on

Full metadata for one tool: JSON Schema for its input, output shape, and a worked example. Auth is optional. Pass ?model=<model> to enrich provider_options with the explicit per-provider schema for that model (instead of the generic passthrough bag).

get/tools/{tool_key}

Request

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

Path parameters

tool_key'image' | 'video' | 'video_analyze' | 'speech' | 'music' | 'transcription' | 'ffmpeg' | 'render' | 'pipeline' required

Query parameters

modelstring

Enrich the schema with per-provider options for this model

Response

Tool metadata

tool_keystring required
descriptionstring required
input_schemaobject required

JSON Schema for the request body

output_schemaobject required

JSON Schema of the job output

exampleobject required

A worked input/output example

Changes