The OpenAPI specification of the API was incomplete: it listed about half of the options, and a client or an AI agent that relied on it could miss the rest, for example rendering PDFs. It is now complete and stays in sync with the API.
What the specification covers now
- Every option for screenshots, with its type, allowed values, limits and a short description.
- Animated screenshots, which were missing entirely, with all their options.
- All formats, including PDF and Markdown.
- Responses of bulk screenshots and usage as the API returns them.
The specification is available as YAML and as JSON. Every release of the API is now checked against it, so a new option can’t ship without being described.
Old options were removed
While going through the options, we removed a few old ones that are no longer supported. Very few requests used them.
If one of your requests is now rejected with the request_not_valid error that says an option is not allowed, remove that option from the request.
The official JavaScript SDK and Python SDK are updated too: they no longer have methods for the removed options. If you use one of them, upgrade to the latest version.
If you have any questions, please contact support@screenshotone.com.
