FLAM

Onboarding

2 Onboarding routes on the FLAM API: First-workflow checklist progress; Complete a checklist step (idempotent).

Base URL https://api.flam.fashion. Send Authorization: Bearer flam_sk_… on every call; a handful of routes are session-only and say so. How keys and roles work.

GET /api/toolkit/onboarding

First-workflow checklist progress

Responses

StatusMeaning
200Progress + reward state
401No valid session

200 returns:

{
  "steps": {},
  "completed": 0,
  "total": 0,
  "reward": {
    "total": 0,
    "granted": true
  }
}

Call it

curl -X GET "https://api.flam.fashion/api/toolkit/onboarding" \
  -H "Authorization: Bearer $FLAM_API_KEY"

POST /api/toolkit/onboarding

Complete a checklist step (idempotent)

Completing the last step mints a one-time 30-token promo grant (rewardJustGranted true exactly once).

Request bodyapplication/json (required)

FieldTypeRequiredNotes
step"brand" | "upload" | "cleanup" | "model" | "tryon" | "organize" | "tokens"yes
{
  "step": "brand"
}

Responses

StatusMeaning
200Updated progress
400BAD_BODY | UNKNOWN_STEP
401No valid session

200 returns:

{
  "steps": {},
  "completed": 0,
  "total": 0,
  "reward": {
    "total": 0,
    "granted": true
  },
  "rewardJustGranted": true
}

Call it

curl -X POST "https://api.flam.fashion/api/toolkit/onboarding" \
  -H "Authorization: Bearer $FLAM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"step":"brand"}'