CLSSAI 独立产品正在逐项复刻与接入真实能力。查看进度

API reference

一个接口契约,逐项标明真实实现状态。

参考 OpenAI-compatible 形态组织认证、模型目录、Chat Completions、Responses 和用量记录。模型目录已有真实接口,其余 endpoint 以 Workbench 与现场验证为准。

HTTPS传输
BearerAPI Key 形态
JSON + SSE响应目标
Versioned契约目标
临时实现 · Reference UI 不是完整接口保证

GET /v1/models 已有真实目录;推理、Responses、生成记录和部分高级字段可能由上游占位或尚未实现。

查看实现队列

ENDPOINTS

从目录到推理的接口表面。

状态标签是产品事实的一部分。调用前请核对 Workbench,不要因为 Reference 页面存在就假设 endpoint 已具备生产能力。

Live catalog

GET /v1/models

返回 CLSSAI 模型目录。字段完整性、价格版本和 Provider 元数据仍在持续对账。

Partial / fallback

POST /v1/chat/completions

OpenAI 风格的消息推理入口。流式、工具调用和多模态能力取决于模型与当前后端状态。

Planned

POST /v1/responses

面向统一内容、工具和多模态事件的 Responses 形态,尚未形成生产契约。

Planned

GET /v1/generation/:id

计划返回请求级模型、Provider、token、费用与结算状态;真实接口尚未完成。

Planned

GET /v1/models/:id/endpoints

计划展示某模型可用 Provider endpoint 及数据、价格与能力标签。

Review

POST /v1/embeddings

向量接口是否由临时上游或自有路由提供仍待评审,不做当前承诺。

AUTHENTICATION

密钥只通过 Authorization header 发送。

生产 Key 应仅显示一次并以不可逆、带版本的摘要保存。当前账户创建和 Key CRUD 仍在接入。

  • 不要在 URL、日志或客户端源码中放置密钥
  • 用请求 ID 关联支持与日志,不粘贴完整凭据
  • 流式开始后不假设请求可以透明重试
  • 按 endpoint 的真实状态处理兼容差异
cURL · catalog
curl https://api.clssai.com/v1/models \
  -H "Authorization: Bearer $CLSSAI_API_KEY"
cURL · chat compatibility preview
curl https://api.clssai.com/v1/chat/completions \
  -H "Authorization: Bearer $CLSSAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"provider/model","messages":[…]}'

ERROR CONTRACT

错误需要稳定、可定位且不泄露内部信息。

计划统一返回机器可读错误类型、用户可行动信息和请求 ID,并区分认证、限流、Provider 与结算阶段。

Contract evolving

4xx client boundary

认证、参数、模型、策略或额度问题;调用方修正后再重试。

Contract evolving

429 capacity boundary

账户或上游容量限制需要不同提示、可重试信息和 request ID。

Contract evolving

5xx routing boundary

CLSSAI 或 Provider 故障应保留阶段与重试证据,但不暴露内部堆栈或敏感配置。

NEXT STEP

先跑通目录,再发送第一条推理请求。

Quickstart 给出最短接入路径;高级能力只有在 Reference 和 Workbench 同时标记可用后再纳入生产。