Get File Info
Retrieve detailed information about a specific file including its transcript if available
file_info.scenes_status says where the scene analysis of the file stands. Once it is completed, data.scenes holds the scenes, as POST /watch returns them for an online video.
Retrieve detailed information about a specific uploaded file, including its transcript once processing is complete.
Path Parameter
file_id(string, required) – The ID of the uploaded file.
Example Request
curl "https://api.vidnavigator.com/v1/file/file_abc123" \
-H "X-API-Key: YOUR_API_KEY"Success Response (200 OK)
Returns a file_info object (including namespace assignments) and, if processing is complete, a transcript object.
file_info.scenes_status says where the scene analysis of the file stands: none (never asked for), processing, completed or failed (with file_info.scenes_error). Once completed, the scenes are returned in data.scenes, each with start, end, description and on_screen_text, next to data.frames_analyzed.
{
"status": "success",
"data": {
"file_info": {
"id": "file_abc123",
"name": "session.mp4",
"size": 15728640,
"type": "video/mp4",
"duration": 330.5,
"status": "completed",
"created_at": "2024-01-15T10:00:00Z",
"updated_at": "2024-01-15T10:00:00Z",
"has_transcript": true,
"namespace_ids": ["64a1b2c3d4e5f6789abc0001"],
"namespaces": [
{ "id": "64a1b2c3d4e5f6789abc0001", "name": "default" }
]
},
"transcript": [
{
"text": "Welcome to this tutorial...",
"start": 0.0,
"end": 3.5
}
]
}
}API reference
ApiKeyAuthX-API-Key<token>API key authentication. Include your VidNavigator API key in the X-API-Key header.
file_id*stringThe ID of the uploaded file
transcript_text?booleanWhen true, returns the transcript as a single plain-text string instead of an array of segments (only when transcript is available).
falseFile information retrieved successfully
application/json- response
status?"success""success"data?curl -X GET 'https://api.vidnavigator.com/v1/file/string'{ "status": "success", "data": { "file_info": { "id": "string", "name": "string", "size": 0, "type": "string", "duration": 0, "status": "pending", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "original_file_date": "2019-08-24T14:15:22Z", "has_transcript": true, "error_message": "string", "scenes_status": "none", "frames_analyzed": 0, "scenes_error": { "error": "frames_not_available", "message": "string" }, "namespace_ids": [ "string" ], "namespaces": [ { "id": "string", "name": "string" } ] }, "transcript": [ { "text": "string", "start": 0, "end": 0 } ], "scenes": [ { "start": 4, "end": 12, "description": "A presenter stands in front of a world map and points at Europe.", "on_screen_text": "BREAKING NEWS" } ] }}