Skip to main content

Get Tool

GET /v1/tools/:type

Returns a single tool with its full parameter definition.

Path parameters

ParameterTypeRequiredDescription
typestringYesTool type identifier (e.g. video-trimmer)

Example

curl https://api.vidocu.ai/v1/tools/video-transcript-extractor \
-H "Authorization: Bearer vdo_live_your_key_here"

Response 200 OK

{
"type": "video-transcript-extractor",
"displayName": "Video Transcript Extractor",
"description": "Extract the transcript from a video as plain text",
"category": "video",
"parameters": [
{
"name": "videoUrl",
"type": "url",
"label": "Video File",
"description": "URL of the video to extract transcript from",
"required": true,
"defaultValue": null
},
{
"name": "language",
"type": "select",
"label": "Language",
"description": "Language of the audio",
"required": false,
"defaultValue": "auto",
"options": [
{ "label": "Auto-detect", "value": "auto" },
{ "label": "English", "value": "en" },
{ "label": "Spanish", "value": "es" }
]
}
],
"output": {
"type": "text",
"label": "Transcript",
"mimeType": "text/plain"
}
}

Parameter types

TypeAPI formatDescription
textstringShort text input
textareastringLong text input
numbernumberNumeric value (may have min, max, step)
booleanbooleanTrue/false
selectstringOne of the values in options
urlstringA valid HTTP(S) URL (used for file inputs)
colorstringHex color (e.g. #FF0000)

Errors

StatusCodeCause
401authentication_errorInvalid or missing API key
404not_foundTool not found or not published