Unif API Docs

连接你的智能体

将 UnifAPI 连接到 Claude、ChatGPT、Cursor、Codex、Claude Code、OpenClaw、Hermes 以及其他 MCP 客户端。粘贴一条提示词或添加一个 Web 连接器——只读、OAuth、无需 API key。本文还涵盖可选的 skills 包以及高级手动 MCP 服务器和 API key bearer 配置。

将公开数据 MCP 服务器连接到你的智能体——只读、OAuth、无需 API key。开源的智能体和 Skills 托管在 github.com/unifapi-agent/agents

对于大多数客户端,你无需触碰配置文件或粘贴令牌。添加服务器(一条粘贴的提示词或一个 Web 连接器),然后运行一个智能体或 Skill,并在智能体首次需要实时数据时用 OAuth 登录。

OAuth 是推荐路径。UnifAPI 是只读且限定公开数据范围的:OAuth 授权的是你的 UnifAPI 工作区和 credits,而非用户的私有来源账户。连接无需任何 API key。

连接你的智能体

选择适合你客户端的方式。每一种方式都会为实时数据接入托管的 MCP 服务器(https://mcp.unifapi.com);并通过 npx skills add unifapi-agent/agents 添加智能体 Skills。

粘贴一条提示词

Claude Code、Codex、Cursor、OpenClaw、Goose、Hermes——任何自行管理其 MCP 服务器的智能体。把下面这段丢进去,它就会添加服务器并运行 OAuth 登录:

Install the UnifAPI MCP server for me, then confirm it connected. It's a remote
(streamable HTTP) MCP server at https://mcp.unifapi.com. UnifAPI uses OAuth — open
the browser sign-in when prompted. It's read-only public data, no API key to paste.

Web 连接器(Claude、ChatGPT、Perplexity、Grok)

添加一个指向 https://mcp.unifapi.com 的自定义连接器并通过 OAuth 授权。ChatGPT 需要开发者模式(Plus、Pro、Team、Enterprise):

Settings -> Connectors -> Advanced -> enable Developer Mode
Connectors -> Create
MCP server URL: https://mcp.unifapi.com
Authentication: OAuth

Codex

Codex 分别接入 MCP 和 Skills。在 ~/.codex/config.toml 中添加 MCP 服务器:

[mcp_servers.unifapi]
url = "https://mcp.unifapi.com"

然后登录并添加 Skills:

codex mcp login unifapi
npx skills add unifapi-agent/agents

兼容 Claude 的插件宿主

Claude Code、Claude Desktop 和 OpenClaw 可以一步同时安装 Skills MCP 服务器:

/plugin marketplace add unifapi-agent/agents
/plugin install unifapi@unifapi

之后运行一个智能体或 Skill,并在提示时完成 OAuth 登录。

任何其他 MCP 客户端

先添加 Skills,然后将客户端指向托管的 MCP 服务器以获取实时数据:

npx skills add unifapi-agent/agents
MCP server URL: https://mcp.unifapi.com

运行它

安装完成后,开始一段新的对话或会话,并请求一个任务结果。智能体 Skills 会按需通过 MCP 发现并调用公开数据操作:

Analyze these Twitter/X KOLs for an AI developer-tool campaign: @vercel, @shadcn, @rauchg.
Use UnifAPI public data and return price ranges, evidence, confidence, and follow-up questions.

只有当智能体首次需要调用 UnifAPI 工具或消耗工作区 credits 时,OAuth 才会触发,因此你可以在登录之前浏览并开始一个任务。工作流模型请参见 Skills

你的智能体能做什么

连接后,智能体即可访问 UnifAPI 背后的实时公开数据操作。它适用于以下这类工作:

  • Twitter/X KOL 分析和达人候选名单
  • 在 TikTok、YouTube、Instagram、Reddit 以及其他支持平台上进行创作者发现
  • 基于公开帖子、个人资料、评论和趋势的竞品监控
  • 基于公开社交信号的市场研究
  • 基于公开的类 LinkedIn 数据进行线索和公司信息富化

智能体通常应当返回一份简报、表格、候选名单、报价区间或后续计划——而非原始 API 数据堆砌。

通过 MCP 暴露的工具

UnifAPI 暴露三个 MCP 工具。它不会为每个 API 端点单独注册一个 MCP 工具。

工具用途
list_operations按平台/关键词搜索实时公开数据操作。
get_operation检查参数、数据结构和调用示例。
call_api调用一个具体操作并返回数据及计费信息。

典型的智能体流程:

发现操作。 当智能体不知道确切的 API 路径时,使用 list_operations
调用前先检查。 使用 get_operation 来阅读参数、请求体结构和示例。

调用公开数据。 在占位符填好之后,使用 call_api 配合具体路径,例如 /x/tweets/search/recent/tiktok/videos/{id}

高级:MCP 服务器 URL 与 API key bearer

上面的方式涵盖了大多数客户端。如果你手动接入 MCP、基于 HTTP MCP 传输进行构建,或为需要显式配置的客户端将连接产品化,请使用本节。

UnifAPI 通过一个托管的 MCP 服务器暴露其公开数据层:

https://mcp.unifapi.com

手动 MCP 配置

如果你的客户端接受原始连接器 URL 而非插件,请直接添加托管服务器。

Claude / Claude Desktop 自定义连接器:

Customize -> Connectors -> + -> Add custom connector
Name: UnifAPI
URL: https://mcp.unifapi.com
Connect -> complete OAuth

对于 Team 和 Enterprise 套餐,需先由一名 Owner 从 Organization settings -> Connectors 添加该连接器;之后成员从 Customize -> Connectors 连接它。对于较旧的仅本地 Claude Desktop 配置,mcp-remote 可以通过 claude_desktop_config.json 将托管服务器桥接进来:

{
  "mcpServers": {
    "unifapi": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://mcp.unifapi.com"]
    }
  }
}

Claude Code CLI:

claude mcp add \
  --transport http \
  unifapi \
  https://mcp.unifapi.com

Codex CLI:

codex mcp add unifapi \
  --url https://mcp.unifapi.com

OpenClaw 远程 Streamable HTTP 服务器:

openclaw mcp add unifapi \
  --url https://mcp.unifapi.com \
  --transport streamable-http \
  --auth oauth

openclaw mcp login unifapi
openclaw mcp doctor unifapi --probe

Hermes ~/.hermes/config.yaml

mcp_servers:
  unifapi:
    url: "https://mcp.unifapi.com"
    auth: oauth
hermes mcp login unifapi

Cursor .cursor/mcp.json

{
  "mcpServers": {
    "unifapi": {
      "url": "https://mcp.unifapi.com"
    }
  }
}

VS Code .vscode/mcp.json

{
  "servers": {
    "unifapi": {
      "type": "http",
      "url": "https://mcp.unifapi.com"
    }
  }
}

其他 MCP 客户端——使用 Streamable HTTP 配合规范的服务器 URL:

{
  "mcpServers": {
    "unifapi": {
      "url": "https://mcp.unifapi.com"
    }
  }
}

OAuth 详情

UnifAPI 的 MCP 服务器是一个 OAuth 受保护资源。

字段
MCP server URLhttps://mcp.unifapi.com
Protected resource metadatahttps://mcp.unifapi.com/.well-known/oauth-protected-resource
Authorization serverhttps://api.unifapi.com/api/auth
Required MCP scopeunifapi:mcp
TransportStreamable HTTP

受保护资源元数据会告诉兼容的客户端在哪里授权以及需要哪个作用域。OAuth 令牌包含一个工作区声明,因此工具调用消耗的工作区 credits 与直接 HTTP API 调用相同。OAuth 授权的是 UnifAPI;它不授予对用户私有来源账户的访问权限。

除非你的 MCP 客户端明确支持,否则不要向客户端配置中添加自定义作用域字段。兼容的客户端应当发现受保护资源元数据并请求所需的作用域。

API key bearer 后备方案

仅当客户端无法完成 OAuth,或明确要求 bearer 令牌/请求头时才使用此方式。上面的 OAuth 方式不需要 API key。

  1. 登录 UnifAPI 仪表盘。
  2. 创建一个 API key。
  3. 配置你的 MCP 客户端将其作为 authorization 请求头发送:
Authorization: Bearer YOUR_UNIFAPI_KEY

Cursor 风格的 JSON 示例:

{
  "mcpServers": {
    "unifapi": {
      "url": "https://mcp.unifapi.com",
      "headers": {
        "Authorization": "Bearer YOUR_UNIFAPI_KEY"
      }
    }
  }
}

对于无法设置 Authorization 的客户端,UnifAPI 也接受 X-API-KeyX-UnifAPI-Key 请求头,但首选 Authorization: Bearer ...

计费与 credits

MCP 调用使用与 HTTP 调用相同的计费模型。

  • 连接 MCP 服务器(以及添加 Skills)是免费的。
  • call_api 调用一个公开数据操作时会消耗工作区 credits。
  • 当操作响应包含计费信息时,计费元数据会在工具结果中返回。
  • 如果工作区已没有剩余 credits,调用会以 insufficient_credits 失败。

请求限制请参见 速率限制,公开错误词汇表请参见 错误

故障排查

客户端索要 API key

使用上面的 API key bearer 后备方案。这通常意味着该客户端尚不支持 OAuth 受保护资源发现。

OAuth 成功但工具调用失败

检查 OAuth 流程是否请求了 MCP 资源和作用域:

  • 资源/受众:https://mcp.unifapi.com/
  • 作用域:unifapi:mcp

如果客户端在令牌交换期间未发送资源/受众,它可能会收到一个无法被 MCP 受保护资源验证的令牌。

401 unauthorized

MCP 请求缺少有效令牌,OAuth 令牌对此资源无效,或 API key 后备令牌已被吊销或输入有误。

insufficient_credits

连接到该 OAuth 令牌或 API key 的工作区没有足够的 credits。在仪表盘中充值 credits 并重试。

工具列表显示为陈旧

重启或重新加载 MCP 客户端。某些客户端会缓存服务器会话和工具列表。

相关资源

本页内容