Introduction to Integration

Integration with the SipPulse AI platform is done through a REST API, which allows access to various AI services such as Large Language Models (LLMs), Automatic Speech Recognition (ASR), Text-to-Speech (TTS), and Intelligent Agents.

To facilitate integration, we provide a Swagger UI and an OpenAPI.json that can be used by developers familiar with these tools.

What you will find in this guide

• Authentication: How to configure and use API keys to authenticate your requests.
• Language Models (LLMs): Instructions for using our text generation models.
• Automatic Speech Recognition (ASR): Guide to integrating our audio-to-text transcription services.
• Text-to-Speech (TTS): How to use our models to convert text to audio.
• Agents: Instructions for configuring and using intelligent agents for complex tasks.

This guide is intended for developers and engineers who want to incorporate advanced AI capabilities into their applications efficiently and securely.

Requirements

To start the integration, you will 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.