TRAE Cloud API 参考

TRAE Cloud API 提供 RESTful 接口,让您轻松将 AI 编程能力集成到任何应用中。所有请求均使用 HTTPS,返回 JSON 格式数据。

🔑 所有 API 请求都需要在 Header 中携带 API Key: Authorization: Bearer sk-xxx

基础地址

/api/v1

代码补全接口

根据上下文生成代码补全建议,支持实时流式响应。

HTTP 请求

POST /completions

请求参数

  • model string - 模型名称,默认 trae-code-3
  • prompt string - 代码上下文前缀
  • suffix string (可选) - 代码上下文后缀
  • language string - 编程语言,如 python、javascript
  • max_tokens int - 最大生成 token 数
  • stream bool - 是否使用流式响应

请求示例 (cURL)

curl /api/v1/completions \ -H "Authorization: Bearer sk-xxxxxxxx" \ -H "Content-Type: application/json" \ -d '{ "model": "trae-code-3", "prompt": "def fibonacci(n):\n ", "language": "python", "max_tokens": 128, "stream": false }'

响应示例

{ "id": "cmpl-abc123", "object": "text_completion", "created": 1718438400, "choices": [ { "text": "\"\"\"Generate Fibonacci sequence.\"\"\"\n if n <= 1:\n return n\n return fibonacci(n-1) + fibonacci(n-2)", "index": 0, "finish_reason": "stop" } ], "usage": { "prompt_tokens": 8, "completion_tokens": 42, "total_tokens": 50 } }

代码审查接口

对提交的代码进行深度审查,识别潜在问题并给出改进建议。

HTTP 请求

POST /code/review

更多接口详细说明请下载 SDK 查看完整示例。

错误码说明

  • 400 Bad Request - 请求参数错误
  • 401 Unauthorized - API Key 无效或缺失
  • 429 Too Many Requests - 超出速率限制
  • 500 Server Error - 服务器内部错误
下载各语言 SDK →