API 概览

Aludus 通过 REST + WebSocket 对外暴露能力。所有请求统一从 /api/v1 前缀进入;浏览器侧由 Nginx 反代,WS 走 /api/jobs。

鉴权

使用 Bearer Token;通过 POST /api/v1/auth/login 拿到 access_token(默认 7 天有效),过期前用 refresh_token 刷新。

POST /api/v1/auth/login
{ "email": "you@example.com", "password": "•••••••" }

→ 200
{
  "access_token": "eyJ...",
  "refresh_token": "eyJ...",
  "token_type": "bearer",
  "expires_in": 604800,
  "user": { "id": "...", "email": "...", "roles": ["member"] }
}

提交翻译

POST /api/v1/projects/{pid}/tasks/,body 包含 units 数组(每条 unit 至少含 source_text)。

实时进度

WebSocket:ws://host/api/jobs/{job_id}/stream?token=...&project_id=...;服务器推送 unit.status / task.final 事件。

事件说明
unit.status单条 unit 状态变更(running → succeeded / failed / needs_human)
task.final整个 task 终态(succeeded / partial / failed)
error鉴权失败或 broker 异常

限流

默认按 org 维度 60 req/min;可在管理后台「预算」页调整;超额返回 429 + Retry-After 头。

错误码

4xx 表示客户端错误(参数、权限、限流),5xx 表示服务端错误;所有错误响应体均为 {detail, code}。

继续了解:核心概念 →