# Unreal Speech Integration via LowCodeAPI

## Overview

Text-to-speech service providing cost-effective AI voice synthesis

## Base Endpoint

```
https://api.lowcodeapi.com/unrealspeech/
```

## Authentication

LowCodeAPI handles authentication automatically. You only need to:

1. **Sign up** at [Unreal Speech](https://unrealspeech.com)
2. **Get your credentials** from [credential page](https://unrealspeech.com/dashboard)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests

**Auth Type**: TOKEN

## API Categories

- **Test to Speech** - 4 endpoints

## Common Endpoints

### Category: Test to Speech

#### Stream

**Method**: `POST` | **LowCodeAPI Path**: `/stream`

**Full URL**:
```
https://api.lowcodeapi.com/unrealspeech/stream?api_token={api_token}
```

**Description**: Send up to 1000 characters and stream back audio data in 0.3 seconds. The is the endpoint to use for the fastest response.

**Request Body**:
```json
{
  "Text": "<string>",
  "VoiceId": "<enum>"
}
```

---

#### Speech

**Method**: `POST` | **LowCodeAPI Path**: `/speech`

**Full URL**:
```
https://api.lowcodeapi.com/unrealspeech/speech?api_token={api_token}
```

**Description**: Send up to 3,000 characters and synchronously receive an MP3 and JSON timestamp URLs.

**Request Body**:
```json
{
  "Text": "<string>",
  "VoiceId": "<enum>"
}
```

---

#### SynthesisTasks

**Method**: `POST` | **LowCodeAPI Path**: `/synthesistasks`

**Full URL**:
```
https://api.lowcodeapi.com/unrealspeech/synthesistasks?api_token={api_token}
```

**Description**: Send up to 500,000 characters and immediately receive a TaskId. GET TaskId to check the status. Optimized for cost savings and longer requests.

**Request Body**:
```json
{
  "Text": "<string>",
  "VoiceId": "<enum>"
}
```

---

#### SynthesisTasks-Check

**Method**: `GET` | **LowCodeAPI Path**: `/synthesistasks/taskid`

**Full URL**:
```
https://api.lowcodeapi.com/unrealspeech/synthesistasks/taskid?api_token={api_token}
```

**Description**: Check the status of a speech synthesis task.


**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`taskId` | string | Yes |  |

---

## Complete Endpoint Reference

For a complete list of all 4 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/unrealspeech/definition`
- **Official Provider Documentation**: https://docs.unrealspeech.com/reference/getting-started-with-our-api