가이드 API

콘솔이 코딩 AI에게 전달하는 가이드와 같은 문서를 Markdown으로 가져옵니다. 앱 배포와 데이터베이스, 스토리지, 이메일 연동 지침이 담겨 있습니다. 모든 가이드에 배포 범위 키 또는 Bearer 토큰이 필요하므로 런타임 키를 사용하면 403이 반환됩니다.

이 응답에는 인증 정보가 포함되지 않습니다. 호출할 때 이미 인증되어 있으므로 별도로 발급할 것은 없습니다. 키는 콘솔에서 복사한 가이드에만 포함됩니다.

GET/organizations/:orgId/guide

조직 전체의 DEPLOY.md를 반환합니다. 조직에 이미 존재하는 자원의 현황과 작업에 필요한 영역별 가이드 위치가 담겨 있습니다. 아직 작업할 프로젝트를 모를 때 시작점으로 사용하세요.

응답

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

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

하나의 프로젝트에 대한 배포 가이드(DEPLOY.md)를 반환합니다. 프로젝트 유형에 맞춘 설정과 단계별 배포 지침이 포함됩니다.

응답

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

GET/organizations/:orgId/databases/guide

조직의 데이터베이스 연동 가이드(DATABASE.md)를 반환합니다. 연결 정보, 테이블 스키마, 연동 지침이 포함됩니다.

응답

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

GET/organizations/:orgId/storages/guide

조직의 스토리지 연동 가이드(STORAGE.md)를 반환합니다. 스토리지 설정, 파일 업로드·다운로드 지침, API 예제가 포함됩니다.

응답

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

GET/organizations/:orgId/mails/guide

조직의 이메일 가이드(MAIL.md)를 반환합니다. 발송 도메인과 현재 상태, 앱에서 발송할 때 사용하는 코드가 포함됩니다.

응답

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