Make Your First API Call

​

Step 6: Make Your First API Call

​

Important Requirements Before Your First Call

1. Project ID: Ensure you have the ID of the project you created. This ID is essential to specify which project configuration to use for generating videos.
2. Credits: Confirm that your account has sufficient credits, as each video generation request will consume credits based on your plan.
3. Optional Parameters: You can pass additional parameters to customize the video generation request, such as overwriteSettings and customPrompt.

​

How to Make Your First API Call

​

Example of a Simple API Call

​

Example using cURL

curl -X POST https://api.videnly.com/v1/videos/queue/add \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"projectId": "YOUR_PROJECT_ID",
"overwriteSettings": false,
"customPrompt": null
}'

• Replace YOUR_API_KEY with the actual API key from the Developers page.
• Replace YOUR_PROJECT_ID with the ID of the project you created.

​

Understanding the Request Body

• projectId: The unique ID of the project you created earlier. This is required for specifying which project settings to use for video generation.
• overwriteSettings (optional): A flag that can be set to true or false to determine if custom project settings should override the saved ones.
• customPrompt (optional | required if overwriteSettings: true): If provided, this custom prompt will be used instead of the default project prompt.

​

Code Examples in Various Languages

const axios = require("axios")

const url = "https://api.videnly.com/v1/videos/queue/add"
const headers = {
   "Content-Type": "application/json",
   Authorization: "Bearer YOUR_API_KEY",
}
const data = {
   projectId: "YOUR_PROJECT_ID",
   overwriteSettings: false,
   customPrompt: null,
}

axios
   .post(url, data, { headers: headers })
   .then((response) => console.log(response.data))
   .catch((error) => console.error(error))

​

Understanding the Response

{
   "status": "success",
   "message": "Video generation request added to queue successfully",
   "newQueueItem": {
      "queueId": "xxxxxxxxxxxxxxxxxxxxxxxx",
      "projectId": "YOUR_PROJECT_ID",
      "status": "pending",
      "generationProgress": 0,
      "renderProgress": 0,
      "videoUrl": null,
      "createdAt": "2024-11-07T14:23:45.213Z"
   }
}

• status: Indicates if the request was successful.
• newQueueItem: Contains details about the queued item, including queueId, status, and createdAt.

​

Verify Your API Call

1. Check the Response: If your request is successful, you should see a response similar to the example above, confirming your video generation request has been added to the queue.
2. Handle Errors: If the request fails, check the response for error messages. Common issues might include an invalid API key, missing projectId, or insufficient credits.

​

Tips for Your First API Call

• Ensure You Have Credits: Each video generation request consumes credits. Confirm your account has enough credits.
• Include the Project ID: Always specify the projectId to ensure the correct settings are applied to the video generation request.
• Use Optional Parameters as Needed: Use overwriteSettings and customPrompt to customize your requests.
• Use Testing Tools: Tools like Postman or cURL can help you debug and confirm your API call works before integrating it.

​

Next Steps: Monitor the Queue

Need Help?
If you encounter any issues or need further guidance, please visit our Support Center.