This reference documents every REST endpoint exposed by BlitzReels. Use it alongside the Quickstart for a fast onboarding path.

Base URL

https://www.blitzreels.com/api/v1

If you run BlitzReels on another domain, replace the base URL with your deployment URL.

OpenAPI

The OpenAPI spec is available at:

https://www.blitzreels.com/api/openapi.json

Use it to generate clients, validate requests, or connect GPT Actions.

Authentication

All requests require a Bearer API key.

Terminal

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

Conventions

All timestamps are ISO 8601.
Request bodies are JSON.
Async operations return a job_id or export_id that you can poll.
Use webhooks to avoid polling when possible.

Pagination

List endpoints support pagination using limit and offset.

Terminal

curl "https://www.blitzreels.com/api/v1/workspace/media/assets?limit=20&offset=0" \
  -H "Authorization: Bearer $BLITZREELS_API_KEY"

Errors

Errors return a structured payload:

Response

{
  "error": {
    "code": "invalid_request",
    "message": "The 'name' field is required",
    "param": "name",
    "doc_url": "https://www.blitzreels.com/docs/errors#common-causes"
  }
}

Rate Limits

Rate limits apply per workspace and plan. Treat 429 responses as retryable and prefer polling/backoff for long-running jobs.

API Reference

The REST API reference is generated directly from the OpenAPI schema.

OpenAPI JSON: https://v2.blitzreels.com/api/openapi.json
Raw Markdown (LLM-friendly): https://v2.blitzreels.com/docs/:slug.md

Use the sidebar to browse endpoints by tag.

API Reference

On this page