​
Get Project By Project Id

You can also hit the get project endpoint to get the response. Refer to the Get Project Page.

​
Webhook Response

When Quickreel completes processing your request, it sends a webhook response to the URL specified in the webhookUrl parameter. Below is an example of the response you will receive:

{
  "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/67618d230847a22a7550faf9/676409ad10ded0f9fc89d224/67640a41df9247bc89de7813_final_hook.mp4",
      "thumbnailUrl": "https://qr-be-api-upload.s3.us-east-1.amazonaws.com/67618d230847a22a7550faf9/676409ad10ded0f9fc89d224/67640a41df9247bc89de7813_trim_thumbnail.jpg",
      "info": {
        "title": "The Fame Game: Family vs Fortune! :moneybag::trophy:",
        "caption": ":boom: In a world where fame reigns supreme, what would you choose? :broken_heart: Family or 100 Crores? Let's dive into the glitzy side of fame as we pick between loved ones and riches! :star2::sparkles: #Fame #Choices #Bollywood #Celebrities #Viral",
        "viralityScore": 88,
        "viralityScoreReason": "The relatable theme of choosing between family and wealth taps into a universal dilemma, increasing its appeal. The celebrity context adds intrigue, likely to resonate with fans and attract shares.",
        "tags": ["fame", "family", "bollywood", "choices", "viral"],
        "suitablePlatforms": ["x", "youtube"]
      }
    }
  ]
}

Response Attributes:

  • projectId: The unique identifier of the project.
  • status: The status of the project.
  • createdAt: The date and time the request was created.
  • completedAt: The date and time the project was completed.
  • error: Any error information if applicable.
  • outputs: An array containing details of each output.
    • id: The unique identifier of the output.
    • videoUrl: The URL to access the video.
    • thumbnailUrl: The URL to access the thumbnail.
    • info: An object containing additional information about the output.
      • title: The title of the output.
      • caption: The caption of the output.
      • viralityScore: The virality score of the output.
      • viralityScoreReason: The reason for the virality score.
      • tags: An array of tags associated with the output.
      • suitablePlatforms: Platforms suitable for the output.

​
Note on Response Handling:

You will have to send a 200 status code immediately after receiving the response.

If you want more details on handling webhook responses, refer to the Webhook Handling Page in the documentation.

RequestOverview