快速开始
本章引导你完成从打开 Agentbase Console 到创建第一个项目、完成第一次调用的最小路径。
1. 访问 Console
在浏览器打开部署提供的 Console 地址(/console/)。未登录访问受保护页面时,会携带原始地址跳转到登录页 /console/login。
登录流程、MFA 与邮箱验证的重定向行为见注册与登录。
2. 创建 Organization 与 Project
截图未公开:上游原图包含真实账号或资源标识。
- 登录后进入 Organization;首次使用会进入创建组织引导(默认名
Personal Projects)。 - 在 Organization 内创建 Project,创建时选择区域(详见项目总览)。创建完成页提供 Agentbase Agent Skill 卡片,可复制当前环境的安装提示词,供 Cursor、Claude Code 等 Agent 工具使用。
- 在 Project 内按需启用 Auth、Database、Storage、Functions、Messaging 等服务;部分能力(如统一 AI 网关 AI Gateway)默认关闭,需在项目 Settings 中开启。
3. 完成第一个调用
以下步骤构成一次可验证的闭环:
- 创建 API Key:项目 Overview → Integrations → API keys,勾选
health.read与users.readscope(完整流程见项目总览),复制 secret(standard_开头)与区域端点。 - 无凭据版本检查:
GET /v1/health/version为公开端点,不需要任何 Key:
curl -fsSL https://{你的部署域名}/v1/health/version
# 预期成功(HTTP 200):{"version":"2.6.0"}- 带 Key 的首个数据面请求:
GET /v1/users(需要users.readscope):
# Key 只经环境变量传入,不写进命令行(避免进入 shell 历史与进程列表)
curl -fsSL 'https://{你的部署域名}/v1/users' \
-H 'X-Appwrite-Project: {PROJECT_ID}' \
-H "X-Appwrite-Key: ${APPBASE_API_KEY}" \
-H 'Content-Type: application/json'
# 预期成功(HTTP 200):{"users":[ …用户数组… ],"total":<总数>}- 预期错误(结构化错误体
{message, code, type, version, requestId}): - Key 缺少
users.read:HTTP 401,type=general_unauthorized_scope; - Project ID 与 Key 所在项目不匹配:HTTP 403 / 404(
project_id_missing/project_not_found); - 完全不带 Key:HTTP 401,
type=user_unauthorized。
- Key 缺少
SDK 初始化与更多语言示例见官方 SDK 文档,本手册不展开各语言 SDK 用法。
常见入口
| 目标 | 入口 |
|---|---|
| 查看服务版本 | GET /v1/health/version(当前 2.6.0) |
| Function 运行时列表 | Project → Functions(含 java-17.0,见函数) |
| Console 路由速查 | 界面与路由速查 |
| 问题排查 | 常见问题 |