AI记忆库 API 文档
Base URL: https://www.zhidan.chat/v1
🔐 认证
Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxxxxx
📡 API 端点
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /data/:table |
创建数据 |
| GET | /data/:table |
查询列表 |
| GET | /data/:table/:id |
查询单条 |
| PUT | /data/:table/:id |
全量更新 |
| PATCH | /data/:table/:id |
部分更新 |
| DELETE | /data/:table/:id |
删除数据 |
✨ 自动建表
表名无需提前创建,首次写入时自动创建。
💻 JavaScript 示例
初始化
const API_KEY = 'sk-xxxxx';
const BASE_URL = 'https://www.zhidan.chat/v1';
// 封装 API 请求
async function api(method, path, body) {
const res = await fetch(`${BASE_URL}${path}`, {
method,
headers: {
'Authorization': `Bearer ${API_KEY}`,
'Content-Type': 'application/json'
},
body: body ? JSON.stringify(body) : undefined
});
const data = await res.json();
return data.data || data;
}
CRUD 操作
// 创建
const create = (table, data) => api('POST', `/data/${table}`, data);
// 查询(支持 _limit, _offset, _order)
const list = (table, params = '') => api('GET', `/data/${table}?${params}`);
// 更新(PATCH 部分更新,PUT 全量更新)
const update = (table, id, data) => api('PATCH', `/data/${table}/${id}`, data);
// 删除
const remove = (table, id) => api('DELETE', `/data/${table}/${id}`);
// 使用示例
await create('todos', { title: '学习',
completed: false });
await list('todos', '_order=created_at.desc');
await update('todos', 'id', { completed:
true });
await remove('todos', 'id');
🔍 查询参数
| 参数 | 说明 | 示例 |
|---|---|---|
_limit |
返回数量限制 | _limit=50 |
_offset |
偏移量(分页) | _offset=10 |
_order |
排序 | _order=created_at.desc |
字段名 |
按字段过滤 | completed=false |
📋 响应格式
// 列表查询响应
{
"data": [{ "_id": "uuid", "title": "xxx", ... }],
"total": 100
}
// 单条数据响应
{ "_id": "uuid", "title": "xxx", ... }
💡 关键字段
每条数据自动包含 _id 字段(UUID),这是唯一标识,更新/删除时需要使用。
❌ 错误码
| 状态码 | 说明 |
|---|---|
200 |
成功 |
400 |
请求参数错误 |
401 |
API Key 无效 |
404 |
资源不存在 |
500 |
服务器错误 |
⚠️ 注意事项
- 必须使用
https://,http://会被拒绝 - 路径必须包含
/v1前缀 - 数据路径统一使用
/data/,不是/api/或/memory/ - API 返回的
_id是字符串,不是id - 列表查询返回格式是
{data: [], total: n},需要取.data