Get Tool
GET /v1/tools/:type
Returns a single tool with its full parameter definition.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Tool 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
| Type | API format | Description |
|---|---|---|
text | string | Short text input |
textarea | string | Long text input |
number | number | Numeric value (may have min, max, step) |
boolean | boolean | True/false |
select | string | One of the values in options |
url | string | A valid HTTP(S) URL (used for file inputs) |
color | string | Hex color (e.g. #FF0000) |
Errors
| Status | Code | Cause |
|---|---|---|
| 401 | authentication_error | Invalid or missing API key |
| 404 | not_found | Tool not found or not published |