Introdução à Integração

A plataforma SipPulse AI possui uma REST API projetada para ser o ponto central de comunicação com todos os seus recursos de Inteligência Artificial. Esta API permite que desenvolvedores interajam e integrem programaticamente serviços como modelos de geração de texto (LLMs), reconhecimento de fala (ASR), conversão de texto para fala (TTS) e agentes inteligentes diretamente em suas aplicações.

Para auxiliar na utilização da API, disponibilizamos um Swagger UI e um arquivo OpenAPI.json.

Requisitos

Para começar a integração, você precisará:

• Chave API: Gere uma chave API na seção API Keys da sua conta SipPulse AI. Instruções para criar API Keys
• Conhecimentos em programação: Familiaridade com HTTP requests e manipulação de dados JSON.

Cada seção desta documentação fornecerá exemplos de código em diferentes linguagens de programação para facilitar a integração com nossos serviços.

Autenticação

Para utilizar os serviços da plataforma SipPulse AI, todas as requisições devem ser autenticadas usando uma chave API. Para gerar uma chave API, siga as instruções na seção API Keys da documentação.

Usando a Chave API

Todas as requisições para a plataforma SipPulse AI devem incluir a chave API no cabeçalho da requisição. O cabeçalho utilizado é api-key. Abaixo estão exemplos de como incluir a chave API em requisições utilizando diferentes linguagens de programação.

cURL

curl -X 'GET' \
  'https://api.sippulse.ai/v1/llms/models' \
  -H 'Content-Type: application/json' \
  -H 'api-key: $SIPPULSE_API_KEY'

Python

import requests

url = "https://api.sippulse.ai/v1/llms/models"
headers = {
    "Content-Type": "application/json",
    "api-key": "SIPPULSE_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())

JavaScript

const url = "https://api.sippulse.ai/v1/llms/models";
const headers = {
  "Content-Type": "application/json",
  "api-key": "SIPPULSE_API_KEY",
};

fetch(url, {
  method: "GET",
  headers: headers,
})
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error:", error));

Segurança da Chave API

• Confidencialidade: Nunca compartilhe suas chaves API publicamente. Evite incluí-las em código de navegador ou cliente.
• Rotação de Chaves: Periodicamente, gere novas chaves API e substitua as antigas para melhorar a segurança.
• Revogação: Caso uma chave API seja comprometida, revogue-a imediatamente através da seção API Keys.