Workspace endpoints give agents the context they need to plan work, pick defaults, and avoid failed jobs. This is the first stop for any automation that runs on behalf of a user.

## Endpoints [#endpoints]

* `GET /v1/workspace`
* `GET /v1/workspace/settings`
* `PATCH /v1/workspace/settings`
* `GET /v1/workspace/credits`
* `GET /v1/workspace/storage`
* `GET /v1/workspace/members`

## Get Workspace Info [#get-workspace-info]

```bash title="Terminal"
curl https://blitzreels.com/api/v1/workspace \
  -H "Authorization: Bearer $BLITZREELS_API_KEY"
```

```json title="Response"
{
  "workspace": {
    "id": "workspace-uuid",
    "name": "Blitz Studio",
    "plan": "creator",
    "createdAt": "2026-02-04T09:00:00Z"
  }
}
```

## Get Workspace Settings [#get-workspace-settings]

Settings include default output preferences and automation toggles.

```bash title="Terminal"
curl https://blitzreels.com/api/v1/workspace/settings \
  -H "Authorization: Bearer $BLITZREELS_API_KEY"
```

`protected_words` is the canonical field for terms agents should preserve in transcripts and captions. `safeWords` and `safe_words` are backwards-compatible aliases returned for older clients.

## Update Workspace Settings [#update-workspace-settings]

Send only fields you want to change. If both `protected_words` and `safe_words` are present, they must clean to the same list.

```bash title="Terminal"
curl -X PATCH https://blitzreels.com/api/v1/workspace/settings \
  -H "Authorization: Bearer $BLITZREELS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Fullstack developer content creator",
    "protected_words": ["IA", "Claude Code", "Codex"],
    "defaults": {
      "aspect_ratio": "9:16",
      "frame_rate": "30",
      "auto_manage_broll": true
    }
  }'
```

## Get Credits [#get-credits]

```bash title="Terminal"
curl https://blitzreels.com/api/v1/workspace/credits \
  -H "Authorization: Bearer $BLITZREELS_API_KEY"
```

```json title="Response"
{
  "credits": {
    "remaining": 120,
    "used": 380,
    "period": "month"
  }
}
```

## Get Storage Usage [#get-storage-usage]

```bash title="Terminal"
curl https://blitzreels.com/api/v1/workspace/storage \
  -H "Authorization: Bearer $BLITZREELS_API_KEY"
```

## List Members [#list-members]

```bash title="Terminal"
curl https://blitzreels.com/api/v1/workspace/members \
  -H "Authorization: Bearer $BLITZREELS_API_KEY"
```

## Agent Checklist [#agent-checklist]

* Check credits before running generation jobs.
* Confirm workspace settings for preferred aspect ratio or export resolution.
* Use member list to show available owners or collaborators.

## Related [#related]

* [Rate Limits](/docs/rate-limits)
* [Media Library](/docs/media-library)
* [Jobs and Exports](/docs/jobs-exports)