API Reference
REST API overview for ScreenFramed captures, raw screenshots, async jobs, usage, projects, auth profiles, 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.
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.