跳到主要内容

API 参考概述

欢迎来到 Agentrix API 参考文档。本节提供了关于集成 Agentrix API 的全面信息。

简介​

Agentrix 提供了一个 RESTful API，使开发者能够以编程方式与平台交互。您可以创建任务、管理分享链接，并将 Agentrix 功能集成到您的应用程序中。

基础 URL​

https://api.xmz.ai/v1/

认证​

所有 API 请求都需要使用 API 密钥进行认证。在请求头中包含您的 API 密钥：

Authorization: Bearer YOUR_API_KEY

获取您的 API 密钥​

  1. 登录 Agentrix 平台
  2. 导航至设置 > API 密钥
  3. 生成新的 API 密钥
  4. 安全存储它 - 它只会显示一次

请求格式​

所有 POST 和 PUT 请求应使用 JSON 格式，并带有适当的 Content-Type 头部：

Content-Type: application/json

响应格式​

所有 API 响应都以 JSON 格式返回。成功的响应直接返回数据，没有包装结构。

成功响应​

响应直接返回其特定数据：

{
  //...response fields
}

错误响应​

错误响应包括 HTTP 状态码（400、401、403、404、500）以及错误详情：

{
  "code": "ERROR_CODE",
  "error": "error_type",
  "message": "Human-readable error message"
}

HTTP 状态码​

状态码描述
200成功 - 请求已成功完成
201已创建 - 资源已成功创建
400错误请求 - 无效的请求参数
401未授权 - API 密钥无效或缺失
403禁止 - 权限不足
404未找到 - 资源不存在
429请求过多 - 超出速率限制
500内部服务器错误 - 服务器错误

可用端点​

聊天​

  • 创建聊天 - 创建与代理的聊天会话（创建任务前必须执行）

任务​

分享链接​

支持​

关于 API 支持和问题：

变更日志​

跟踪 API 变更和更新：

  • v1.0.0 (2026-01-21): 初始 API 发布