API Documentation
Complete reference for integrating with the Battery Animation App2. All public endpoints require an API key in the x-api-key header.
Simple & Easy
Get started in minutes with our RESTful API
Secure & Reliable
API key authentication with rate limiting
High Performance
Fast response times with optimized media delivery
Base URL
http://localhost:3000/api/v1Authentication
Include your API key in every request header. Requests without a valid key receive a 401 response.
x-api-key: YOUR_API_KEYRate Limits
Default rate limit is 1,000 requests per hour per API key. Contact us for higher limits.
| Tier | Limit |
|---|---|
| Default | 1,000 / hour |
| Starter | 10,000 / hour |
| Pro | 50,000 / hour |
| Enterprise | Custom |
Available Endpoints
GET
/api/v1/wallpapersGET
/api/v1/wallpapers/:idPOST
/api/v1/wallpapersPUT
/api/v1/wallpapers/:idDELETE
/api/v1/wallpapers/:idPOST
/api/v1/wallpapers/zip-uploadPOST
/api/v1/wallpapers/bulk-deletePOST
/api/admin/wallpapers/reorderGET
/api/v1/animationsGET
/api/v1/animations/:idPOST
/api/v1/animationsPUT
/api/v1/animations/:idDELETE
/api/v1/animations/:idPOST
/api/v1/animations/zip-uploadPOST
/api/v1/animations/bulk-deletePOST
/api/admin/animations/reorderExample Request
curl -X GET "http://localhost:3000/api/v1/wallpapers" \ -H "x-api-key: YOUR_API_KEY" \ -H "Accept: application/json" \ -G --data-urlencode "page=1" \ --data-urlencode "per_page=10"
Example Response
JSON
{
"success": true,
"data": {
"wallpapers": [
{
"id": "clx123abc",
"name": "Ocean Waves Live Wallpaper",
"url": "http://localhost:3000/uploads/wallpapers/ocean-waves.mp4",
"fileName": "ocean-waves.mp4",
"fileSize": 15728640,
"format": "MP4",
"mimeType": "video/mp4",
"width": 1920,
"height": 1080,
"duration": 15.5,
"thumbnailUrl": "http://localhost:3000/uploads/thumbnails/ocean-waves.jpg",
"order": 1,
"status": "Published",
"tags": ["ocean", "waves", "live"],
"createdAt": "2026-06-18T10:30:00.000Z"
}
],
"pagination": {
"page": 1,
"perPage": 10,
"total": 1,
"totalPages": 1
}
}
}Need integration help? Contact support@mediacontentapi.com or try the API Explorer.