API 文档

Orchidea 生态各服务的 API 参考文档入口，覆盖 GraphQL、B2MML、REST 和 WebSocket 接口。

从零接入

1. 选择服务

确认需要调用的服务，了解其 API 类型（GraphQL / REST / B2MML）和认证方式。

2. 获取凭证

通过 OAuth2 / API Key 获取访问凭证。详见各服务的部署文档中的认证章节。

3. 开始调用

使用下方各服务的文档链接查看完整端点列表、请求示例和 SDK 用法。

Orchidea Platform

GraphQL

基于 ISA-95 标准的 GraphQL API，覆盖设备层级、物料管理、工单、KPI 等全部 MOM 业务对象。提供内省查询和 playground。

API 端点

POST /api/v2/graphql GraphQL 查询入口
GET /api/v2/graphql?schema Schema 内省
WebSocket /api/v2/graphql 订阅实时事件
查看 Orchidea Platform 文档 → GraphQL Schema 源码 →

Orchidea Gateway

B2MML / REST

B2MML 事务接口网关，实现 ISA-95 标准消息格式转换（XML/JSON），支持 9 类 B2MML 事务操作。

API 端点

POST /b2mml/v1/{transaction} B2MML 事务调用
GET /b2mml/v1/health 健康检查
POST /api/v1/rpc 内部 RPC 代理
查看 Orchidea Gateway 文档 → B2MML 网关源码 →

Orchidea Archive

REST

制造知识库 REST API，提供标准文档 CRUD、全文检索（pgvector）、知识问答和 MCP Server 接口。

API 端点

GET /api/v1/documents 文档列表/搜索
POST /api/v1/qa 知识问答
GET /api/v1/categories 知识分类
POST /api/v1/mcp MCP JSON-RPC 入口
查看 Orchidea Archive 文档 →

Orchidea Director

REST + WebSocket

Agent 编排平台 API，管理任务分发、Agent 注册、预算治理和审批工作流。WebSocket 提供实时状态推送。

API 端点

POST /api/v1/tasks 创建/分发任务
GET /api/v1/agents Agent 列表与状态
POST /api/v1/approvals 提交审批请求
WebSocket /ws 实时任务状态推送
查看 Orchidea Director 文档 →

Tian-Vision

REST

多模态文档理解 API，支持 OCR、版面分析、结构提取和知识抽取，集成 6 大推理引擎。

API 端点

POST /api/v1/ocr 光学字符识别
POST /api/v1/layout 版面分析
POST /api/v1/extract 结构化信息抽取
GET /api/v1/engines 可用推理引擎列表
查看 Tian-Vision 文档 →

Orchidea Telemetry

REST

可观测性遥测数据接收 API，支持事件采集、指标上报和分布式追踪数据写入。基于 orchidea-watch 平台。

API 端点

POST /api/v1/ingest/events 事件批量采集
POST /api/v1/ingest/metrics 指标上报
POST /api/v1/ingest/traces 追踪数据写入
GET /api/v1/health 服务健康检查
查看 Orchidea Telemetry 文档 → orchidea-watch 源码 →

协议与规范

GraphQL Schema

平台层所有业务对象定义于 isa95-schema.graphql，遵循 ISA-95 命名规范。

B2MML 事务模型

网关层实现 IEC 62264 Part 5 定义的 9 类 B2MML 事务：GET / POST / PUT / DELETE per resource。

MCP 协议

Archive 提供 MCP (Model Context Protocol) JSON-RPC 接口，通过 stdio 或 HTTP 接入 AI 代理。

ACP 协议

Director 采用 ACP (Agent Client Protocol) 进行 Agent 注册与任务分发，替代传统 REST 注册机制。