<!-- Markdown copy of https://docs.creatorain.com/reference/ -->
# Overview

**Not live yet:** the v1 API and its hosts are not open. See [Sandbox](/get-started/sandbox/).

## CreatoRain API 1.0.0

A client’s own server or AI agent, holding a key for ONE workspace, uses this API to run restaurant video production. Every response carries a `Request-Id` header; every error has the envelope `{error:{type, code, message, field?, doc_url, request_id}}`.

Rate limit: 600 requests a minute per workspace, across every server that answers. Above it, `429 rate_limited` with `Retry-After`. Twenty failed authentications (missing or unknown key) from one address within a minute block that address for 15 minutes.

Information

-   OpenAPI version: `3.0.3`

## Operations

GET

[/account](/reference/operations/getaccount/)

POST

[/onboarding\_sessions](/reference/operations/createonboardingsession/)

GET

[/onboarding\_sessions/{id}](/reference/operations/getonboardingsession/)

GET

[/locations](/reference/operations/listlocations/)

POST

[/locations](/reference/operations/createlocation/)

POST

[/locations/batch](/reference/operations/createlocationsbatch/)

GET

[/locations/{id}](/reference/operations/getlocation/)

GET

[/visits](/reference/operations/listvisits/)

GET

[/videos](/reference/operations/listvideos/)

GET

[/bill/preview](/reference/operations/getbillpreview/)

## Authentication

### bearerAuth

Authorization: Bearer crp\_live\_… or crp\_rk\_live\_… (live), crp\_test\_… or crp\_rk\_test\_… (sandbox).

**Security scheme type:** http

### sessionSecret

Authorization: Bearer crp\_obs\_… (the session\_secret from POST /onboarding\_sessions). Polls one session only.

**Security scheme type:** http