API 简介
Base URL
Section titled “Base URL”https://api.topmaterial-tech.com所有 API 路径均以 /api/v2 为前缀,各参考页会给出精确路径。
TopMat API 使用以下认证方式:
- API Key(
Authorization: Bearer tk_...):用于任务接口和数据库接口。
curl https://api.topmaterial-tech.com/api/v2/task/list \ -H "Authorization: Bearer tk_0123456789abcdef0123456789abcdef"有关校验规则、错误处理和 Key 管理的详情,请参阅:
API 分组
Section titled “API 分组”| 分组 | 基础路径 | 用途 |
|---|---|---|
| 任务操作 | /api/v2/task | 通过 API Key 创建、查询、取消和删除任务。 |
| 数据库发现 | /api/v2/database | 通过 API Key 浏览数据库、查询激活状态并按任务类型筛选,为创建任务选择数据库。 |
成功响应没有统一的包装结构,各端点直接返回资源特定的顶层 JSON。例如任务接口返回任务对象本身,更新操作返回 {"message": "..."}。具体结构以各参考页为准。
错误使用标准 HTTP 状态码,通常包含机器可读的 error 字段:
{ "error": "Task not found"}部分错误响应会附带额外字段(如 details、current_pending_tasks、max_pending_tasks);频率限制错误可能改用 message 字段:
{ "message": "Task limit exceeded"}常见状态码:
| 状态码 | 含义 |
|---|---|
400 | 请求错误 — 输入或 JSON 格式无效。 |
401 | 未认证 — API Key 缺失或无效。 |
403 | 禁止访问 — Key 被禁用、过期或权限不足。 |
404 | 资源不存在。 |
409 | 冲突 — 当前状态无法执行该操作。 |
500 | 服务端内部错误。 |