> ## 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.

# Get File Info

> Retrieve detailed information about a specific file including its transcript if available

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

```bash cURL theme={null}
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.

```json theme={null}
{
  "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
      }
    ]
  }
}
```


## OpenAPI

````yaml GET /file/{file_id}
openapi: 3.0.3
info:
  title: VidNavigator Developer API
  description: >-
    The VidNavigator Developer API provides programmatic access to video
    analysis, transcription, and search capabilities.


    ## Authentication

    All endpoints require API key authentication via the `X-API-Key` header:

    ```

    X-API-Key: YOUR_API_KEY

    ```


    ## Rate Limits

    Check the documentation for the rate limits for each endpoint.


    ## Error Handling

    The API uses standard HTTP status codes and returns error responses in JSON
    format:

    ```json

    {
      "status": "error",
      "error": "error_type",
      "message": "Human readable error message"
    }

    ```
  version: 1.0.0
  contact:
    name: VidNavigator Support
    url: https://vidnavigator.com/support
    email: support@vidnavigator.com
  license:
    name: Proprietary
    url: https://vidnavigator.com/terms
servers:
  - url: https://api.vidnavigator.com/v1
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Transcripts
    description: Extract transcripts from online videos
  - name: TikTok
    description: Scrape TikTok profile metadata and per-video stats
  - name: Files
    description: Manage uploaded audio/video files
  - name: Analysis
    description: AI-powered content analysis
  - name: Extraction
    description: >-
      Extract structured data from video and file transcripts using custom
      schemas
  - name: Namespaces
    description: Organize uploaded files into namespaces (folders)
  - name: Search
    description: Search videos and files using AI
  - name: System
    description: System health and information
  - name: Tweet Analysis
    description: Extract structured claims and metadata from X/Twitter tweets
paths:
  /file/{file_id}:
    get:
      tags:
        - Files
      summary: Get file information and transcript
      description: >-
        Retrieve detailed information about a specific file including its
        transcript if available
      operationId: getFile
      parameters:
        - name: file_id
          in: path
          required: true
          description: The ID of the uploaded file
          schema:
            type: string
        - name: transcript_text
          in: query
          required: false
          description: >-
            When true, returns the transcript as a single plain-text string
            instead of an array of segments (only when transcript is available).
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: File information retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  data:
                    type: object
                    properties:
                      file_info:
                        $ref: '#/components/schemas/FileInfo'
                      transcript:
                        $ref: '#/components/schemas/TranscriptOutput'
                        description: Only included if has_transcript is true
        '403':
          $ref: '#/components/responses/AccessDenied'
        '404':
          $ref: '#/components/responses/FileNotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    FileInfo:
      type: object
      properties:
        id:
          type: string
          description: Unique file identifier
        name:
          type: string
          description: File name
        size:
          type: integer
          description: File size in bytes
        type:
          type: string
          description: MIME type
        duration:
          type: number
          description: Duration in seconds
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
            - cancelled
          description: Processing status
        created_at:
          type: string
          format: date-time
          description: Upload timestamp
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
        original_file_date:
          type: string
          format: date-time
          description: Original file creation date
        has_transcript:
          type: boolean
          description: Whether transcript is available
        error_message:
          type: string
          description: Error message if processing failed
        namespace_ids:
          type: array
          items:
            type: string
          description: IDs of the namespaces this file belongs to
        namespaces:
          type: array
          items:
            $ref: '#/components/schemas/NamespaceRef'
          description: Resolved namespaces this file belongs to (with names)
    TranscriptOutput:
      description: >-
        Transcript output. By default it is an array of segments. When
        `transcript_text=true`, it is returned as a single plain-text string.
      oneOf:
        - type: array
          items:
            $ref: '#/components/schemas/TranscriptSegment'
        - type: string
    NamespaceRef:
      type: object
      description: Resolved namespace reference with ID and display name
      properties:
        id:
          type: string
          description: Namespace identifier
        name:
          type: string
          description: Namespace display name
    TranscriptSegment:
      type: object
      properties:
        text:
          type: string
          description: Transcript text for this segment
        start:
          type: number
          description: Start time in seconds
        end:
          type: number
          description: End time in seconds
  responses:
    AccessDenied:
      description: Access denied - insufficient permissions
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                  - error
              error:
                type: string
                enum:
                  - access_denied
              message:
                type: string
    FileNotFound:
      description: File not found
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                  - error
              error:
                type: string
                enum:
                  - file_not_found
              message:
                type: string
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                  - error
              error:
                type: string
                enum:
                  - internal_server_error
              message:
                type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key authentication. Include your VidNavigator API key in the
        X-API-Key header.

````