Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
PUT /v1/screenshots/ — update a screenshot’s name or options.
PUT https://api.screenshotly.dev/v1/screenshots/{screenshotId}
X-API-Key
Content-Type
application/json
{ "success": true, "data": { "_id": "67b8a1c2d3e4f5a6b7c8d9e0", "url": "https://example.com", "name": "Updated name", "status": "completed", "imageUrl": "https://cdn.screenshotly.dev/screenshots/67b8a1c2d3e4f5a6b7c8d9e0.png", "options": { "format": "png", "viewport_width": 1280, "viewport_height": 1024 }, "metadata": { "fileSize": 245760, "format": "png", "dimensions": { "width": 1280, "height": 1024 } }, "createdAt": "2025-05-14T10:00:00.000Z", "updatedAt": "2025-05-14T12:30:00.000Z" } }
missing_api_key
invalid_api_key
forbidden
not_found
curl -X PUT https://api.screenshotly.dev/v1/screenshots/67b8a1c2d3e4f5a6b7c8d9e0 \ -H "X-API-Key: $SCREENSHOTLY_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name": "Homepage - May 2025"}'