Skip to main content
POST
/
analyze
/
file
Analyze uploaded file
curl --request POST \
  --url https://api.vidnavigator.com/v1/analyze/file \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "file_id": "<string>",
  "query": "What is discussed in this file?",
  "transcript_text": false
}
'
{
  "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
      }
    ],
    "transcript_analysis": {
      "summary": "<string>",
      "people": [
        {
          "name": "<string>",
          "context": "<string>"
        }
      ],
      "places": [
        {
          "name": "<string>",
          "context": "<string>"
        }
      ],
      "key_subjects": [
        {
          "name": "<string>",
          "description": "<string>",
          "importance": "<string>"
        }
      ],
      "timestamp": 123,
      "relevant_text": "<string>",
      "query_answer": {
        "answer": "<string>",
        "best_segment_index": 123,
        "relevant_segments": [
          "<string>"
        ]
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.vidnavigator.com/llms.txt

Use this file to discover all available pages before exploring further.

Run AI-powered analysis on a previously uploaded audio/video file.

​
Overview

Similar to Analyze Video, but operates on files in your library.

​
Request Body

  • file_id (string, required): ID of the uploaded file to analyze
  • query (string, optional): Ask a specific question about the content

​
Billing

File analysis consumes analysis_request units based on context size. One unit covers up to 15,000 total tokens, and longer contexts are billed with ceil(total_tokens / 15000). For example, an analysis that uses 17,000 total tokens consumes 2 analysis_request units.

​
Example Request

cURL
curl -X POST "https://api.vidnavigator.com/v1/analyze/file" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "file_id": "file_abc123",
    "query": "Summarize the key points"
  }'

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json
​
file_id
string
required

ID of the uploaded file to analyze

​
query
string

Optional question about the file content

Example:

"What is discussed in this file?"

​
transcript_text
boolean
default:false

When true, returns the transcript as a single plain-text string instead of an array of segments.

Response

File analyzed successfully

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