Glossary of Terms
Definitions of key terms and concepts used in the Videnly API and documentation.
API (Application Programming Interface)
An interface that allows different software applications to communicate with each other. The Videnly API provides endpoints for generating, editing, and managing videos programmatically.
API Key
A unique key used to authenticate requests to the Videnly API. This key is required in the Authorization header of every API request to validate the user’s access.
API Request
A call made to the Videnly API to perform an action, such as generating a video or retrieving account information. Each request must be properly formatted and authenticated with an API key.
Authorization Header
A part of the HTTP request that includes credentials for authentication. For Videnly, it contains the API key in the format: Bearer YOUR_API_KEY.
Bearer Token
A type of access token that is included in the Authorization header of an HTTP request to authenticate access to the Videnly API. The format is: Bearer YOUR_API_KEY.
Callback URL
A URL provided by the client application where the API sends responses or notifications, often used in webhooks to receive data or notifications when certain events occur.
Credits
The currency used within Videnly to pay for API requests. Each API action, like generating a video, consumes a certain number of credits. Users can monitor their credits through the dashboard.
Dashboard
The central control panel for managing your Videnly account, including generating API keys, creating video templates, monitoring API usage, and managing your subscription.
Project
A configuration within Videnly used to organize and manage videos by categories like niche, channel, and more. Each project contains settings and parameters that Videnly uses to generate AI-powered videos, allowing for customization of content, style, and scheduling options.
Endpoint
A specific URL path that allows access to a particular function of the Videnly API, such as generating videos or retrieving account details.
Endpoint Method
Specifies the type of operation to be performed on a given resource. Common methods include GET (to retrieve data), POST (to create or update data), and DELETE (to remove data).
Error Codes
Codes returned by the API in response to a request that indicate the success or failure of the request. Common error codes include 403 Forbidden for insufficient credits and 404 Not Found for missing resources.
HTTP (Hypertext Transfer Protocol)
The protocol used for transmitting data over the web. All requests to the Videnly API are made over HTTP.
HTTP Status Codes
Codes returned by the server in response to an API request, indicating the success or failure of the request. Examples include 200 OK, 403 Forbidden, 404 Not Found, and 500 Internal Server Error.
JSON (JavaScript Object Notation)
A lightweight data-interchange format used to structure API requests and responses in a readable format. Videnly uses JSON for its API request bodies and responses.
No-Code Integration
A method of integrating Videnly’s API with third-party tools (like Zapier) without writing code, allowing users to automate workflows and generate videos based on predefined templates.
Rate Limit
The maximum number of API requests that can be made within a certain period. Rate limits vary depending on the user’s subscription plan.
Project ID
A unique identifier assigned to each project created within the Videnly dashboard. Required for making API requests that reference a specific project, allowing users to manage and organize videos by niche, channel, and other categories.
Queue ID
A unique identifier assigned to each queued video generation request. Used to track the status and progress of individual video generation tasks within Videnly’s system.
Usage Monitoring
The process of tracking API usage, including the number of requests made, credits consumed, and remaining balance, accessible through the dashboard.
Whitelisting
A security measure that involves explicitly allowing certain API keys, IP addresses, or domains to access specific API endpoints or resources.