naia API V1 API

API para Generative Engine Optimization (GEO): análise de visibilidade em motores de IA, geração de conteúdo, planos de execução, webhooks e MCP para Autopilot.

GitHub OpenAPI

Operations 35

OPTIONS /api/public/ai-readiness/embed Preflight CORS do embed AI Readiness
GET /api/public/ai-readiness/embed Ler relatório AI Readiness do site parceiro
POST /api/public/ai-readiness/embed Gerar ou ler relatório AI Readiness do site parceiro
GET /businesses Listar marcas
POST /businesses Criar marca
GET /businesses/{id} Detalhe da marca
PUT /businesses/{id} Atualizar marca
DELETE /businesses/{id} Remover marca
POST /businesses/{id}/enrich Enriquecimento com IA
GET /businesses/{id}/queries Listar queries
PUT /businesses/{id}/queries Atualizar queries
POST /analyses Disparar análise GEO
GET /analyses/{id} Status e resultados
GET /analyses/{id}/recommendations Recomendações
GET /content Listar conteúdo
POST /content Gerar conteúdo
GET /content/{id} Detalhe do conteúdo
PATCH /content/{id} Aprovar/desaprovar
GET /execution-plans Listar planos
POST /execution-plans Gerar plano
GET /execution-plans/{id} Detalhe do plano
PATCH /execution-plans/{id}/tasks/{taskId} Atualizar tarefa
POST /execution-plans/{id}/tasks/{taskId}/generate Gerar conteúdo da tarefa
POST /execution-plans/{id}/tasks/bulk-generate Gerar em lote
GET /credits Saldo de créditos
GET /webhooks Listar webhooks
POST /webhooks Registrar webhook
DELETE /webhooks Remover webhook
GET /keys Listar API keys
POST /keys Criar API key
DELETE /keys Revogar API key
GET /businesses/{id}/traffic Ler o grupo Tráfego da marca
POST /businesses/{id}/traffic/refresh Atualizar o grupo Tráfego da marca
POST /mcp MCP Server (JSON-RPC 2.0)
GET /mcp Informações do MCP Server

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/naia-today:naia-api-v1-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

naia-today-v1-openapi.json Raw ↑
{"openapi":"3.1.0","info":{"title":"naia API","version":"1.0.0","description":"API para Generative Engine Optimization (GEO): análise de visibilidade em motores de IA, geração de conteúdo, planos de execução, webhooks e MCP para Autopilot.","contact":{"url":"https://naia.today/developers"}},"externalDocs":{"description":"Documentação pública para API REST, MCP, npm e exemplos de integração","url":"https://naia.today/developers"},"x-naia-discovery":{"llms":"https://naia.today/llms.txt","llmsFull":"https://naia.today/llms-full.txt","apiCatalog":"https://naia.today/.well-known/api-catalog","mcp":"https://naia.today/api/v1/mcp","mcpDescriptor":"https://naia.today/.well-known/mcp.json","mcpServerCard":"https://naia.today/.well-known/mcp/server-card.json","mcpRegistryName":"today.naia/platform","npmPackage":"naia-mcp-server","npmVersion":"1.0.2"},"servers":[{"url":"https://naia.today/api/v1"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key no formato naia_... ou access token OAuth do login universal do MCP. Para AI Readiness de parceiros, use uma API key com escopo ai_readiness."},"mcpOAuth":{"type":"oauth2","description":"Login universal OAuth do MCP: o cliente descobre os endpoints via /.well-known/oauth-protected-resource, registra-se dinamicamente (RFC 7591) e abre o navegador para o usuário aprovar. Refresh token de 180 dias.","flows":{"authorizationCode":{"authorizationUrl":"https://naia.today/api/oauth/mcp/authorize","tokenUrl":"https://naia.today/api/auth/oauth2/token","refreshUrl":"https://naia.today/api/auth/oauth2/token","scopes":{"openid":"Identidade do usuário","profile":"Nome do usuário","email":"E-mail do usuário","offline_access":"Refresh token de 180 dias"}}}}}},"tags":[{"name":"Businesses","description":"Marcas e contexto de negócio"},{"name":"Traffic","description":"Relatórios de Tráfego da marca: Search Console, GA, Social, PageSpeed e Presença Off-Site"},{"name":"Analyses","description":"Análises de visibilidade em motores de IA"},{"name":"Content","description":"Geração e leitura de conteúdo"},{"name":"Execution Plans","description":"Planos de execução e tarefas"},{"name":"Credits","description":"Saldo e consumo de créditos"},{"name":"Webhooks","description":"Eventos e callbacks autenticados"},{"name":"Keys","description":"API keys da conta"},{"name":"MCP","description":"Model Context Protocol para Autopilot"},{"name":"AI Readiness","description":"Check público e embed seguro para sites parceiros"}],"paths":{"/api/public/ai-readiness/embed":{"servers":[{"url":"https://naia.today"}],"options":{"summary":"Preflight CORS do embed AI Readiness","description":"Retorna CORS apenas para origins configurados em AI_READINESS_PARTNER_ORIGINS. Não exige API key.","security":[],"tags":["AI Readiness"],"responses":{"204":{"description":"Origin autorizado"},"403":{"description":"Origin ausente ou não autorizado"}}},"get":{"summary":"Ler relatório AI Readiness do site parceiro","description":"Lê snapshot salvo do domínio parceiro autorizado. Não dispara nova auditoria. Use Authorization: Bearer <NAIA_API_KEY> com escopo ai_readiness, read, write ou admin. Em chamadas server-side sem Origin, informe domain.","security":[{"bearerAuth":[]}],"tags":["AI Readiness"],"parameters":[{"name":"domain","in":"query","required":false,"schema":{"type":"string","minLength":3,"maxLength":300},"description":"Domínio do próprio Origin parceiro. Quando omitido, usa o hostname do Origin."}],"responses":{"200":{"description":"Relatório encontrado"},"400":{"description":"Domínio inválido ou diferente do Origin"},"401":{"description":"API key ausente, inválida, expirada ou revogada"},"403":{"description":"Origin não autorizado ou escopo insuficiente"},"404":{"description":"Snapshot não encontrado"},"429":{"description":"Limite por API key ou autenticação excedido"}}},"post":{"summary":"Gerar ou ler relatório AI Readiness do site parceiro","description":"Lê snapshot salvo ou gera nova auditoria para o domínio parceiro autorizado. Use Authorization: Bearer <NAIA_API_KEY> com escopo ai_readiness, write ou admin. Não aceita force nem campos extras.","security":[{"bearerAuth":[]}],"tags":["AI Readiness"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"domain":{"type":"string","minLength":3,"maxLength":300}}}}}},"responses":{"200":{"description":"Relatório retornado"},"400":{"description":"Payload inválido, domínio inválido ou diferente do Origin"},"401":{"description":"API key ausente, inválida, expirada ou revogada"},"403":{"description":"Origin não autorizado ou escopo insuficiente"},"429":{"description":"Limite por API key, origem, IP ou domínio excedido"}}}},"/businesses":{"get":{"summary":"Listar marcas","tags":["Businesses"]},"post":{"summary":"Criar marca","tags":["Businesses"]}},"/businesses/{id}":{"get":{"summary":"Detalhe da marca","tags":["Businesses"]},"put":{"summary":"Atualizar marca","tags":["Businesses"]},"delete":{"summary":"Remover marca","tags":["Businesses"]}},"/businesses/{id}/enrich":{"post":{"summary":"Enriquecimento com IA","tags":["Businesses"]}},"/businesses/{id}/queries":{"get":{"summary":"Listar queries","tags":["Businesses"]},"put":{"summary":"Atualizar queries","tags":["Businesses"]}},"/analyses":{"post":{"summary":"Disparar análise GEO","tags":["Analyses"],"responses":{"201":{"description":"Análise criada"},"400":{"description":"Pedido inválido. Se models contiver um motor desativado, a resposta traz code ENGINE_DISCONTINUED e discontinuedModels com as chaves a remover. A solicitação inteira é recusada antes da cobrança."}}}},"/analyses/{id}":{"get":{"summary":"Status e resultados","tags":["Analyses"]}},"/analyses/{id}/recommendations":{"get":{"summary":"Recomendações","tags":["Analyses"]}},"/content":{"get":{"summary":"Listar conteúdo","tags":["Content"]},"post":{"summary":"Gerar conteúdo","tags":["Content"]}},"/content/{id}":{"get":{"summary":"Detalhe do conteúdo","tags":["Content"]},"patch":{"summary":"Aprovar/desaprovar","tags":["Content"]}},"/execution-plans":{"get":{"summary":"Listar planos","tags":["Execution Plans"]},"post":{"summary":"Gerar plano","tags":["Execution Plans"]}},"/execution-plans/{id}":{"get":{"summary":"Detalhe do plano","tags":["Execution Plans"]}},"/execution-plans/{id}/tasks/{taskId}":{"patch":{"summary":"Atualizar tarefa","tags":["Execution Plans"]}},"/execution-plans/{id}/tasks/{taskId}/generate":{"post":{"summary":"Gerar conteúdo da tarefa","description":"Gera conteúdo a partir de uma tarefa do plano de execução.","tags":["Execution Plans"]}},"/execution-plans/{id}/tasks/bulk-generate":{"post":{"summary":"Gerar em lote","tags":["Execution Plans"]}},"/credits":{"get":{"summary":"Saldo de créditos","description":"Saldo, total comprado e total usado. Em plano com validade, devolve também expiringCredits (quanto do saldo expira) e expiresAt (quando, no fim do ciclo), preenchidos só para quem gerencia a organização (para os demais papéis vêm null). Plano, compra adicional e custos por ação saem da tool MCP autopilot_get_credits. Escopo read.","tags":["Credits"]}},"/webhooks":{"get":{"summary":"Listar webhooks","tags":["Webhooks"]},"post":{"summary":"Registrar webhook","tags":["Webhooks"]},"delete":{"summary":"Remover webhook","tags":["Webhooks"]}},"/keys":{"get":{"summary":"Listar API keys","tags":["Keys"]},"post":{"summary":"Criar API key","tags":["Keys"]},"delete":{"summary":"Revogar API key","tags":["Keys"]}},"/businesses/{id}/traffic":{"get":{"summary":"Ler o grupo Tráfego da marca","description":"Estado e resumo de Search Console, GA (sessões vindas de IA), Social (ao vivo), PageSpeed e Presença Off-Site: conexão, última atualização, atualização em andamento, próximo horário permitido e custo. Não dispara coleta. Escopo read.","tags":["Traffic"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"sources","in":"query","required":false,"schema":{"type":"string"},"description":"Lista separada por vírgula: gsc, ga, social, pagespeed, offsite. Sem o parâmetro, lê as cinco."},{"name":"period","in":"query","required":false,"schema":{"type":"string","enum":["7d","30d","90d"],"default":"30d"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":5,"maximum":25,"default":10}}],"responses":{"200":{"description":"Leitura por fonte em traffic.sources"},"400":{"description":"Fonte, período ou limite inválido"},"401":{"description":"API key ausente, inválida, expirada ou revogada"},"403":{"description":"Escopo insuficiente"},"404":{"description":"Marca inexistente ou sem acesso"}}}},"/businesses/{id}/traffic/refresh":{"post":{"summary":"Atualizar o grupo Tráfego da marca","description":"Dispara a atualização com as contas já conectadas. Sem sources: gsc, ga e offsite (gratuitos). pagespeed custa 10 créditos e só roda quando pedido. social é lido ao vivo e volta como live. Responde sem esperar a coleta; acompanhe pelo GET. Escopo write.","tags":["Traffic"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"sources":{"type":"array","minItems":1,"items":{"type":"string","enum":["gsc","ga","social","pagespeed","offsite"]}}}}}}},"responses":{"200":{"description":"Nenhuma fonte iniciada (intervalo mínimo, não conectada, sem créditos e afins)"},"202":{"description":"Ao menos uma fonte iniciada; desfechos em refresh.results"},"400":{"description":"sources inválido"},"401":{"description":"API key ausente, inválida, expirada ou revogada"},"403":{"description":"Escopo insuficiente ou papel viewer"},"404":{"description":"Marca inexistente ou sem acesso"},"413":{"description":"Corpo acima de 8 KiB"},"429":{"description":"Teto de atualizações por usuário atingido"}}}},"/mcp":{"post":{"summary":"MCP Server (JSON-RPC 2.0)","description":"Endpoint remoto do MCP da naia, com ferramentas do Autopilot e leituras públicas read-only do naia Index. Conexão recomendada: login universal OAuth, sem copiar credencial (adicione a URL sem header; o cliente MCP abre o navegador para login e aprovação, conexão de até 180 dias). Alternativa: Authorization: Bearer <API key>. O servidor também está no MCP Registry como today.naia/platform e no npm como naia-mcp-server.","security":[{"mcpOAuth":[]},{"bearerAuth":[]}],"tags":["MCP"]},"get":{"summary":"Informações do MCP Server","description":"Retorna versão, protocolo, transporte e quantidade de ferramentas do Autopilot e do naia Index.","tags":["MCP"]}}}}