Unif API Docs

Conecte seu agente

Conecte o UnifAPI ao Claude, ChatGPT, Cursor, Codex, Claude Code, OpenClaw, Hermes e outros clientes MCP. Cole um prompt ou adicione um conector web — somente leitura, OAuth, sem API key. O bundle opcional de skills e a configuração manual avançada de servidor MCP e bearer de API key também são cobertos.

Conecte o servidor MCP de dados públicos ao seu agente — somente leitura, OAuth, sem API key. Os agentes e skills open-source ficam em github.com/unifapi-agent/agents.

Para a maioria dos clientes você não precisa mexer em um arquivo de config ou colar um token. Adicione o servidor (um prompt colado ou um conector web), depois execute um agente ou skill e faça login com OAuth quando o agente precisar de dados ao vivo pela primeira vez.

O OAuth é o caminho recomendado. O UnifAPI é somente leitura e escopado a dados públicos: o OAuth autoriza seu workspace e seus créditos UnifAPI, não as contas de origem privadas de um usuário. Nenhuma API key é necessária para conectar.

Conecte seu agente

Escolha o caminho para o seu cliente. Cada um configura o servidor MCP hospedado (https://mcp.unifapi.com) para dados ao vivo; adicione as agent skills com npx skills add unifapi-agent/agents.

Cole um prompt

Claude Code, Codex, Cursor, OpenClaw, Goose, Hermes — qualquer agente que gerencia seus próprios servidores MCP. Cole isto e ele adiciona o servidor e executa o login 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.

Conector web (Claude, ChatGPT, Perplexity, Grok)

Adicione um conector personalizado apontado para https://mcp.unifapi.com e autorize via OAuth. O ChatGPT precisa do Modo Desenvolvedor (Plus, Pro, Team, Enterprise):

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

Codex

O Codex configura MCP e skills separadamente. Adicione o servidor MCP em ~/.codex/config.toml:

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

Depois faça login e adicione as skills:

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

Hosts de plugin compatíveis com Claude

O Claude Code, o Claude Desktop e o OpenClaw podem instalar as skills e o servidor MCP juntos de uma vez:

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

Execute um agente ou skill depois e complete o login OAuth quando solicitado.

Qualquer outro cliente MCP

Adicione as skills e então aponte o cliente para o servidor MCP hospedado para dados ao vivo:

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

Execute

Após instalar, inicie um novo chat ou thread e peça o resultado de uma tarefa. As agent skills descobrem e chamam operações de dados públicos via MCP conforme necessário:

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.

O OAuth abre apenas quando o agente precisa chamar as ferramentas do UnifAPI ou gastar créditos do workspace pela primeira vez, então você pode navegar e iniciar uma tarefa antes de fazer login. Veja Skills para o modelo de fluxo de trabalho.

O que seu agente pode fazer

Conectar dá a um agente acesso às operações de dados públicos ao vivo por trás do UnifAPI. É útil para trabalhos como:

  • análise de KOL no Twitter/X e shortlists de influenciadores
  • descoberta de creators no TikTok, YouTube, Instagram, Reddit e outras plataformas suportadas
  • monitoramento de concorrentes a partir de posts, perfis, comentários e tendências públicos
  • pesquisa de mercado a partir de sinais sociais públicos
  • enriquecimento de leads e empresas a partir de dados públicos no estilo LinkedIn

O agente normalmente deve retornar um briefing, tabela, shortlist, faixa de preço ou plano de acompanhamento — não dumps brutos de API.

Ferramentas expostas via MCP

O UnifAPI expõe três ferramentas MCP. Ele não registra uma ferramenta MCP separada para cada endpoint da API.

FerramentaUse para
list_operationsBuscar operações de dados públicos ao vivo por plataforma/palavra-chave.
get_operationInspecionar parâmetros, schemas e exemplos de chamada.
call_apiChamar uma operação concreta e retornar dados mais informações de cobrança.

Fluxo típico de agente:

Descubra operações. Use list_operations quando o agente não souber o caminho exato da API.

Inspecione antes de chamar. Use get_operation para ler parâmetros, a forma do request body e exemplos.

Chame dados públicos. Use call_api com um caminho concreto como /x/tweets/search/recent ou /tiktok/videos/{id} depois que os placeholders forem preenchidos.

Avançado: URL do servidor MCP e bearer de API key

Os caminhos acima cobrem a maioria dos clientes. Use esta seção se você configurar o MCP manualmente, construir sobre o transporte HTTP do MCP ou produtizar a conexão para um cliente que precisa de config explícita.

O UnifAPI expõe sua camada de dados públicos através de um servidor MCP hospedado:

https://mcp.unifapi.com

Configuração manual de MCP

Se o seu cliente aceita uma URL de conector bruta em vez do plugin, adicione o servidor hospedado diretamente.

Conector personalizado do Claude / Claude Desktop:

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

Para os planos Team e Enterprise, um Owner adiciona o conector pelas Organization settings -> Connectors primeiro; os membros então o conectam por Customize -> Connectors. Para configurações antigas do Claude Desktop somente local, o mcp-remote pode fazer a ponte do servidor hospedado através do claude_desktop_config.json:

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

CLI do Claude Code:

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

CLI do Codex:

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

Servidor remoto Streamable HTTP do OpenClaw:

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"
    }
  }
}

Outros clientes MCP — use Streamable HTTP com a URL canônica do servidor:

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

Detalhes do OAuth

O servidor MCP do UnifAPI é um recurso protegido por OAuth.

CampoValor
URL do servidor MCPhttps://mcp.unifapi.com
Metadata do recurso protegidohttps://mcp.unifapi.com/.well-known/oauth-protected-resource
Servidor de autorizaçãohttps://api.unifapi.com/api/auth
Escopo MCP obrigatóriounifapi:mcp
TransporteStreamable HTTP

A metadata do recurso protegido informa a um cliente compatível onde autorizar e qual escopo é necessário. O token OAuth inclui uma claim de workspace, então as chamadas de ferramenta gastam os mesmos créditos de workspace que as chamadas diretas à HTTP API. O OAuth autoriza o UnifAPI; ele não concede acesso às contas de origem privadas de um usuário.

Não adicione campos de escopo personalizados à config do cliente a menos que seu cliente MCP os suporte explicitamente. Um cliente compatível deve descobrir a metadata do recurso protegido e solicitar o escopo necessário.

Fallback de bearer de API key

Use isto apenas quando um cliente não puder completar o OAuth ou explicitamente pedir um bearer token/header. Os caminhos de OAuth acima não precisam de uma API key.

  1. Faça login no dashboard do UnifAPI.
  2. Crie uma API key.
  3. Configure seu cliente MCP para enviá-la como um header de autorização:
Authorization: Bearer YOUR_UNIFAPI_KEY

Exemplo JSON no estilo Cursor:

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

O UnifAPI também aceita os headers X-API-Key e X-UnifAPI-Key para clientes que não conseguem definir Authorization, mas Authorization: Bearer ... é preferível.

Cobrança e créditos

As chamadas MCP usam o mesmo modelo de cobrança das chamadas HTTP.

  • Conectar o servidor MCP (e adicionar as skills) é gratuito.
  • call_api gasta créditos do workspace quando chama uma operação de dados públicos.
  • A metadata de cobrança é retornada no resultado da ferramenta quando a resposta da operação a inclui.
  • Se um workspace não tem mais créditos, as chamadas falham com insufficient_credits.

Veja Limites de taxa para os limites de request e Erros para o vocabulário público de erros.

Solução de problemas

O cliente pede uma API key

Use o fallback de bearer de API key acima. Isso geralmente significa que o cliente ainda não suporta a descoberta de recurso protegido por OAuth.

O OAuth tem sucesso mas as chamadas de ferramenta falham

Verifique se o fluxo OAuth solicitou o recurso e o escopo do MCP:

  • Recurso/audience: https://mcp.unifapi.com/
  • Escopo: unifapi:mcp

Se um cliente não envia o recurso/audience durante a troca de token, ele pode receber um token que não pode ser verificado pelo recurso protegido do MCP.

401 unauthorized

O request MCP está sem um token válido, o token OAuth é inválido para este recurso, ou o token de fallback da API key foi revogado ou digitado errado.

insufficient_credits

O workspace conectado ao token OAuth ou à API key não tem créditos suficientes. Recarregue créditos no dashboard e tente novamente.

A lista de ferramentas parece desatualizada

Reinicie ou recarregue o cliente MCP. Alguns clientes fazem cache de sessões de servidor e listas de ferramentas.

Recursos relacionados

Nesta página