免费开始 →

SDK 与 CLI

API 参考

应用、智能体或身份提供商调用的每个路由:其认证方式、密钥所需的作用域、接受的字段以及给出的应答。

OpenAPI 文件

同一份参考的 OpenAPI 3.1 文件,供代码生成器和契约测试使用。它由 Azoth 自身测试在两个方向上与路由对照的契约生成:缺少某个路由,或列出不存在的路由,都会使这些测试失败。

openapi.yaml

路由摘要和字段名称均以英文撰写,本页与文件中都是如此。

认证

Authorization
Bearer <key>:在设置 › 访问权限中创建的工作区 API 密钥——az_live_…,免费套餐为 az_test_…。带作用域的密钥只能访问其作用域覆盖的路由。
X-Azoth-API-Key
<key>:放在独立请求头中的同一密钥。每个接受密钥的路由都同时接受这两种方式。

控制台自身的读取——/api/v1/me 和 GreenOps 读取——使用已登录的会话,绝不接受密钥。SCIM 路由使用工作区的 SCIM 令牌(SCIM 用户配置)。

应答与错误

错误应答包含 error(一句说明)、一个稳定的 code 和一个 doc_url,后者指向该代码在错误代码中的条目;400 还会通过 field 指明出错的字段。速率限制以 429 应答,正文中有 retryAfterMs,请求头中有 Retry-After。若部署未运行某路由所需的模块,该路由会如实说明。非流式的网关调用(/api/v1/chat/completions、/api/v1/chat)可以带上 Idempotency-Key 请求头安全地重试:一小时内,对已得到应答的调用进行重试,会收到首次的应答——绝不会再次调用模型、再次封存或再次产生费用——前提是工作区的数据策略允许 Azoth 保留该应答;否则重试会得到相应说明(idempotency_replay_unavailable),并附上首次调用的追踪。

路由

API 的每个部分各占一页,其中完整列出每个路由:认证方式、密钥所需的作用域、参数和请求体字段、应答及其代码。下方列出每个部分及其路由,每个路由一行,链接到其完整条目。文件中给出每个字段的类型和限制,以及每个应答的正文。

网关调用

通过受治理的网关调用模型——以及围绕一次调用的操作:是否需要模型、首次调用可用的模型、恢复被暂挂的调用、申请例外、依据核查,以及您自有保险库的回执。

此部分的全部路由(完整内容)

/api/v1/chat

/api/v1/infer

/api/v1/models

/api/v1/exceptions

/api/v1/grounding

/api/v1/vault

遥测与优化

上报在网关之外发起的调用、为请求选择模型、查找和存储缓存的回答、检查智能体是否陷入循环、压缩长内容,以及查询提供商市场。

此部分的全部路由(完整内容)

/api/ingest

/api/arbiter

/api/cache

/api/loops

/api/v1/compress

/api/v1/reconstruct

/api/v1/marketplace

证明

读取已封存的决策,导出审计档案或单项决策的档案,获取用于验证回执的公钥,并读取 Azoth Guard 的证据和工作区的事件。

此部分的全部路由(完整内容)

/api/v1/journal

/api/v1/decisions

/api/proof

/api/v1/guard

/api/v1/incidents

系统与策略

声明并读取您的系统(用例),以及超出其获批范围运行的调用;读取监管策略包和 SDK 所应用的数据策略。

此部分的全部路由(完整内容)

/api/v1/usecases

/api/v1/policy

/api/v1/governance

测试与模型变更

管理并运行回归测试套件,或在套件上比较多个模型;在模型变更时读取等待您的系统运行的参考集任务,并提交其结果。

此部分的全部路由(完整内容)

/api/v1/regression

/api/v1/reference-sets

智能体与 MCP

读取每个智能体的支出与节省,通过受治理的 MCP 网关调用工具,并运行助手的只读工具。

此部分的全部路由(完整内容)

/api/v1/agents

/api/v1/mcp

/api/v1/insights

用量、支出与足迹

读取用量追踪记录、支出与节省报告、预算及其使用情况,以及估算的能耗与碳足迹。

此部分的全部路由(完整内容)

/api/v1/usage

/api/v1/report

/api/v1/budgets

/api/v1/greenops

服务与账户

检查服务是否在线,查看哪些模块已可用于生产,导出工作区的数据,以及读取或删除您自己的账户。

此部分的全部路由(完整内容)

/api/health

/api/v1/system

/api/v1/export

/api/v1/me

  • GET /api/v1/me — Your personal data (GDPR art. 15) — signed in, never an API key
  • DELETE /api/v1/me — Erase your account (GDPR art. 17) — signed in, never an API key

SCIM 用户配置

使用工作区的 SCIM 令牌,从您的身份提供商创建、更新和移除用户与用户组。

此部分的全部路由(完整内容)

/api/scim/v2