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?"
}'
{
  "status": "success",
  "data": {
    "file_info": {
      "id": "<string>",
      "name": "<string>",
      "size": 123,
      "type": "<string>",
      "duration": 123,
      "status": "pending",
      "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>"
    },
    "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>"
        ]
      }
    }
  }
}
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

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

Response

200
application/json

File analyzed successfully

The response is of type object.