Skip to content
CreatoRain API
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Home
Get started
Quick start
Agent quick start
Authentication and keys
Sandbox
Going live
Pricing and wallet
Prices
Wallet
Top-ups, holds and refunds
Spend limits
Guides
Video production
Coverage and capacity
Creator data
Orders
Webhooks
Conventions
Errors
Rate limits
States and blockers
API reference
Overview
Console
Endpoints
Overview
Account
Overview
The account this key acts for
Onboarding
Overview
Open an onboarding session (no key)
Poll an onboarding session (session secret, no key)
Locations
Overview
This account's locations, oldest first
Add one location to the CreatoRain Network
Add 1 to 50 locations at once, all or nothing
One location, with this month's pace
Visits
Overview
The creator visits at this account's locations, newest update first
Videos
Overview
The videos posted from this account's locations, newest first
Billing
Overview
What a month costs, as a preview
SDKs and tools
SDKs and tools
Changelog
Changelog
Status
Status
Partner API
Partner API
Partner endpoints
Overview
Locations
Overview
Enrol a store
Change a store's name, address, plan, dishes, language, hours, time zone or contact
Pause scheduling at a store
Resume scheduling at a store
End a store's contract
Approve the samples, or ask for a new batch
Reads
Overview
One store's current state, progress and next visit
Mint a 30 minute read-only token for one store
One store's creator bookings
One store's published videos
One store's named creators (accepted or later)
The current batch of sample creators (sample review stores)
Every store's bookings, for your operations desk
Your whole estate, in one call
Acknowledgement
Overview
The merchant saw this booking
Billing
Overview
That month's reconciliation detail, per store
Pricing
Overview
The finished price for a merchant's choices, before a store exists
Your settings
Set your surcharge per video, once for all stores
GitHub
Select theme
Dark
Light
Auto
Not live yet: the v1 API and its hosts are not open. See
Sandbox
.
Overview
Billing
Section titled “Billing”
What this month will cost, as a preview. Nothing here charges.
Operations
Section titled “Operations”
GET
/bill/preview
