GitHub文档Cocode Nut 模型服务
正在确认登录状态
文档目录English

开始

从第一个任务开始使用 Cocode

快速开始

快速开始

使用指南

GUI 桌面工作台TUI 终端界面

核心概念

核心概念权限与确认

模型与团队

Cocode Nut 模型服务团队与组织

开发者

API 概览

参考与帮助

CLI 与快捷键参考常见问题与故障排查
Cocode 文档 / API 概览

API 概览

Cocode 提供账号、组织、模型、推理、Connector 和下载相关接口。推理接口提供 OpenAI 兼容的入口,便于接入已有工具。

Base URL 与认证

生产 API Base URL 是 https://cocode.agency/v1。在账号中心创建个人 API Key 后,通过 Authorization: Bearer $COCODE_API_KEY 使用。Key 创建时只显示一次,默认 scope 为 models:read 和 inference:write。

模型与推理

curl https://cocode.agency/v1/models \
  -H "Authorization: Bearer $COCODE_API_KEY"

curl https://cocode.agency/v1/chat/completions \
  -H "Authorization: Bearer $COCODE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"model":"<model-id>","messages":[{"role":"user","content":"Hello"}]}'

主要入口是 GET /models、POST /chat/completions 和 POST /responses;两种推理接口都支持流式响应。需要幂等时传 Idempotency-Key。

/responses 当前提供非持久化 create 语义,不要假设完整支持 OpenAI Responses 的存储、后台任务、conversation 或 previous_response_id 生命周期。

账号、用量与扩展接口

用量可通过 /me/model-usage、/me/model-usage/events 查询,支持时间窗口、model、project 和 cursor 分页;不会返回 prompt 或 provider key。账号、组织、Connector 和下载接口见 OpenAPI contract,Connector OAuth 依赖相应账号授权。

API 错误遵循 OpenAI-compatible error / problem contract。不要提交 API Key;服务端优先使用环境变量或密钥管理器。

建议阅读路径

  1. 创建并保存个人 API Key。
  2. 查询模型目录。
  3. 发起一次非流式请求。
  4. 再启用流式响应。
  5. 根据错误码和限流响应实现重试。
文档内容持续更新中。support@cocode.agency