OpenMax
免费试用

开发者

在 OpenMax Workspace 上做应用、调用平台接口,或者把 OpenMax 员工的对话放进你自己的产品。

注册应用、成员用 OpenMax 账号登录授权,你的服务端就能调平台接口;Chat SDK 把对话嵌进你的网页。

// 服务端:用授权拿到的 access_token 调接口(scope:org:me:read)
const r = await fetch("https://openmax.com/api/v1/me", {
  headers: { Authorization: `Bearer ${accessToken}` },
});
const { data } = await r.json(); // 字段包在 data 里
console.log(data.display_name);
import { createChatHost } from "@openmaxai/chat-openmax/react";

export const host = createChatHost({
  baseUrl: "https://openmax.com",   // 不带 /api/v1
  wsUrl: "wss://openmax.com/ws",
  auth: { mode: "token", getToken: async () => fetchShortLivedToken() },
});

能力地图

Apps API →

按授权的 scope 调平台接口:成员、组织、agent 等。端点参考随平台 OpenAPI 发布,现在先看「调用平台能力」里的常用接口、能力清单和状态。

Chat SDK →

会话列表、消息区、输入框等组件和事件,把 OpenMax 员工的对话嵌进你的网页。

OAuth 与 Scopes →

成员用 OpenMax 账号登录你的应用;能申请哪些 scope,见 Scopes 总表;授权参数见 OAuth 参考。

开发路径

已经有自己的系统和账号体系?先读已有系统接入,不用重做。Chat SDK 的版本变化见更新日志。

注意:嵌在 Workspace 里打开的应用,不能在页面里跳转去登录,要改用 requestAuthCode。见登录「嵌入时登录」。

什么时候做成应用,而不是只写一个 skill

只写 skill(提示词 + 脚本),逻辑和数据都在对方机器上,拷走就能复用。下面任一条成立,就把核心做成应用,skill 只当薄客户端:

  • 核心逻辑和数据要留在你的服务端;
  • 要按人管权限、要能审计「谁、从哪、做了什么」;
  • 要有一个嵌进 OpenMax 的页面给人看、给人点。

做法是「轻客户端、重服务端」:OpenMax 的 token 只在你的服务端,浏览器只拿你自己站点的会话;agent 那边的 skill 只调你的 CLI 或接口(见 Agent 调用应用)。平台本期不托管应用后端,部署在哪都可以(见应用开发不做的事)。

资源

文档 内容
端到端示例 Node.js 和 Go 的完整登录代码
调用平台能力「能力清单」 平台现在能做什么、哪些还在做
页面 UX 规范 放进 Workspace 的页面要守的界面规矩
不做的事 平台目前不提供的能力