跳转到主内容

Creatoria Agent API 文档

Creatoria Agent API 文档

#Creatoria Agent API 文档

欢迎使用 Creatoria Agent API。构建、部署和管理 AI 驱动的智能体，集成知识库、自定义工具、Webhook 等能力。

#基础信息

项目说明
Base URLhttps://your-domain.com/v1
协议HTTPS
认证方式API Key（X-API-Key 请求头）
项目标识X-Project-Id 请求头（可选）
响应格式JSON
版本控制URI 版本化（/v1/）

#统一响应格式

所有列表接口返回统一的分页响应：

json{
  "data": [ ... ],
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "totalPages": 5,
    "hasNext": true,
    "hasPrev": false
  }
}

#API 目录

#入门

文档说明
快速开始5 分钟快速接入指南
认证API Key 认证与权限管理

#核心 API

文档基础路径说明
Agents API/v1/agentsAgent 的创建、管理和配置
Chat API/v1/agents/:id/chat与 Agent 对话，支持流式/非流式
Agentic Streaming/v1/agents/:id/chat思维链、规划、工具调用高级流式功能

#数据与知识

文档基础路径说明
知识库 API/v1/knowledge-bases知识库管理与文档检索（RAG）

#工具与扩展

文档基础路径说明
工具配置 API/v1/tools/configurations内置工具配置与用量统计
自定义工具 API/v1/custom-toolsHTTP Webhook 和 JS 沙箱自定义工具

#集成

文档基础路径说明
Webhooks API/v1/webhooksWebhook 事件订阅与投递管理
SDK 快速集成-JavaScript、Python、cURL 示例

#参考

文档说明
错误处理错误码与错误处理最佳实践
速率限制请求频率限制与配额

#快速示例

#cURL

bash# 列出所有 Agent
curl -X GET "https://your-domain.com/v1/agents" \
  -H "X-API-Key: your-api-key" \
  -H "X-Project-Id: your-project-id"

#JavaScript / TypeScript

javascriptconst response = await fetch('https://your-domain.com/v1/agents', {
  headers: {
    'X-API-Key': 'your-api-key',
    'X-Project-Id': 'your-project-id',
  },
});
const { data, meta } = await response.json();
console.log(`Total agents: ${meta.total}`);

#Python

pythonimport requests

resp = requests.get(
    'https://your-domain.com/v1/agents',
    headers={
        'X-API-Key': 'your-api-key',
        'X-Project-Id': 'your-project-id',
    },
)
result = resp.json()
print(f"Total agents: {result['meta']['total']}")

#关键概念

#多租户模型

每个 API Key 绑定到一个 Organization，数据通过 organizationId 严格隔离。可通过 X-Project-Id 请求头在组织内选择项目。

#必要请求头

请求头必填说明
X-API-Key是API Key 认证令牌
X-Project-Id否指定项目上下文（未提供时使用默认项目）
Content-Type写操作application/json

#流式传输

Chat API 支持 Server-Sent Events (SSE) 流式传输。设置 stream: true 即可接收实时增量响应，包含思维链、规划步骤、工具调用等事件。

下一篇: 快速开始 →