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

## Base URL [#base-url]

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

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

## OpenAPI [#openapi]

The OpenAPI spec is available at:

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

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

## Authentication [#authentication]

All requests require a Bearer API key.

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

## Conventions [#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 [#pagination]

List endpoints support pagination using `limit` and `offset`.

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

## Errors [#errors]

Errors return a structured payload:

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

## Rate Limits [#rate-limits]

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

## API Reference [#api-reference]

<APIReference />

## Related [#related]

* [Quickstart](/docs/quickstart)
* [Authentication](/docs/authentication)
* [Errors](/docs/errors)
* [Rate Limits](/docs/rate-limits)
* [Webhooks](/docs/webhooks)