Guides API

Fetch deployment and database integration guides as Markdown. These guides contain project-specific instructions that coding AIs can follow to deploy your app or connect to databases.

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

Returns the deployment guide (DEPLOY.md) for a project. The guide includes API credentials, project configuration, and step-by-step deployment instructions.

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..."
}