BlitzReels
BlitzReelsDocumentation

Workspace Context

Read workspace settings, credits, storage usage, and members for agent context.

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

  • 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

Terminal
curl https://www.blitzreels.com/api/v1/workspace \
  -H "Authorization: Bearer $BLITZREELS_API_KEY"
Response
{
  "workspace": {
    "id": "workspace-uuid",
    "name": "Blitz Studio",
    "plan": "creator",
    "createdAt": "2026-02-04T09:00:00Z"
  }
}

Get Workspace Settings

Settings include default output preferences and automation toggles.

Terminal
curl https://www.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

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

Terminal
curl -X PATCH https://www.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

Terminal
curl https://www.blitzreels.com/api/v1/workspace/credits \
  -H "Authorization: Bearer $BLITZREELS_API_KEY"
Response
{
  "credits": {
    "remaining": 120,
    "used": 380,
    "period": "month"
  }
}

Get Storage Usage

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

List Members

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

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.