Getting StartedIntroduction

Vendor API

Documentação completa da API REST para automação de agentes de voz, gerenciamento de números, conversas e muito mais.

Visão Geral

A API Vendor permite que você gerencie programaticamente todos os recursos da plataforma. Todas as requisições devem ser feitas ao endpoint base da sua instalação, com autenticação via API Key.

Base URL
https://api.vendoria.com.br/api

Autenticação Rápida

Todas as requisições da API devem incluir sua API Key no header X-Api-Key.

Exemplo de requisição autenticada
curl -X GET https://api.vendoria.com.br/api/agents \
  -H "X-Api-Key: vk_sua_api_key_aqui"

API Keys

Crie suas API Keys na seção API Keys do painel. A chave completa é exibida apenas uma vez no momento da criação — salve-a em um local seguro.

Formato das Respostas

Todas as respostas são retornadas em formato JSON. Respostas de erro incluem statusCode, error e message.

✓ Sucesso
{
  "id": "clxyz123...",
  "name": "Meu Agente",
  "isActive": true
}
✗ Erro
{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "API Key inválida"
}

Recursos Disponíveis