AgentbaseDocs
文档目录

项目总览

Project 是 Agentbase 的工作与资源边界:数据库、存储、函数、消息、站点、模型凭据等资源都归属某个 Project。本章说明项目的创建、上下文、服务开关、平台登记与接入密钥(API Key / Dev Key)。

创建项目

项目上下文

Project 携带:

上下文说明
区域创建时选择,决定资源位置
服务开关逐项目控制各服务可用性(见下)
认证提供方项目级 Auth 提供方配置(见 Auth 认证)
配额项目级用量与限制

服务开关

在项目 Settings 页的 Services 区逐项开关:

平台登记(Platforms)

客户端(浏览器 / 移动端)SDK 的请求按已登记平台做来源校验:Web 校验 Hostname,Android / Apple 校验包名 / Bundle ID。未登记平台的客户端请求会被拒绝。

入口:项目 Overview → Integrations 的 Platforms 页签(/console/project-{region}-{project}/overview/platforms)。添加 / 修改平台需要 platforms.write 权限(组织角色 owner / admin / developer / editor 具备);新建项目后的 Get started 向导也包含平台登记一步。

添加流程:Platforms 页签 → Add platform 选择类型 → 进入创建向导按类型填写 → 提交(POST /v1/projects/{projectId}/platforms)。类型白名单共 15 种:web、android、unity、apple-ios / apple-macos / apple-watchos / apple-tvos、flutter-web / flutter-android / flutter-ios / flutter-linux / flutter-macos / flutter-windows、react-native-ios / react-native-android。

类型必填字段说明
WebName + Hostname允许发起客户端请求的域名(本地开发可 localhost);向导可选框架(Svelte / React / Nuxt / Next.js / Vue / Angular 等)并生成接入代码
AndroidName + Package name与应用 applicationId(app 级 build.gradle)一致
AppleName + Bundle IDiOS / macOS / watchOS / tvOS 四个子类型分别登记;Bundle ID 见 Xcode 主目标 General
Flutter按目标平台分别登记Android / iOS / Linux / macOS / Windows / Web 各一条;移动端填包名,Web 填 Hostname
React NativeAndroid / iOS 各一条Android 填包名,iOS 填 Bundle ID
UnityName + Package name / Bundle ID按目标平台填写对应标识

字段约束(服务端强制):name ≤ 128 字符;key(Android 包名 / Apple Bundle ID)≤ 256 字符;hostname 必须是合法主机名;可选 store(应用商店 / Google Play ID,≤ 256 字符)。提交成功后向导展示对应 SDK 的安装与初始化代码。

管理:平台详情页可修改 Name / 包名 / Bundle ID / Hostname / Store;删除需确认——删除后来自该平台的客户端请求不再通过来源校验,应用会开始报 401 / CORS 类错误。达到套餐平台数量上限时界面提示。

API Keys 与 Dev Keys

截图未公开:原图可能包含账号或资源标识。

项目的接入密钥在 Overview → Integrations 区域管理,页签:Platforms / API keys / Dev keys(/console/project-{region}-{project}/overview/api-keys 与 …/overview/dev-keys)。API keys 与 Dev keys 的创建入口都需要 keys.write 权限(组织角色 owner / admin / developer / editor 具备)。

两类密钥的定位

API KeyDev Key
用途生产:服务端应用按 scope 访问项目 API仅开发环境:绕过限流与 CORS 报错、获得更详细的错误日志
Scopes创建时按需勾选权限无 scope 概念
有效期Never / 7 / 30 / 90 天 / 1 年 / 自定义日期仅 1 / 7 / 30 天(不能永久)
Secretstandard_ 前缀无前缀;请求头 X-Appwrite-Dev-Key
说明用于生产环境对线上数据与服务的安全访问"Bypass Agentbase rate limits and CORS errors in your development environment.";严格限开发用途

创建 API Key

先保存再关页面:secret 应立即复制并存入密钥管理设施。详情页之后仍可再次查看(对 owner / 创建者 / 特权成员可见,见下),但不应把它当公开信息。

管理 API Key

Key 详情页(/overview/api-keys/{keyId}):

创建与管理 Dev Key

安全保存与轮换建议

项目首页与导航

截图未公开:原图可能包含账号或资源标识。

项目内左侧边栏按成员角色与服务开关显示导航分组;全量路由与分组见界面与路由速查。

项目生命周期

第一步建议