API
The FreshShots API enables programmatic access to your screenshot workflows, perfect for CI/CD integration and automated screenshot updates.
Authentication
All API requests require authentication using your API key. Include it in the request header:
x-api-key: YOUR_API_KEY_HERE
Getting Your API Key
- Sign in to your FreshShots dashboard
- Navigate to Account Settings from the user menu
- Find the API Keys section
- Copy your API key (premium feature)
Base URL
https://api.freshshots.io
Available Endpoints
- Trigger Workflow - Execute a workflow programmatically
- CI/CD Integration - Integrate with popular CI/CD platforms
- Job Status - Check workflow execution status
Rate Limits
- Free Plan: 10 API calls per month
- Startup Plan: 500 API calls per month
- Scaleup Plan: 10,000 API calls per month
Error Responses
The API returns standard HTTP status codes:
200- Success401- Unauthorized (invalid API key)404- Resource not found429- Rate limit exceeded500- Server error
Error responses include a JSON body with details:
{
"error": "Invalid API key",
"code": "UNAUTHORIZED"
}