Skip to main content
GET
/
file
/
{file_id}
Get file information and transcript
curl --request GET \
  --url https://api.vidnavigator.com/v1/file/{file_id} \
  --header 'X-API-Key: <api-key>'
{
  "status": "success",
  "data": {
    "file_info": {
      "id": "<string>",
      "name": "<string>",
      "size": 123,
      "type": "<string>",
      "duration": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "original_file_date": "2023-11-07T05:31:56Z",
      "has_transcript": true,
      "error_message": "<string>",
      "namespace_ids": [
        "<string>"
      ],
      "namespaces": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ]
    },
    "transcript": [
      {
        "text": "<string>",
        "start": 123,
        "end": 123
      }
    ]
  }
}
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
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. 
{
  "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
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

API key authentication. Include your VidNavigator API key in the X-API-Key header.

Path Parameters

​
file_id
string
required

The ID of the uploaded file

Query Parameters

​
transcript_text
boolean
default:false

When true, returns the transcript as a single plain-text string instead of an array of segments (only when transcript is available).

Response

File information retrieved successfully

​
status
enum<string>
Available options:
success
​
data
object