# CreatoRain API

> CreatoRain runs restaurant creator video production: a store joins the CreatoRain Network and local creators visit, post and get measured. The API lets a client server or an AI agent add stores, read visits and videos, and preview the bill. One USD balance pays for videos and API calls.

**Instructions for agents**

- The API is not live on production yet. Read these docs, but do not promise a user that calls will work today.
- Every page has a markdown copy: add `.md` to the page path (for example `/errors.md`). Prefer it to the HTML.
- Authenticate with `Authorization: Bearer <key>`. `crp_test_` keys are for the sandbox, `crp_live_` keys for live. Never put a key in a URL or a log.
- No key yet? Open an onboarding session (`POST /onboarding_sessions`), show your human the `user_code` and `url`, then poll at the given `interval`. The human approves and picks the scopes.
- Send an `Idempotency-Key` on every POST. Reuse the same key when you retry the same request.
- Branch on `error.code`, never on `error.message`. Each code has an anchor on /errors. Quote `request_id` to support.
- On `429`, wait `Retry-After` seconds. The limit is 600 requests a minute per workspace.
- Do not send creator fields (followers, niche, rules). CreatoRain chooses the creators, and the API answers `400 customization_not_supported`.
- Never type or guess a price. Prices are published at launch on /pricing and served by `GET /v1/prices` (not live yet).
- Use `dry_run=true` to see what a location create would write and cost before you write it.

## Documentation Sets

- [Abridged documentation](https://docs.creatorain.com/llms-small.txt): a compact version of the documentation for CreatoRain API, with non-essential content removed
- [Complete documentation](https://docs.creatorain.com/llms-full.txt): the full documentation for CreatoRain API

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Pages

Every page as markdown:

- [CreatoRain API](https://docs.creatorain.com/index.md): Restaurant creator videos by API. Add stores, read visits and videos, preview the bill, from one USD balance.
- [Changelog](https://docs.creatorain.com/changelog.md): Changes to the CreatoRain API, and the deprecation policy.
- [Errors](https://docs.creatorain.com/errors.md): Every CreatoRain API v1 error code, its HTTP status and type, and how to fix it. One anchor per code.
- [Agent quick start](https://docs.creatorain.com/get-started/agent-quick-start.md): How an AI agent with no key gets one from its human, with an onboarding session (RFC 8628 style).
- [Authentication and keys](https://docs.creatorain.com/get-started/authentication.md): API keys, live and test modes, scopes, IP allowlists and the failed-auth block.
- [Going live](https://docs.creatorain.com/get-started/going-live.md): From test keys to live keys, and the first top-up.
- [Quick start](https://docs.creatorain.com/get-started/quick-start.md): Your first CreatoRain API calls on the sandbox, in about 15 minutes.
- [Sandbox](https://docs.creatorain.com/get-started/sandbox.md): Test keys, fixture data and a fast clock, so a store's whole life runs in minutes with no real spend.
- [Conventions](https://docs.creatorain.com/guides/conventions.md): Ids, times, money, pagination, idempotency, dry runs, request ids and versioning.
- [Coverage and capacity](https://docs.creatorain.com/guides/coverage-and-capacity.md): Where CreatoRain has creators, how fast a store fills, and how monthly pacing works.
- [Creator data](https://docs.creatorain.com/guides/creator-data.md): Search and enrich public creator profiles, priced per result in USD. Privacy and opt-out.
- [Orders](https://docs.creatorain.com/guides/orders.md): Website, budget per video and total videos in. Finished posted videos out.
- [Rate limits](https://docs.creatorain.com/guides/rate-limits.md): 600 requests a minute per workspace, the headers that report it, and how to back off.
- [States and blockers](https://docs.creatorain.com/guides/states-and-blockers.md): Account status, location states, blockers and next_action.
- [Video production](https://docs.creatorain.com/guides/video-production.md): Add stores to the CreatoRain Network, and read back visits, posted videos and the bill.
- [Webhooks](https://docs.creatorain.com/guides/webhooks.md): Signed event delivery to your HTTPS endpoint, retries, and the events list.
- [Partner API](https://docs.creatorain.com/partner-api.md): The API a POS or ordering platform uses to enrol its merchants' stores with CreatoRain.
- [Overview](https://docs.creatorain.com/partner-api/reference.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [The merchant saw this booking](https://docs.creatorain.com/partner-api/reference/operations/acknowledgepartnerreservation.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Enrol a store](https://docs.creatorain.com/partner-api/reference/operations/createpartnerlocation.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Mint a 30 minute read-only token for one store](https://docs.creatorain.com/partner-api/reference/operations/createpartnerlocationdashboardtoken.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Approve the samples, or ask for a new batch](https://docs.creatorain.com/partner-api/reference/operations/decidepartnercreatorsamples.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [The current batch of sample creators (sample review stores)](https://docs.creatorain.com/partner-api/reference/operations/getpartnercreatorsamples.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [One store's current state, progress and next visit](https://docs.creatorain.com/partner-api/reference/operations/getpartnerlocation.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [One store's published videos](https://docs.creatorain.com/partner-api/reference/operations/getpartnerlocationcontent.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [One store's named creators (accepted or later)](https://docs.creatorain.com/partner-api/reference/operations/getpartnerlocationcreators.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [One store's creator bookings](https://docs.creatorain.com/partner-api/reference/operations/getpartnerlocationreservations.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [That month's reconciliation detail, per store](https://docs.creatorain.com/partner-api/reference/operations/getpartnermonthlybilling.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [The finished price for a merchant's choices, before a store exists](https://docs.creatorain.com/partner-api/reference/operations/getpartnerpricingquote.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Every store's bookings, for your operations desk](https://docs.creatorain.com/partner-api/reference/operations/getpartnerreservations.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Your settings](https://docs.creatorain.com/partner-api/reference/operations/getpartnersettings.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Your whole estate, in one call](https://docs.creatorain.com/partner-api/reference/operations/getpartnersummary.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Change a store's name, address, plan, dishes, language, hours, time zone or contact](https://docs.creatorain.com/partner-api/reference/operations/patchpartnerlocation.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Pause scheduling at a store](https://docs.creatorain.com/partner-api/reference/operations/pausepartnerlocation.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Set your surcharge per video, once for all stores](https://docs.creatorain.com/partner-api/reference/operations/putpartnersettings.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Resume scheduling at a store](https://docs.creatorain.com/partner-api/reference/operations/resumepartnerlocation.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Overview](https://docs.creatorain.com/partner-api/reference/operations/tags/acknowledgement.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Overview](https://docs.creatorain.com/partner-api/reference/operations/tags/billing.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Overview](https://docs.creatorain.com/partner-api/reference/operations/tags/locations.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Overview](https://docs.creatorain.com/partner-api/reference/operations/tags/pricing.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Overview](https://docs.creatorain.com/partner-api/reference/operations/tags/reads.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [End a store's contract](https://docs.creatorain.com/partner-api/reference/operations/terminatepartnerlocation.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Prices](https://docs.creatorain.com/pricing.md): API prices in US dollars, per call and per 1,000, from one balance. No credits to convert.
- [Spend limits](https://docs.creatorain.com/pricing/spend-limits.md): Daily and monthly limits, the low-balance alert, and what happens at the limit.
- [Top-ups, holds and refunds](https://docs.creatorain.com/pricing/top-ups-holds-refunds.md): Adding money, how a video holds its price, how API usage is booked, refunds and statements.
- [Wallet](https://docs.creatorain.com/pricing/wallet.md): One USD balance, shared by creator videos and API calls. You see "$X left". No credits.
- [Overview](https://docs.creatorain.com/reference.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [API console](https://docs.creatorain.com/reference/console.md): Browse the CreatoRain API v1 spec. Try-it opens with the sandbox.
- [Add one location to the CreatoRain Network](https://docs.creatorain.com/reference/operations/createlocation.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Add 1 to 50 locations at once, all or nothing](https://docs.creatorain.com/reference/operations/createlocationsbatch.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Open an onboarding session (no key)](https://docs.creatorain.com/reference/operations/createonboardingsession.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [The account this key acts for](https://docs.creatorain.com/reference/operations/getaccount.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [What a month costs, as a preview](https://docs.creatorain.com/reference/operations/getbillpreview.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [One location, with this month's pace](https://docs.creatorain.com/reference/operations/getlocation.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Poll an onboarding session (session secret, no key)](https://docs.creatorain.com/reference/operations/getonboardingsession.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [This account's locations, oldest first](https://docs.creatorain.com/reference/operations/listlocations.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [The videos posted from this account's locations, newest first](https://docs.creatorain.com/reference/operations/listvideos.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [The creator visits at this account's locations, newest update first](https://docs.creatorain.com/reference/operations/listvisits.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Overview](https://docs.creatorain.com/reference/operations/tags/account.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Overview](https://docs.creatorain.com/reference/operations/tags/billing.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Overview](https://docs.creatorain.com/reference/operations/tags/locations.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Overview](https://docs.creatorain.com/reference/operations/tags/onboarding.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Overview](https://docs.creatorain.com/reference/operations/tags/videos.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [Overview](https://docs.creatorain.com/reference/operations/tags/visits.md): Docs for the CreatoRain API: restaurant creator video production, creator data, one USD wallet.
- [SDKs and tools](https://docs.creatorain.com/sdks.md): The OpenAPI spec, TypeScript and Python SDKs, and the CreatoRain MCP server for AI agents.
- [Status](https://docs.creatorain.com/status.md): Where to see whether the CreatoRain API is up.

## Optional

- [OpenAPI spec (JSON)](https://docs.creatorain.com/openapi.json): The v1 spec this site is generated from.
- [Partner OpenAPI spec (JSON)](https://docs.creatorain.com/partner-openapi.json)