Integration Introduction

The SipPulse AI platform has a REST API designed to be the central communication point with all its Artificial Intelligence resources. This API allows developers to programmatically interact and integrate services such as text generation models (LLMs), speech recognition (ASR), text-to-speech conversion (TTS), and intelligent agents directly into their applications.

To assist in API usage, we provide a Swagger UI and an OpenAPI.json file.

Requirements

To start integration, you'll need:

• API Key: Generate an API key in the API Keys section of your SipPulse AI account. Instructions for creating API Keys
• Programming knowledge: Familiarity with HTTP requests and JSON data manipulation.

Each section of this documentation will provide code examples in different programming languages to facilitate integration with our services.

Authentication

To use the SipPulse AI platform services, all requests must be authenticated using an API key. To generate an API key, follow the instructions in the API Keys section of the documentation.

Using the API Key

All requests to the SipPulse AI platform must include the API key in the request header. The header used is api-key. Below are examples of how to include the API key in requests using different programming languages.

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));

API Key Security

• Confidentiality: Never share your API keys publicly. Avoid including them in browser or client code.
• Key Rotation: Periodically generate new API keys and replace old ones to improve security.
• Revocation: If an API key is compromised, revoke it immediately through the API Keys section.