> ## 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.

# Usage

Read remaining credits, monthly credits, recent render count, and daily usage.

**Get usage summary**

Returns account credit balance and recent render usage for the authenticated key.

```bash
curl "https://screenframed.com/v1/usage" \
  -H "Authorization: Bearer $SCREENFRAMED_API_KEY"
```

```json
{
  "credits_remaining": 185,
  "credits_monthly": 200,
  "last_30_days": {
    "render_count": 14,
    "credits_used": 31
  },
  "daily_breakdown": [
    { "day": "2026-04-27", "renders": 4, "credits": 10 }
  ]
}
```

## Fields

**credits_remaining**

Credits currently available on the account.

**credits_monthly**

Monthly credit allocation for the account plan.

**last_30_days**

Aggregate render count and credits used over the last 30 days.

**daily_breakdown**

Daily usage rows for recent activity.

` GET /v1/usage `

Get usage summary

## Servers

- ` https://screenframed.com ` — Production

## Authentication

The operation accepts these alternatives. Schemes within one alternative are required together.

### Alternative 1

- ` bearerAuth `: ` http `

  - HTTP scheme: ` bearer `

  - ScreenFramed API key, such as `sf_live_...`.

## Responses

### ` 200 ` — Usage summary

Content type: ` application/json `

- ` value `: type ` object `

  - ` credits_remaining `: type ` integer `

  - ` credits_monthly `: type ` integer `

  - ` last_30_days `: type ` object `

    - ` render_count `: type ` integer `

    - ` credits_used `: type ` integer `

  - ` daily_breakdown `: type ` array `

    - ` array item `: type ` object `

      - ` day `: type ` string `

      - ` renders `: type ` integer `

      - ` credits `: type ` integer `

### ` 401 ` — Error response

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` error `

  - ` error `: type ` object `

    - Required fields: ` code `, ` message `

    - ` code `: type ` string `

    - ` message `: type ` string `

    - ` details `: type ` object `

    - ` retry_after `: type ` integer `

### ` 403 ` — Error response

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` error `

  - ` error `: type ` object `

    - Required fields: ` code `, ` message `

    - ` code `: type ` string `

    - ` message `: type ` string `

    - ` details `: type ` object `

    - ` retry_after `: type ` integer `

## Request examples

### cURL

```curl
curl -X GET 'https://screenframed.com/v1/usage' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'
```

### JavaScript

```javascript
const response = await fetch('https://screenframed.com/v1/usage', {
  method: 'GET',
  headers: {
      "Authorization": "Bearer YOUR_API_TOKEN"
  }
});

const data = await response.json();
console.log(data);
```

### Python

```python
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.get('https://screenframed.com/v1/usage', headers=headers)
print(response.json())
```