Cleer Open API

把材料表征分析能力
装进你的一行代码

SEM 图像分析、XRD 物相分析、Raman 光谱解析——Cleer 分析平台的算法能力, 现在以标准 REST API 对外输出。文件直传、异步任务、标准结果信封, 全流程自动化,无需人工操作平台页面。

12REST 端点
2h令牌有效期
24h产物下载时效
100%原字节保真
 quickstart.sh
# ① 用 AppID + AppSecret 换取短期访问令牌
curl -X POST https://api.cleerscience.com/v1/token \
  -d "grant_type=client_credentials" \
  -d "app_id=app_xxx" -d "app_secret=…"
→ {"access_token": "at-…", "expires_in": 7200}

# ② 上传待分析文件(大文件分片直传对象存储)
curl -X POST …/v1/uploads \() \
  -H "Authorization: Bearer $TOKEN"
→ {"asset_ref": {"asset_id": "ast_…", "version": 1}}

# ③ 发起分析,轮询至终态
curl -X POST …/v1/analyses \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: 3c2f8a71" \
  -d '{"algorithm_id": "xrd-phase-analysis",
       "inputs": [{"asset_id": "ast_…", "version": 1}]}'
→ 202 {"analysis_id": "run_…", "status": "queued"}
Capabilities

分析能力

按合作范围开通。同一资产可复用于多次分析,不必重复上传。

🧲

XRD 物相检索 正式

粉末衍射谱物相鉴定,420k COD 全库检索;支持 csv/xrdml/xls 等 10 种格式。

📈

Raman 光谱识别 正式

两列光谱物相识别,RRUFF 物相级数据库(窗内 1959 物相)。

🧬

NMR 波谱解析 对话式

JCAMP-DX 解析与峰表;提供分子式可经问答交互完成结构求解。

⚗️

MS 质谱鉴定 对话式

mzML / MassBank 等格式,MassBank 2025.10 全库鉴定;前体 m/z 可经对话补充。

Preview

预览级(演示算法,正式版陆续接入):XPS 结合能谱 · IR 红外光谱 · TEM 电子衍射 · SAXS 小角散射

Quick Start

五步接入

签约后发放 AppID + AppSecret,其余全部自助完成。正式接入时提供沙箱联调环境与完整 OpenAPI 规范。

01

获取凭证

签约后发放 app_idapp_secret,Secret 只展示一次。

02

换取令牌

POST /v1/token 换 2 小时短期令牌,缓存复用、过期前刷新。

03

上传文件

申报 SHA-256 后分片直传对象存储,文件字节不经 API 服务器中转。

04

发起分析

POST /v1/analyses 引用资产,幂等键保证网络重试安全。

05

获取结果

轮询至终态,读取标准结果信封与限时产物下载地址。

Two Modes

两种分析交互模式

standard

传统式

提交 → 等待 → 取结果,全程无人工介入。

  • 适合批量与流水线自动化场景
  • 秒级到分钟级完成,任务生命周期由平台管理
  • 无需维持长连接,轮询退避即可
conversational

对话式

算法执行中如需确认实验条件,以结构化表单发起提问。

  • 贵司系统程序直接作答,无需接人工客服
  • 已知样品背景可预填答案,跳过全部提问
  • 结果附带问答溯源,说明依据哪些确认条件产生
Result Envelope

结果格式:信封固定,内容随算法

外层结构所有模态完全一致——接一次,就接住了现在和未来的全部算法;算法指标按版本化 Schema 单独提供。

  • 01
    输入锚点回传文件名与 SHA-256,可对账"平台分析的确实是这份字节"
  • 02
    产物下载报告、掩码图等附摘要与限时下载地址,过期可重新获取
  • 03
    问答溯源对话式分析附带问答记录,满足审计需要
  • 04
    用量明细算力时长供贵司核算,另有用量对账接口
 GET /v1/analyses/{id}/result
{
  "analysis_id": "run_5k9w2m7p",
  "algorithm": {"id": "sem-segmentation", "version": "1.4.0"},
  "status": "succeeded",
  "inputs": [{
    "asset_id": "ast_c4m8x2", "version": 1,
    "filename": "sample-01.tif",
    "sha256": "9f2c…(与上传申报一致)"
  }],
  "result": {
    "schema_version": "1.4",
    "metrics": { "particle_count": 810, "d50_um": 2.41 }
  },
  "artifacts": [{
    "type": "report", "filename": "report.pdf",
    "sha256": "e3b0…", "download_url": "https://…(限时)"
  }],
  "answers": [], "usage": { "compute_seconds": 155 }
}
Security

数据安全设计

direct-upload

数据直传

上传走短期预签名地址直传对象存储,文件字节不经 API 服务器中转。

sha-256

完整性锚定

上传申报摘要、平台启动前二次校验、结果回传同一摘要——全程可对账。

short-lived

短期授权

令牌、上传下载地址均为限时有效;密钥疑似泄露可即时重置,重置后旧令牌全部失效。

scoped

用途限定

客户数据仅在分析用途内使用,按约定保留策略管理,详见接入协议。

Get Started

准备接入 Cleer 开放 API?

阅读接入文档,或联系我们开通沙箱联调环境

申请接入