> ## Documentation Index
> Fetch the complete documentation index at: https://docs.videohighlight.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started with the Video Highlight API

> Learn how to use the Video Highlight API to transcribe, summarize, and analyze videos.

You can use the Video Highlight API to transcribe, summarize, and analyze videos. This API is useful for creating video highlights, generating video transcripts, and extracting insights from videos.

<CardGroup cols={2}>
  <Card title="Transcripts" icon="file-lines" href="/api-v1/transcripts">
    Extract accurate transcripts from YouTube, Vimeo, DailyMotion and private media files
  </Card>

  <Card title="Summaries" icon="list" href="/api-v1/summaries">
    Generate intelligent summaries and key points from your video content
  </Card>
</CardGroup>

## Authentication

The Video Highlight API uses API keys for authentication. Visit your [API Keys](https://videohighlight.com/profile/api-keys) page to retrieve the API key you'll use in your requests.

<Warning>
  **Keep your API key secure!**

  Do not share it with others or expose it in any client-side code (browsers, apps). Requests should be routed through server code where your API key can be securely loaded from an environment variable or key management service.
</Warning>

All API requests should include your API key in an Authorization HTTP header as follows:

<CodeGroup>
  ```bash Authorization Header theme={null}
  Authorization: Bearer VIDEOHIGHLIGHT_API_KEY
  ```

  ```javascript JavaScript Example theme={null}
  const headers = {
    'Authorization': `Bearer ${process.env.VIDEOHIGHLIGHT_API_KEY}`,
    'Content-Type': 'application/json'
  };
  ```

  ```python Python Example theme={null}
  headers = {
      'Authorization': f'Bearer {os.environ["VIDEOHIGHLIGHT_API_KEY"]}',
      'Content-Type': 'application/json'
  }
  ```
</CodeGroup>

## Making your first request

Paste the command below into your terminal to run your first API request. Replace `$VIDEOHIGHLIGHT_API_KEY` with your secret API key.

<CodeGroup>
  ```bash cURL theme={null}
  curl --location 'https://videohighlight.com/api-v1/transcripts/65_PmYipnpk?languageCode=en' \
  --header 'Content-Type: application/json' \
  --header 'API-Key: $VIDEOHIGHLIGHT_API_KEY'
  ```

  ```javascript JavaScript/Node.js theme={null}
  const response = await fetch('https://videohighlight.com/api-v1/transcripts/65_PmYipnpk?languageCode=en', {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.VIDEOHIGHLIGHT_API_KEY
    }
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests
  import os

  url = "https://videohighlight.com/api-v1/transcripts/65_PmYipnpk"
  params = {"languageCode": "en"}
  headers = {
      "Content-Type": "application/json",
      "API-Key": os.environ["VIDEOHIGHLIGHT_API_KEY"]
  }

  response = requests.get(url, params=params, headers=headers)
  data = response.json()
  print(data)
  ```
</CodeGroup>

<Tip>
  This example fetches the transcript for a Steve Jobs video. You'll get a JSON response with the complete transcript segments and timestamps.
</Tip>

## Postman collection

<Steps>
  <Step title="Install Postman">
    Download and install Postman <img src="https://mintcdn.com/videohighlight/7Rb4washtdIXt9UW/images/postman-logo-icon-orange.svg?fit=max&auto=format&n=7Rb4washtdIXt9UW&q=85&s=9e3ef0d58e752d90c07b1c63a7f55e30" alt="Postman Logo" height="12" className={"h-4 w-4 inline-flex"} data-path="images/postman-logo-icon-orange.svg" /> from [https://www.postman.com/downloads/](https://www.postman.com/downloads/)
  </Step>

  <Step title="Download Collection">
    Download the Video Highlight API collection from [here](https://vhl-static.s3.amazonaws.com/docs/api-v1/Video_Highlight_API_Collection.zip)

    The archive contains:

    * **Collection file**: All API requests with examples
    * **Environment variables**: Template for your API key configuration
  </Step>

  <Step title="Import & Configure">
    1. Import both files into Postman
    2. Set your `VIDEOHIGHLIGHT_API_KEY` in the environment variables
    3. Start making requests!
  </Step>
</Steps>

<Note>
  The easiest way to get started with the Video Highlight API is to use our Postman collection. This collection includes all the API endpoints and example requests, making it simple to test and understand the API functionality.
</Note>

## API Base URL

<div className="mb-4">
  <code className="bg-gray-100 px-2 py-1 rounded text-lg">[https://videohighlight.com/api-v1](https://videohighlight.com/api-v1)</code>
</div>

## Future changes and backward compatibility

<Info>
  **Version Management**

  This URL will change in the future when significant changes are made to the API. Always refer to the [API documentation](https://videohighlight.com/docs) for the latest information.

  We maintain backward compatibility within major versions, so your integrations will continue to work as we add new features.
</Info>

## Next Steps

<CardGroup cols={1}>
  <Card title="Explore Summaries API" icon="list" href="/api-v1/summaries">
    Learn how to generate intelligent summaries from your video content with our comprehensive summaries endpoint documentation.
  </Card>
</CardGroup>

<Tip>
  **Pro Tip**: Start with the GET endpoints to retrieve existing data, then move to the streaming endpoints for real-time processing. The streaming endpoints require transcripts to be available first.
</Tip>