Guides API

Fetch the written guides as Markdown, the same ones the console hands to a coding AI. They carry the instructions for deploying an app and for wiring it to a database, storage, or email. Every one of them needs a deploy-scope key or a Bearer token, so a runtime key gets 403.

These responses never contain credentials. You are already authenticated when you call them, so there is nothing to issue; the guide copied from the console is the one that carries a key.

GET/organizations/:orgId/guide

Returns the organization-wide DEPLOY.md: a snapshot of what the organization already has, and pointers to whichever area guide the job needs. Use it as the entry point when you do not yet know which project you are working on.

Response

{
  "guide": "# DEPLOY.md\n\n## Your organization\n..."
}

GET/organizations/:orgId/projects/:projectId/guide

Returns the deployment guide (DEPLOY.md) for one project: its configuration and the step-by-step deployment instructions, tailored to the project type.

Response

{
  "guide": "# DEPLOY.md\n\n## Project Configuration\n..."
}

GET/organizations/:orgId/databases/guide

Returns the database integration guide (DATABASE.md) for an organization. The guide includes connection details, table schemas, and integration instructions.

Response

{
  "guide": "# DATABASE.md\n\n## Database Connection\n..."
}

GET/organizations/:orgId/storages/guide

Returns the storage integration guide (STORAGE.md) for an organization. The guide includes storage configuration, file upload/download instructions, and API examples.

Response

{
  "guide": "# STORAGE.md\n\n## Storage Configuration\n..."
}

GET/organizations/:orgId/mails/guide

Returns the email guide (MAIL.md) for an organization, with its sending domains and their current status filled in, plus the code to send from your app.

Response

{
  "guide": "# MAIL.md\n\n## Sending domains\n..."
}