</> API REFERENCE

Integre o VisionScore AI
na sua stack.

RESTful API com autenticação por token. Respostas em JSON. SDKs em breve.

REST APIJSONRate limit: 100 req/min

Autenticação

HTTP Header
Authorization: Bearer {SEU_TOKEN}

Obtenha seu API token em Configurações → API Keys. Todos os endpoints exigem autenticação via Bearer Token no header da requisição.

Endpoints

POST/v1/analise

Criar nova análise

Submete uma nova análise de oferta e criativo. O VisionScore AI processa as URLs e retorna scores preditivos em tempo real.

Parâmetros

NomeTipoObrigatórioDescrição
oferta_urlstringSimURL da página da oferta (landing page ou VSL)
criativo_urlstringSimURL do criativo (imagem ou vídeo hospedado)
publicostringSimDescrição do público-alvo (ex: "mulheres 25-45, dropshipping")
orcamentonumberNãoOrçamento previsto em reais para cálculo do ROI

Exemplo de Requisição

HTTP
POST /v1/analise
Authorization: Bearer vsai_prod_xxxxxxxxxxxx
Content-Type: application/json

{
  "oferta_url": "https://minha-loja.com/oferta-principal",
  "criativo_url": "https://cdn.minha-loja.com/criativo-01.mp4",
  "publico": "mulheres 25-45 interessadas em moda feminina",
  "orcamento": 2000
}

Exemplo de Resposta

JSON
{
  "id": "anl_9f3k2j1p8x",
  "status": "concluida",
  "created_at": "2025-06-05T14:32:00Z",
  "visionscore": 87,
  "retention_score": 82,
  "intent_score": 91,
  "conversion_score": 79,
  "roi_predictor": {
    "receita_prevista": 8200,
    "roi": 310,
    "roas": 4.1
  },
  "insights": [
    {
      "tipo": "critico",
      "texto": "CTA aparece após 45s — reposicionar antes dos 15s aumenta conversão em ~22%",
      "impacto": "alto"
    },
    {
      "tipo": "positivo",
      "texto": "Prova social forte: 3 depoimentos visuais identificados",
      "impacto": "medio"
    }
  ],
  "recomendacao": "Oferta com alto potencial. Ajustar posicionamento do CTA e testar headline com urgência."
}

SDKs Oficiais

Bibliotecas nativas para integração ainda mais rápida. Em desenvolvimento.

⬡Em breve

JavaScript / Node.js

npm install visionscoreai
🐍Em breve

Python

pip install visionscoreai
🐘Em breve

PHP

composer require vsai/client

Rate Limits

Limites por plano para garantir estabilidade da API para todos os usuários.

PlanoRequests / minAnálises / dia
Grátis10 / min1 / dia
PRO60 / min50 / dia
Agência100 / minIlimitado

Ao exceder o limite, a API retorna status 429 Too Many Requests com header Retry-After.