API Reference
REST API overview for ScreenFramed captures, raw screenshots, async jobs, usage, projects, auth profiles, backgrounds, and device login.
Base URL:
txthttps://screenframed.com
All protected endpoints accept:
txtAuthorization: Bearer sf_live_...
Main resources
Response conventions
Successful JSON responses use resource-specific shapes. Errors use:
json{ "error": { "code": "invalid_params", "message": "Missing required field: url (or site)" }}
See Errors for retry guidance.
Authentication scopes
API keys can be scoped. Common scopes include capture, raw, jobs, usage, auth_profiles, and projects.
Use separate live and test keys for development. Test keys preserve most behavior but should not be used as production credentials.
The backgrounds discovery endpoints are public so browser UIs can browse the visual catalog without exposing an API key.
Interactive OpenAPI
The OpenAPI spec for these docs lives at /openapi.json. API pages in this section are linked to the spec for playgrounds, schemas, and generated examples.