API 参考
Get3W REST API 参考文档。
Base URL
https://api.get3w.com/v1鉴权
所有接口都需要用 Bearer token 传入你的 API Key:
Authorization: Bearer YOUR_API_KEY详见 API 鉴权。
接口列表
生成
| 方法 | 接口 | 说明 |
|---|---|---|
| POST | /v1/{provider_id}/{model_id}/{run_type} | 提交任务 |
| GET | /v1/requests/{request_id} | 获取结果 |
提交接口的路径就是模型 slug。支持的查询参数:
| 参数 | 说明 |
|---|---|
sync | 等待任务完成,并在同一个响应中返回结果 |
webhook | 任务完成后接收结果的回调地址 |
prefix | 输出文件的自定义存储前缀 |
Chat
对话模型提供 OpenAI 兼容接口。把任意 OpenAI 客户端指向 https://api.get3w.com/v1,并使用你的 Get3W Key 即可。
| 方法 | 接口 | 说明 |
|---|---|---|
| POST | /v1/chat/completions | 对话补全,支持 stream |
| GET | /v1/models | 列出可用的对话模型 |
账户
| 方法 | 接口 | 说明 |
|---|---|---|
| GET | /v1/balance | 查询余额 |
错误格式
/v1/ 接口的错误会返回 HTTP 状态码,以及一个 JSON 响应体:
json
{
"code": 401,
"error": "Invalid or revoked API key"
}如果任务已被接受但在执行过程中失败,则返回 HTTP 200,其中 status: "failed",并带有任务级别的 code。两个层级的错误都可以在错误码中查到。