Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Beyla AI API V1
Introduction
Speech-to-Text (Audio Transcription)
Research Document Handling
Text-to-Speech (TTS)

Beyla AI API V1

Overview

Beyla AI is a comprehensive service that provides advanced speech-to-text (audio transcription), text-to-speech (TTS), and research document handling capabilities. The API is designed to cater to users who require reliable and scalable solutions for processing audio and text data, particularly in telephony, research, and customer support scenarios.

Authentication

All endpoints are secured and require Bearer Token authentication. Ensure that you include a valid token in the Authorization header of your requests. For example:

Plain Text
Authorization: Bearer YOUR_ACCESS_TOKEN

Base URL

The base URL for all API endpoints is https://beylaai.com/api.

Available Endpoints

1. Speech-to-Text (Audio Transcription)

  • Transcribe Audio: Upload an audio file to be transcribed into text. Ideal for applications requiring high-accuracy transcriptions.

  • Retrieve Transcribed Audio by UUID: Retrieve a previously transcribed audio record using its unique UUID.

  • List User's Transcribed Records: Fetch all transcribed records associated with the authenticated user. Results are paginated.

  • Delete Transcribed Record by UUID: Delete a specific transcribed audio record identified by its UUID.

2. Research Document Handling

  • Upload Research Document: Upload a research document (PDF) for text extraction and storage in a structured format.

  • Start a Conversation with Beyla AI: Initiate a conversation with Beyla AI using a prompt and document ID, leveraging the uploaded research document.

  • Retrieve Conversation History: Get the history of conversations related to research files for the authenticated user.

  • Delete Research File by Chat ID: Delete a research file and its associated records by providing the chat_id.

3. Text-to-Speech (TTS)

  • Generate Speech from Text: Convert text to speech with options for different voice models and file formats. Optionally convert the audio for telephony systems.

  • Retrieve TTS Record by UUID: Retrieve a specific TTS record using its UUID.

  • List User's TTS Records: Fetch all TTS records associated with the authenticated user, with pagination support.

  • Delete TTS Record by UUID: Delete a specific TTS record identified by its UUID.

Common Response Structures

  • {"response_success_code": "beyla_success","message": "Operation completed successfully.","data": {...}}

  • {"response_error_code": "beyla_srv_Error","data": { "message": "Server error occurred, please try again"}}

Error Codes

  • beyla_srv_Error: Server error occurred, please try again later.

  • beyla_dnx_Error: Resource not found.

  • beyla_success: Operation completed successfully.