Plexa

Camada de descoberta agentiva para negócios locais no México e LATAM

Documentação

Novo no Plexa? Leia o que é o Plexa primeiro e depois comece abaixo.

Início rápido

  1. Crie uma conta gratuita

Cadastre-se em joinplexa.com/register (link por e-mail ou Google). Ao entrar, você recebe seu token de acesso à conta — é o <your-account-token> usado para gerar uma chave de API na próxima etapa. Precisa de ajuda? hola@joinplexa.com.

  1. Gere uma chave de API (gratuita)
curl -X POST https://api.joinplexa.com/v1/builders/register \
  -H "Authorization: Bearer <your-account-token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-agent"}'

Retorna uma chave permanente plx_live_… — exibida apenas uma vez, então guarde-a:

{
  "api_key": "plx_live_9f3c...e21a",
  "name": "my-agent",
  "tier": "free",
  "credits_limit": 5000,
  "rate_limit_per_min": 60
}
  1. Pesquise empresas
curl "https://api.joinplexa.com/v1/search?vertical=dental&city=Tijuana&limit=20" \
  -H "Authorization: Bearer plx_live_..."
  1. Ou conecte via MCP — um único comando
claude mcp add --transport http plexa https://api.joinplexa.com/mcp/

Transporte SSE (clientes legados):

claude mcp add --transport sse plexa https://api.joinplexa.com/mcp/sse

Ou adicione manualmente à sua configuração MCP:

{
  "mcpServers": {
    "plexa": {
      "type": "http",
      "url": "https://api.joinplexa.com/mcp/"
    }
  }
}
  1. Ou instale a skill (um roteador Plexa para seu agente)
npx skills add incrematica/plexa-mcp

Instala a skill use-plexa: quando recorrer ao Plexa, as 7 ferramentas e o padrão busca → get_business → contato.

Endpoints

URL base: https://api.joinplexa.com

GET/v1/searchBusca empresas por vertical, cidade e geo

GET/v1/businesses/{slug}Detalhes da empresa por slug

GET/v1/businesses/{id}/queriesFeed de atividade do agente — requer autenticação

GET/v1/verticalsLista todas as verticais disponíveis

GET/v1/stats/publicEstatísticas da plataforma (sem autenticação)

POST/v1/builders/registerRegistra um agente e obtém uma chave de API

GET /v1/search — parâmetros de consulta

ParâmetroTipoPadrãoDescrição

qstring—Consulta de texto livre sobre nome e descrição

verticalstring—Slug da vertical (dental, restaurant, medical…)

citystring—Nome da cidade

statestring—Estado / província

countrystringallCódigo ISO do país (MX, CO, AR…). Omita para pesquisar todos os países do registro.

lat, lngfloat—Centro geográfico; combine com radius_km

radius_kmfloat15Raio de busca a partir de lat/lng, em km

langstring—Filtro de idioma (es, en)

capabilitiesstring—Nomes de capacidades separados por vírgula

min_trust_scoreint0Pontuação mínima de confiança (0–100)

claimedbool—Apenas reivindicadas (true) ou não reivindicadas (false)

limitint20Resultados por página (1–100)

offsetint0Deslocamento de paginação

Exemplo — busca

curl "https://api.joinplexa.com/v1/search?vertical=dental&city=Tijuana&limit=20" \
  -H "Authorization: Bearer plx_live_..."
{
  "results": [
    {
      "id": "b1a2c3d4-5e6f-7890-abcd-ef1234567890",
      "slug": "clinica-dental-norte-tijuana",
      "name": "Clínica Dental Norte",
      "vertical": "dental",
      "city": "Tijuana",
      "state": "B.C.",
      "country": "MX",
      "description_short": "Dentist en Tijuana, B.C.",
      "phone_e164": "+525500000000",
      "languages": ["es"],
      "capabilities": [
        {
          "name": "book_appointment",
          "label": "Agendar cita",
          "action_type": "whatsapp",
          "action_url": "https://wa.me/525500000000?text=Hola...",
          "description": "Envía WhatsApp para agendar cita"
        }
      ],
      "trust_score": 8,
      "claimed": false,
      "tier": "free",
      "aggregate_rating_human": null,
      "review_count_human": 0,
      "specialties": [],
      "distance_km": null
    }
  ],
  "total": 42,
  "limit": 20,
  "offset": 0,
  "filters_applied": { "vertical": "dental", "city": "Tijuana", "country": "MX" }
}

Exemplo — detalhes da empresa

curl "https://api.joinplexa.com/v1/businesses/clinica-dental-norte-tijuana" \
  -H "Authorization: Bearer plx_live_..."
{
  "slug": "clinica-dental-norte-tijuana",
  "name": "Clínica Dental Norte",
  "vertical": "dental",
  "city": "Tijuana",
  "state": "B.C.",
  "country": "MX",
  "phone_e164": "+525500000000",
  "website": "https://example.com",
  "languages": ["es"],
  "opening_hours": [
    { "days": ["Monday","Tuesday","Wednesday","Thursday","Friday"], "opens": "09:00", "closes": "19:00" },
    { "days": ["Saturday"], "opens": "09:00", "closes": "14:00" }
  ],
  "services": [
    { "name": "Limpieza dental", "price_amount": 600, "price_currency": "MXN", "duration_minutes": 45 }
  ],
  "faqs": [
    { "question": "¿Atienden urgencias?", "answer": "Sí, con cita el mismo día." }
  ],
  "capabilities": [
    { "name": "book_appointment", "action_type": "whatsapp", "action_url": "https://wa.me/525500000000?text=Hola..." }
  ],
  "trust_score": 8,
  "tier": "free",
  "claimed": false,
  "profile_completeness": 62
}

Ferramentas MCP

Conecte o Plexa como um servidor MCP e chame as ferramentas diretamente de qualquer agente.

claude mcp add --transport http plexa https://api.joinplexa.com/mcp/

Ou dê ao seu agente a skill de roteador:

npx skills add incrematica/plexa-mcp

MCPRESTllms.txtschema.org

search_businessesBusca por vertical, cidade, raio e capacidades

get_businessDetalhes completos da empresa, incluindo horários e serviços

get_business_hoursHorário de funcionamento de uma empresa específica

get_business_servicesCatálogo de serviços e preços

get_business_faqsFAQs aprovados pelo proprietário para uma empresa

contact_businessCanais de contato + URLs de ação de capacidade (retorna links; não envia)

list_verticalsEnumera todas as verticais do registro

Exemplo — get_business_faqs

// get_business_faqs(slug="clinica-dental-norte-tijuana")
{
  "slug": "clinica-dental-norte-tijuana",
  "name": "Clínica Dental Norte",
  "faqs": [
    { "question": "¿Atienden urgencias?", "answer": "Sí, atendemos urgencias con cita el mismo día." },
    { "question": "¿Aceptan seguros dentales?", "answer": "Trabajamos con las principales aseguradoras nacionales." }
  ]
}

contact_business(slug) retorna os canais de contato da empresa — telefone, whatsapp_url (um link profundo do WhatsApp), site, e-mail (somente empresas reivindicadas) e capacidades com action_urls prontas para uso. Retorna links para seu agente agir — não envia a mensagem em si.

Erros

Erros retornam um corpo JSON no formato { "detail": "…" } com o status HTTP correspondente.

// 401 — missing / invalid / revoked API key
{ "detail": "API key inválida o revocada" }

// 429 — per-minute rate limit
{ "detail": "Rate limit excedido (por minuto)" }

// 429 — monthly credits exhausted
{ "detail": "Créditos mensuales agotados" }