Get started
Quickstart
This guide walks you from zero to your first staged render in five minutes, using curl and a single listing photo.
Step 1 — Create an API key
Sign in to the Console, open Settings → API keys, and click New key. Copy the token immediately — it is shown once.
Step 2 — Set the environment variable
set BKBN_API_KEY=sk_live_xxxxxxxxxxxxxxxxxOn macOS and Linux:
export BKBN_API_KEY=sk_live_xxxxxxxxxxxxxxxxxStep 3 — Run your first staging call
Send a single empty-room photo through the staging-v2.4 workflow and ask for a Scandinavian-warm style at 4K:
curl https://api.bkbn.com/v1/workflows/staging-v2.4/run \
-H "x-api-key: $BKBN_API_KEY" \
-H "bkbn-version: 2026-01-01" \
-H "content-type: application/json" \
-d '{
"input": "https://cdn.bkbn.com/listings/8472/raw.jpg",
"params": { "style": "scandi-warm", "keep_geometry": true }
}'Step 4 — Inspect the result
A successful run returns the rendered image URL plus per-node timings:
{
"request_id": "req_8f3a2c",
"workflow": "staging-v2.4",
"ms": 1244,
"result": {
"url": "https://cdn.bkbn.com/listings/8472/staged.jpg",
"size": "4096x2304",
"watermark": "bkbn"
},
"nodes": [
{ "id": "segment_rooms", "ms": 312 },
{ "id": "mask_furniture", "ms": 184 },
{ "id": "condition_style", "ms": 96 },
{ "id": "render", "ms": 652 }
]
}Next steps
- Authentication — production credentials and workload identity.
- Workflows reference — every available graph.
- Streaming — SSE event types and reconnection.
- Rate limits — tiers and headers.