Skip to main content

List Videos

GET /v1/videos

List all videos in your workspace with pagination and optional status filtering.

Query parameters

ParameterTypeRequiredDefaultDescription
pageintegerNo1Page number (minimum 1)
limitintegerNo20Results per page (1–100)
statusstringNoFilter by status: draft, in_progress, or completed
projectIdstringNoReturn only videos in the given project folder. 404 if the folder doesn't belong to the workspace.
uncategorizedbooleanNoIf true, return only videos with no project folder. Overrides projectId.

Example

curl "https://api.vidocu.ai/v1/videos?page=1&limit=10&status=completed" \
-H "Authorization: Bearer vdo_live_your_key_here"

Response 200 OK

{
"videos": [
{
"id": "vid_1708300000000_abc1234",
"projectId": "0f7c1d8a-2c4b-4a9c-9f2a-1b8a3a5e0c11",
"name": "Product Demo Q1",
"status": "completed",
"videoUrl": "https://storage.vidocu.ai/...",
"thumbnailUrl": "https://storage.vidocu.ai/...",
"videoDuration": 120.5,
"language": "en",
"exportedVideoUrl": "https://storage.vidocu.ai/...",
"exportedSrtUrl": "https://storage.vidocu.ai/...",
"exportedVoiceoverUrl": "https://storage.vidocu.ai/...",
"exportedAt": "2024-02-19T10:30:00.000Z",
"createdAt": "2024-02-18T14:00:00.000Z",
"updatedAt": "2024-02-19T10:30:00.000Z"
}
],
"pagination": {
"total": 42,
"page": 1,
"limit": 10,
"totalPages": 5
}
}

Video object fields

FieldTypeDescription
idstringUnique video ID
projectIdstring | nullParent project folder ID (null when uncategorized)
namestringDisplay name
statusstringdraft, in_progress, or completed
videoUrlstringSource video URL
thumbnailUrlstring | nullGenerated thumbnail URL
videoDurationnumber | nullDuration in seconds
languagestring | nullDetected language code
exportedVideoUrlstring | nullExported video URL (after export)
exportedSrtUrlstring | nullExported SRT file URL (after export)
exportedVoiceoverUrlstring | nullCombined voiceover MP3 URL (after export, if voiceover was generated)
exportedAtstring | nullExport timestamp
createdAtstringCreation timestamp
updatedAtstringLast update timestamp

Results are sorted by updatedAt descending (most recent first).

Errors

StatusCodeCause
400validation_errorInvalid query parameter values
401authentication_errorInvalid or missing API key