مرجع API

شروع کار

مراحل راه‌اندازی پس از ثبت‌نام، قدم‌های شروع کار تیم و فهرست آمادگی پروداکشن هر پروژه.

توضیح هر مسیر به انگلیسی است، همان متنی که مرجع از کد ساخته می‌شود. مسیرها، نام فیلدها و کدها همان‌اند که در درخواست می‌نویسید.

GET/v1/me/onboarding

The first-run flow#

The signed-in person's first-run flow: its steps in order with their status (done, skipped, todo; auto when real state ticked it), the next step, whether it is complete or should be shown, the facts behind it, the current team, and the MCP setup for AI tools.

دسترسی: فقط نشست داشبورد (کلید API پذیرفته نمی‌شود)
نقش‌ها: همهٔ نقش‌ها

پاسخ

200Onboarding

stateobject
what was saved (step, done, skipped, team_kind, plan, build, started_at, dismissed_at, completed_at, celebrated)
stepsobject[]
- keystring
  one of welcome, team, plan, build, cli, git, agent
- optionalboolean
- statusstring
  one of done, skipped, todo
- autoboolean
nextstring | null
completeboolean
showboolean
factsmap of boolean
teamobject
- idstring (uuid)
- namestring
- personalboolean
- planstring
- rolestring
agentobject
the MCP setup for AI tools, the key as a placeholder
- namestring
- urlstring
- snippetsmap of string

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Not allowed: `session_only`
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/me/onboarding" \
  -H "Authorization: Bearer $SESSION"

PATCH/v1/me/onboarding

Save progress in the first-run flow#

Every field optional: step (where the person is), done and skipped (lists of steps), team_kind (personal or team), plan (hobby or pro, the choice; the plan itself changes with POST /v1/billing/plan), build (starter, upload, import, git, cli, later), dismissed, completed, restart (reopen it), celebrated (a project id whose first deploy was shown). Unknown fields are refused. Answers like GET. Needs a dashboard session.

دسترسی: فقط نشست داشبورد (کلید API پذیرفته نمی‌شود)
نقش‌ها: همهٔ نقش‌ها

بدنهٔ درخواست`application/json`

stepstring
one of welcome, team, plan, build, cli, git, agent
donestring[]
skippedstring[]
team_kindstring
one of personal, team
planstring
one of hobby, pro
buildstring
one of starter, upload, import, git, cli, later
dismissedboolean
completedboolean
restartboolean
celebratedstring (uuid)

پاسخ

200Onboarding

stateobject
what was saved (step, done, skipped, team_kind, plan, build, started_at, dismissed_at, completed_at, celebrated)
stepsobject[]
- keystring
  one of welcome, team, plan, build, cli, git, agent
- optionalboolean
- statusstring
  one of done, skipped, todo
- autoboolean
nextstring | null
completeboolean
showboolean
factsmap of boolean
teamobject
- idstring (uuid)
- namestring
- personalboolean
- planstring
- rolestring
agentobject
the MCP setup for AI tools, the key as a placeholder
- namestring
- urlstring
- snippetsmap of string

خطاها

وضعیت	توضیح
400	Bad request: `bad_request`, `bad_json`
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Not allowed: `session_only`
500	`internal`: an unexpected failure

نمونه

curl -X PATCH "https://api.ibel.ai/v1/me/onboarding" \
  -H "Authorization: Bearer $SESSION" \
  -d '{"step":"welcome","done":["…"],"skipped":["…"],"team_kind":"personal","plan":"hobby","build":"starter","dismissed":true,"completed":true,"restart":true,"celebrated":"8c1e0c55-1f2a-4d3b-9e8f-0a1b2c3d4e5f"}'

GET/v1/team/getting-started

The team's getting-started steps#

The team's first steps, each ticked from real state: project, deploy, git, domain, invite (shared teams only), cli, agent; show is false once all are done or the person dismissed the card.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: همهٔ نقش‌ها

پاسخ

200GettingStarted

itemsobject[]
- keystring
  one of project, deploy, git, domain, invite, cli, agent
- doneboolean
doneinteger
totalinteger
completeboolean
dismissedboolean
showboolean
first_liveobject | null
- namestring
- kindstring
- urlstring

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/team/getting-started" \
  -H "Authorization: Bearer $KEY"

POST/v1/team/getting-started/dismiss

Hide the getting-started card#

For this person. Needs a dashboard session.

دسترسی: فقط نشست داشبورد (کلید API پذیرفته نمی‌شود)
نقش‌ها: همهٔ نقش‌ها

پاسخ

200object

dismissedboolean

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Not allowed: `session_only`
500	`internal`: an unexpected failure

نمونه

curl -X POST "https://api.ibel.ai/v1/team/getting-started/dismiss" \
  -H "Authorization: Bearer $SESSION"

DELETE/v1/team/getting-started/dismiss

Show the getting-started card again#

Needs a dashboard session.

دسترسی: فقط نشست داشبورد (کلید API پذیرفته نمی‌شود)
نقش‌ها: همهٔ نقش‌ها

پاسخ

200object

dismissedboolean

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Not allowed: `session_only`
500	`internal`: an unexpected failure

نمونه

curl -X DELETE "https://api.ibel.ai/v1/team/getting-started/dismiss" \
  -H "Authorization: Bearer $SESSION"

GET/v1/projects/{project}/apps/{name}/checklist

The production checklist#

What is left before it is ready for production, each item ticked from its real state: git (a connected repository or a git push), domain, preview (a branch deployment), env (environment variables), alert, analytics (web analytics on). dismissed marks what this person hid; complete is true when every item is done or hidden.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: همهٔ نقش‌ها

پارامترها

any
namestringمسیرالزامی
the app's name in the project (any case) or its id

پاسخ

200Checklist

projectobject
- idstring (uuid)
- namestring
- kindstring
  one of app, function
itemsobject[]
- keystring
  one of git, domain, preview, env, alert, analytics
- doneboolean
- dismissedboolean
doneinteger
totalinteger
completeboolean
dismissedboolean

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/projects/my-api/apps/my-api/checklist" \
  -H "Authorization: Bearer $KEY"

POST/v1/projects/{project}/apps/{name}/checklist/dismiss

Hide a checklist item, or the checklist#

Body {"item": "<key>"} hides one item; an empty body hides the whole card. For this person. Needs a dashboard session.

دسترسی: فقط نشست داشبورد (کلید API پذیرفته نمی‌شود)
نقش‌ها: همهٔ نقش‌ها

پارامترها

any
namestringمسیرالزامی
the app's name in the project (any case) or its id

بدنهٔ درخواست`application/json`

itemstring
one of git, domain, preview, env, alert, analytics

پاسخ

200Checklist

projectobject
- idstring (uuid)
- namestring
- kindstring
  one of app, function
itemsobject[]
- keystring
  one of git, domain, preview, env, alert, analytics
- doneboolean
- dismissedboolean
doneinteger
totalinteger
completeboolean
dismissedboolean

خطاها

وضعیت	توضیح
400	Bad request: `bad_item`
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Not allowed: `session_only`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X POST "https://api.ibel.ai/v1/projects/my-api/apps/my-api/checklist/dismiss" \
  -H "Authorization: Bearer $SESSION" \
  -d '{"item":"git"}'

DELETE/v1/projects/{project}/apps/{name}/checklist/dismiss

Show the checklist again#

Shows the card and every item again; ?item= for one. Needs a dashboard session.

دسترسی: فقط نشست داشبورد (کلید API پذیرفته نمی‌شود)
نقش‌ها: همهٔ نقش‌ها

پارامترها

any
namestringمسیرالزامی
the app's name in the project (any case) or its id
itemstringکوئری
one of card, git, domain, preview, env, alert, analytics

پاسخ

200Checklist

projectobject
- idstring (uuid)
- namestring
- kindstring
  one of app, function
itemsobject[]
- keystring
  one of git, domain, preview, env, alert, analytics
- doneboolean
- dismissedboolean
doneinteger
totalinteger
completeboolean
dismissedboolean

خطاها

وضعیت	توضیح
400	Bad request: `bad_item`
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Not allowed: `session_only`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X DELETE "https://api.ibel.ai/v1/projects/my-api/apps/my-api/checklist/dismiss" \
  -H "Authorization: Bearer $SESSION"

GET/v1/projects/{project}/functions/{name}/checklist

The production checklist#

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: همهٔ نقش‌ها

پارامترها

any
namestringمسیرالزامی
the function's name in the project (any case) or its id

پاسخ

200Checklist

projectobject
- idstring (uuid)
- namestring
- kindstring
  one of app, function
itemsobject[]
- keystring
  one of git, domain, preview, env, alert, analytics
- doneboolean
- dismissedboolean
doneinteger
totalinteger
completeboolean
dismissedboolean

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/projects/my-api/functions/my-api/checklist" \
  -H "Authorization: Bearer $KEY"

POST/v1/projects/{project}/functions/{name}/checklist/dismiss

Hide a checklist item, or the checklist#

Body {"item": "<key>"} hides one item; an empty body hides the whole card. For this person. Needs a dashboard session.

دسترسی: فقط نشست داشبورد (کلید API پذیرفته نمی‌شود)
نقش‌ها: همهٔ نقش‌ها

پارامترها

any
namestringمسیرالزامی
the function's name in the project (any case) or its id

بدنهٔ درخواست`application/json`

itemstring
one of git, domain, preview, env, alert, analytics

پاسخ

200Checklist

projectobject
- idstring (uuid)
- namestring
- kindstring
  one of app, function
itemsobject[]
- keystring
  one of git, domain, preview, env, alert, analytics
- doneboolean
- dismissedboolean
doneinteger
totalinteger
completeboolean
dismissedboolean

خطاها

وضعیت	توضیح
400	Bad request: `bad_item`
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Not allowed: `session_only`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X POST "https://api.ibel.ai/v1/projects/my-api/functions/my-api/checklist/dismiss" \
  -H "Authorization: Bearer $SESSION" \
  -d '{"item":"git"}'

DELETE/v1/projects/{project}/functions/{name}/checklist/dismiss

Show the checklist again#

Shows the card and every item again; ?item= for one. Needs a dashboard session.

دسترسی: فقط نشست داشبورد (کلید API پذیرفته نمی‌شود)
نقش‌ها: همهٔ نقش‌ها

پارامترها

any
namestringمسیرالزامی
the function's name in the project (any case) or its id
itemstringکوئری
one of card, git, domain, preview, env, alert, analytics

پاسخ

200Checklist

projectobject
- idstring (uuid)
- namestring
- kindstring
  one of app, function
itemsobject[]
- keystring
  one of git, domain, preview, env, alert, analytics
- doneboolean
- dismissedboolean
doneinteger
totalinteger
completeboolean
dismissedboolean

خطاها

وضعیت	توضیح
400	Bad request: `bad_item`
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Not allowed: `session_only`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X DELETE "https://api.ibel.ai/v1/projects/my-api/functions/my-api/checklist/dismiss" \
  -H "Authorization: Bearer $SESSION"

The first-run flow#

پاسخ

خطاها

نمونه

Save progress in the first-run flow#

بدنهٔ درخواستapplication/json

پاسخ

خطاها

نمونه

The team's getting-started steps#

پاسخ

خطاها

نمونه

Hide the getting-started card#

پاسخ

خطاها

نمونه

Show the getting-started card again#

پاسخ

خطاها

نمونه

The production checklist#

پارامترها

پاسخ

خطاها

نمونه

Hide a checklist item, or the checklist#

پارامترها

بدنهٔ درخواستapplication/json

پاسخ

خطاها

نمونه

Show the checklist again#

پارامترها

پاسخ

خطاها

نمونه

The production checklist#

پارامترها

پاسخ

خطاها

نمونه

Hide a checklist item, or the checklist#

پارامترها

بدنهٔ درخواستapplication/json

پاسخ

خطاها

نمونه

Show the checklist again#

پارامترها

پاسخ

خطاها

نمونه

بدنهٔ درخواست`application/json`

بدنهٔ درخواست`application/json`

بدنهٔ درخواست`application/json`