---
title: "Get tool metadata"
method: GET
path: "/tools/{tool_key}"
tags: ["Tools"]
---

# Get tool metadata

`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

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).

## Path parameters

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

## Query parameters

- `model` string

## Response `200`

Tool metadata

- object
  - `tool_key` string, required
  - `description` string, required
  - `input_schema` object, required: JSON Schema for the request body
  - `output_schema` object, required: JSON Schema of the job output
  - `example` object, required: A worked input/output example

## Other responses

- `404`: Unknown tool (`tool_not_found`) or, with `?model=`, unknown model (`model_not_found`)

## Changes

- **2026-10-20** `43bcf5ea398d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/varg/apis/varg-api/changes/tools/:tool_key/get.md)

---

[API](https://skmtc.dev/varg/apis/varg-api.md) · [All operations](https://skmtc.dev/varg/apis/varg-api/llms.txt) · [OpenAPI document](https://skmtc.dev/varg/apis/varg-api/revisions/09d49a6d852f?raw)