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

> Complete reference for the VidNavigator Developer API

## Welcome to VidNavigator API

The VidNavigator Developer API provides programmatic access to advanced video intelligence capabilities — transcription, analysis, structured data extraction, and semantic search — across all major video platforms including YouTube, TikTok, Instagram, X/Twitter, Facebook, Vimeo, Loom, Dailymotion, and your own uploaded files.

<CardGroup cols={2}>
  <Card title="OpenAPI Specification" icon="code" href="/api-reference/openapi.json">
    View the complete OpenAPI 3.0 specification
  </Card>

  <Card title="Get Started" icon="rocket" href="/quickstart">
    Quick start guide for making your first API call
  </Card>
</CardGroup>

## Authentication

All API endpoints require authentication using an API key passed in the `X-API-Key` header:

```bash theme={null}
X-API-Key: YOUR_API_KEY
```

Get your API key from the [VidNavigator Developer Dashboard](https://vidnavigator.com/studio/api).

## Base URL

The API is available at:

```
https://api.vidnavigator.com/v1
```

## Error Handling

The API uses standard HTTP status codes and returns structured error responses:

```json theme={null}
{
  "status": "error",
  "error": "error_type",
  "message": "Human readable error message"
}
```

### Common Error Codes

| Status Code | Error Type              | Description                                     |
| ----------- | ----------------------- | ----------------------------------------------- |
| 400         | `bad_request`           | Invalid request parameters                      |
| 401         | `unauthorized`          | Missing or invalid API key                      |
| 402         | `payment_required`      | Credit limit exceeded or no active subscription |
| 403         | `access_denied`         | Insufficient permissions                        |
| 404         | `not_found`             | Resource not found                              |
| 429         | `rate_limit_exceeded`   | Rate limit exceeded                             |
| 500         | `internal_server_error` | Server error                                    |

## API Categories

<CardGroup cols={2}>
  <Card title="Transcripts" icon="file-lines" href="/api-reference/endpoint/transcript">
    Extract transcripts from YouTube, TikTok, Instagram, X/Twitter, Facebook, Vimeo, Loom, and more
  </Card>

  <Card title="File Management" icon="folder" href="/api-reference/endpoint/upload-file">
    Upload, manage, and organize audio/video files with namespaces
  </Card>

  <Card title="AI Analysis" icon="brain" href="/api-reference/endpoint/analyze-video">
    Analyze video content with AI for insights and summaries
  </Card>

  <Card title="Data Extraction" icon="wand-magic-sparkles" href="/api-reference/endpoint/extract-video">
    Extract structured data from transcripts using custom schemas
  </Card>

  <Card title="Semantic Search" icon="magnifying-glass" href="/api-reference/endpoint/search-video">
    Search across videos using natural language queries
  </Card>
</CardGroup>