> ## Documentation Index
> Fetch the complete documentation index at: https://docs.screenframed.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

REST API overview for ScreenFramed captures, raw screenshots, async jobs, usage, projects, auth profiles, backgrounds, and device login.

Base URL:

```txt
https://screenframed.com
```

All protected endpoints accept:

```txt
Authorization: Bearer sf_live_...
```

## Main resources

**[Capture](/api/capture)**

Create styled screenshot renders from URLs, elements, authenticated pages, prompt mode, signed URLs, and async jobs.
  **[Raw](/api/raw)**

Capture an unstyled browser screenshot for debugging or baseline image workflows.
  **[Jobs](/api/jobs)**

Inspect async capture jobs and webhook delivery status.
  **[Backgrounds](/api/backgrounds)**

Discover hosted backgrounds and ready-to-use ScreenFramed background params.
  **[Projects](/api/projects)**

Manage project scopes, brand context, defaults, and signing secrets.
  **[Auth Profiles](/api/auth-profiles)**

Store browser auth state for private dashboard captures.
  **[Usage](/api/usage)**

Read credits remaining and recent render usage.
  **[Device Login](/api/device-login)**

Browser-based device authorization used by the CLI.

## 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](/reference/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`](/openapi.json). API pages in this section are linked to the spec for playgrounds, schemas, and generated examples.