​
1. Request Your API Key

To use the QuickReel API, you’ll need an API key. Get yours from registering through the QuickReel API Dashboard.

​
2. Base URL

All API requests should be made to:

https://engine.quickreel.io/api/v2

​
3. Authentication

​
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 section.

{
  "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 section.

GET https://engine.quickreel.io/api/v2/projects/{projectId}

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

​
Rate Limits and Quotas

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

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