Extract Video
Extract Video API Documentation
Description
This endpoint extracts structured data from video files based on a user-defined prompt. It supports input via URL or base64-encoded video content and uses vision-capable Large Language Models (LLMs) to interpret and extract relevant information from the videos.
Please note that this endpoint is charged per second of video duration!
Endpoint
POST /api/v1/extract-video
Headers
- Content-Type:
application/json
- Authorization: Bearer
<API_KEY>
(required) - Request-Source:
string
(optional)
Request Body
{
"inputMethod": "string", // Required. Either "url" or "base64".
"video": "string", // Required. URL or base64-encoded video content.
"prompt": "string", // Required. The prompt describing the data to extract.
"jsonMode": boolean // Optional. Whether to return the result in JSON format. Default: false.
}
Responses
Success (200)
Returns the extracted data based on the provided prompt, along with additional information.
{
"results": "string", // Extracted data based on the prompt
"prompt": "string", // The original prompt used for extraction
"videoDuration": number, // Duration of the video in seconds
"creditUsage": number // Total credits used for this request
}
- Content-Type: application/json
- X-RateLimit-Limit: The rate limit for the user.
- X-RateLimit-Remaining: The remaining number of requests for the user.
Bad Request (400)
Returned if the request is invalid or the video file exceeds size or duration limits.
{
"error": "Error message describing the issue"
}
Unauthorized (401)
Returned if the API key is invalid or missing.
{
"error": "Invalid or missing Authorization header"
}
Internal Server Error (500)
Returned if there’s an error during the video extraction process.
{
"error": "Failed to extract video data: [error details]"
}
Example Request
curl -X POST https://app.dumplingai.com/api/v1/extract-video \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Request-Source: API" \
-d '{
"inputMethod": "url",
"video": "https://example.com/sample-video.mp4",
"prompt": "Describe the main events in this video.",
"jsonMode": false
}'
Notes
- The maximum file size for a video is 2GB.
- The maximum video duration is 1 hour (3600 seconds).
- Supported video formats: mp4, mpeg, mov, avi, flv, mpg, webm, wmv, 3gpp
- Credit usage:
- Base cost: 10 credits
- Additional 1 credit per second of video duration
- The total credit usage is returned in the response as
creditUsage
. - If using the URL method, ensure the video is publicly accessible.
- The
jsonMode
parameter determines whether the output is formatted as JSON (true) or plain text (false). - The endpoint uses the Gemini 1.5 Pro model for video analysis and data extraction.
- Temporary files are created during processing and are deleted after use.
- You can get a list of supported video formats by calling:
GET /api/v1/extract-video
Rate Limiting
Rate limit headers (X-RateLimit-Limit
and X-RateLimit-Remaining
) are included in the response to indicate the user’s current rate limit status.
Error Handling
- If the required parameters (
video
orprompt
) are missing, a 400 Bad Request error is returned. - If the video file size exceeds 2GB, a 400 Bad Request error is returned.
- If the video duration exceeds 1 hour, a 400 Bad Request error is returned.
- If there’s an error during extraction, a 500 Internal Server Error is returned with details about the failure.
Security and Privacy
- Uploaded videos are temporarily stored and then deleted after processing.
- Video metadata (including duration) is checked using a separate Python service before processing.