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

# API Health Check

> Check API health and get endpoint information

Check API health status and get a list of all available endpoints. This endpoint does **not** require authentication.

## Example Request

```bash cURL theme={null}
curl "https://api.vidnavigator.com/v1/health"
```

## Success Response

```json theme={null}
{
  "status": "success",
  "message": "API is healthy",
  "version": "1.0.0",
  "endpoints": [
    { "path": "/transcript", "method": "POST", "description": "Get transcript for non-YouTube videos", "auth_required": true },
    { "path": "/youtube/transcript", "method": "POST", "description": "Get transcript for YouTube videos", "auth_required": true },
    { "path": "/transcribe", "method": "POST", "description": "Transcribe online videos", "auth_required": true },
    { "path": "/analyze/video", "method": "POST", "description": "Analyze online video", "auth_required": true },
    { "path": "/analyze/file", "method": "POST", "description": "Analyze uploaded file", "auth_required": true },
    { "path": "/extract/video", "method": "POST", "description": "Extract structured data from online video", "auth_required": true },
    { "path": "/extract/file", "method": "POST", "description": "Extract structured data from uploaded file", "auth_required": true },
    { "path": "/search/video", "method": "POST", "description": "Search for videos", "auth_required": true },
    { "path": "/tiktok/profile", "method": "POST", "description": "Submit a TikTok profile scrape", "auth_required": true },
    { "path": "/tiktok/profile/{task_id}", "method": "GET", "description": "Get TikTok profile scrape result", "auth_required": true },
    { "path": "/search/file", "method": "POST", "description": "Search uploaded files", "auth_required": true },
    { "path": "/files", "method": "GET", "description": "List uploaded files", "auth_required": true },
    { "path": "/file/{file_id}", "method": "GET", "description": "Get file info and transcript", "auth_required": true },
    { "path": "/file/{file_id}/url", "method": "GET", "description": "Get temporary file URL", "auth_required": true },
    { "path": "/upload/file", "method": "POST", "description": "Upload a file", "auth_required": true },
    { "path": "/file/{file_id}/retry", "method": "POST", "description": "Retry failed file processing", "auth_required": true },
    { "path": "/file/{file_id}/cancel", "method": "POST", "description": "Cancel file processing", "auth_required": true },
    { "path": "/file/{file_id}/delete", "method": "DELETE", "description": "Delete a file", "auth_required": true },
    { "path": "/namespaces", "method": "GET", "description": "List namespaces", "auth_required": true },
    { "path": "/namespaces", "method": "POST", "description": "Create a namespace", "auth_required": true },
    { "path": "/namespaces/{namespace_id}", "method": "PUT", "description": "Rename a namespace", "auth_required": true },
    { "path": "/namespaces/{namespace_id}", "method": "DELETE", "description": "Delete a namespace", "auth_required": true },
    { "path": "/file/{file_id}/namespaces", "method": "PUT", "description": "Update file namespace assignments", "auth_required": true },
    { "path": "/usage", "method": "GET", "description": "Get usage statistics", "auth_required": true },
    { "path": "/health", "method": "GET", "description": "Health check", "auth_required": false }
  ]
}
```


## OpenAPI

````yaml GET /health
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:
  /health:
    get:
      tags:
        - System
      summary: Health check
      description: Check API health and get endpoint information
      operationId: healthCheck
      responses:
        '200':
          description: API is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  message:
                    type: string
                  version:
                    type: string
                  endpoints:
                    type: array
                    items:
                      type: object
                      properties:
                        path:
                          type: string
                        method:
                          type: string
                        description:
                          type: string
                        auth_required:
                          type: boolean
      security: []
components:
  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.

````