Skip to content

API 集成

OpenEdge 生产 API:

text
https://api.open4x.com

应用服务统一挂载在:

text
/v1/apps

鉴权

API Key

服务端集成建议使用 API Key:

http
X-API-Key: sk_xxx

API Key 只展示一次,平台保存哈希。

JWT

控制台登录态使用 JWT:

http
Authorization: Bearer <token>

不要把 JWT 写入长期运行的生产服务。

推荐 Scope

Scope能力
bot:send发送 bot 消息和回复。
file:read读取或下载文件。
file:write上传或修改文件。
push:send发送 Webhook Push 消息。
tron:lease创建和查询 TRON 能量租赁订单。
ai:invoke调用 AI chat、streaming 和 embeddings。
socialops:write写入 SocialOps webhook 事件。
socialops:read读取 SocialOps inbox 线程和消息。

标准错误

部分现有接口仍返回简单错误结构:

json
{
  "error": "Insufficient balance"
}

新接口建议逐步统一为结构化错误:

json
{
  "error": {
    "code": "insufficient_balance",
    "message": "Insufficient balance",
    "request_id": "req_xxx"
  }
}

推荐错误码:

HTTPCode含义
400invalid_request请求体或参数错误。
401unauthorized缺少或无效凭据。
402insufficient_balance余额不足。
403forbidden缺少权限。
404not_found资源不存在。
409cost_limit_exceeded超出 max_cost 或报价限制。
422verification_failed业务校验失败。
429rate_limit_exceeded触发限流或预算限制。
502upstream_failed上游服务失败。

服务 Endpoint

服务Endpoint
AI ChatPOST /v1/apps/ai/:alias/chat
AI StreamingPOST /v1/apps/ai/:alias/chat/stream
AI EmbeddingsPOST /v1/apps/ai/:alias/embeddings
Webhook PushPOST /v1/apps/webhook-push/:alias/send
TRON 报价POST /v1/apps/tron/quote
TRON 租赁POST /v1/apps/tron/lease
TRON 订单列表GET /v1/apps/tron/leases
TRON 订单详情GET /v1/apps/tron/leases/:id
SocialOps WebhookPOST /v1/apps/socialops/:alias/webhook/:provider
SocialOps InboxGET /v1/apps/socialops/:alias/inbox
SocialOps 线程消息GET /v1/apps/socialops/:alias/threads/:thread_id/messages
SocialOps 回复队列POST /v1/apps/socialops/:alias/threads/:thread_id/replies
文件服务/v1/apps/file/*
机器人服务/v1/apps/bot/*

健康检查

bash
curl https://api.open4x.com/health

预期响应:

json
{
  "status": "ok",
  "db": "ok",
  "ts": "2026-06-19T14:48:46.146Z"
}