Skip to content
CreatoRainCreatoRain API

Quick start

You need a test key (crp_test_...) and a terminal. Set two variables once:

Terminal window
export CREATORAIN_API="https://sandbox.api.creatorain.com/v1"
export CREATORAIN_KEY="crp_test_..."

1. Get a test key

Section titled “1. Get a test key”

A workspace owner creates keys in the app, under Settings > API. Not live yet

An AI agent with no key can ask its human for one. See Agent quick start.

2. Read your account

Section titled “2. Read your account”
Terminal window
curl "$CREATORAIN_API/account" -H "Authorization: Bearer $CREATORAIN_KEY"

The answer has your account status, counting_locations and blockers. See States and blockers.

3. Quote a store first, with a dry run

Section titled “3. Quote a store first, with a dry run”

A dry run checks the request and quotes it. It writes no store.

Terminal window
curl -X POST "$CREATORAIN_API/locations?dry_run=true" \
  -H "Authorization: Bearer $CREATORAIN_KEY" \
  -H "Idempotency-Key: quickstart-dry-1" \
  -H "Content-Type: application/json" \
  -d '{"name":"Sexy Crab Duluth","address":"2416 Pleasant Hill Rd, Duluth, GA 30096","videos_per_month":4,"accepted_terms":"network-2026-10"}'

The answer shows price_per_video_cents and the deposit quote. deposit.charged is always false.

4. Add the store

Section titled “4. Add the store”

Send the same body without dry_run, with a new Idempotency-Key. The store is created on hold (state: on_hold). Nothing books it until CreatoRain releases it.

5. Watch it work

Section titled “5. Watch it work”
Terminal window
curl "$CREATORAIN_API/locations" -H "Authorization: Bearer $CREATORAIN_KEY"
curl "$CREATORAIN_API/visits" -H "Authorization: Bearer $CREATORAIN_KEY"
curl "$CREATORAIN_API/videos" -H "Authorization: Bearer $CREATORAIN_KEY"
curl "$CREATORAIN_API/bill/preview" -H "Authorization: Bearer $CREATORAIN_KEY"

On the sandbox, a simulator moves a store through its life in minutes. Not live yet

Next

Section titled “Next”