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

# Getting Started

> Welcome to the QuickReel API! This guide will help you integrate our powerful AI-driven video processing features into your application.

### 1. Request Your API Key

<Note>
  To use the QuickReel API, you'll need an API key. Get yours from registering
  through the [QuickReel API Dashboard](https://www.api.quickreel.io/contact).
</Note>

### 2. Base URL

All API requests should be made to:

```bash theme={null}
https://mango.quickreel.io/api/v2
```

### 3. Authentication

<CodeGroup>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://mango.quickreel.io/api/v2/clip \
    --header 'x-api-key: YOUR_API_KEY' \
    --header 'Content-Type: application/json'
  ```

  ```javascript Node.js theme={null}
  const headers = {
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  };
  ```

  ```python Python theme={null}
  headers = {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
  }
  ```
</CodeGroup>

### 4. Getting Responses

There are two ways to receive your API responses:

#### Option A: Webhook Response

When you provide a `webhookUrl` in your request, we'll send the response to your webhook endpoint. More information on webhooks can be found in the [Webhook Handling](/webhook) section.

```json theme={null}
{
  "projectId": "676409ad10ded0f9fc89d224",
  "status": "completed",
  "createdAt": "2024-12-19T11:55:25.602Z",
  "completedAt": "2024-12-19T14:22:35.533Z",
  "error": null,
  "outputs": [
    {
      "id": "67640a41df9247bc89de7813",
      "videoUrl": "https://qr-be-api-upload.s3.us-east-1.amazonaws.com/output.mp4",
      "thumbnailUrl": "https://qr-be-api-upload.s3.us-east-1.amazonaws.com/thumbnail.jpg"
    }
  ]
}
```

#### Option B: Project Status Check

You can also retrieve results by making a GET request to `/projects/{projectId}`. More information on getting your projects by projectId can be found in the [Get Projects](/getProject) section.

```bash theme={null}
GET https://mango.quickreel.io/api/v2/projects/{projectId}
```

<Note>
  The projectId is provided in the initial response when creating a project.
  Save this projectId for future reference.
</Note>

## Rate Limits and Quotas

<Info>
  Our API implements rate limiting to ensure fair usage and optimal performance
  for all users.
</Info>

* **Free Tier**: 100 requests/hour
* **Pro Tier**: 1000 requests/hour
* **Enterprise**: Custom limits available