TopMat 文档

TopMat API

TopMat 提供了一套用于创建和管理材料计算任务的编程接口。通过 API Key 认证，你可以将任务提交、状态跟踪和结果获取集成到自己的应用与流水线中。

几分钟内快速上手

1. 在 Web 控制台 创建 API Key
2. 认证你的请求
3. 发现并选择数据库
4. 创建第一个任务

核心概念

• API Key — 绑定到你的用户账号。每个 Key 以 tk_ 开头，每次请求都会进行校验。
• 任务（Task） — 一次计算作业，例如热力学计算。通过 API 创建、跟踪和停止任务。
• 数据库（TOPDB） — 任务依赖的热力学数据库，通过 task_config.tdb_code 选择，可通过 API 发现和筛选。

API 参考

API 参考

浏览完整的接口文档：

• 认证 — 如何发送和校验 API Key。
• 数据库接口 — 发现数据库、查询激活状态并按任务类型筛选。
• 任务接口 — 创建、查询、停止和获取任务结果。

Base URL

Base URL

https://api.topmaterial-tech.com

任务业务接口位于 /api/v2/task 下，数据库发现接口位于 /api/v2/database 下。