# Resemble AI Integration via LowCodeAPI

**Last Updated**: January 27, 2025

## Overview
Voice cloning and synthesis platform for creating custom AI voices

**Categories:**
- {'id': 'text-to-speech', 'name': 'Text to Speech AI'}

## Base Endpoint
https://api.lowcodeapi.com/resembleai

**Important**: Always include the provider name in the URL path after `api.lowcodeapi.com/`

## Authentication
**Type:** TOKEN

**Official Documentation:** https://docs.app.resemble.ai/docs/getting_started/quick_start

## URL Format (Important)

LowCodeAPI supports two URL formats. **Always try the New Format first**, then fall back to Old Format if needed.

### New Format (Priority)
- Path parameters stay in the URL path
- Do NOT include path parameters as query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/{id}?api_token=XXX`

### Old Format (Fallback)
- Path parameters become query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/id?id={id}&api_token=XXX`

### Decision Flow for AI Agents
1. Always use **New Format** first - keep path parameters in the URL path
2. If you get a 404 or error, try **Old Format** with sanitized path
3. Log which format worked for future requests to this provider

## API Categories

## Common Endpoints

### Get all recordings

**Method:** GET
**LowCodeAPI Path:** /v2/voices/<voice_uuid>/recordings

**New Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/recordings?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/voice_uuid/recordings?voice_uuid={voice_uuid}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| voice_uuid | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| page | number |  |
| page_size | number |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/recordings?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://docs.app.resemble.ai/docs/create_voices/resource_recording/all

### Get a recording

**Method:** GET
**LowCodeAPI Path:** /v2/voices/<voice_uuid>/recordings/<recording_uuid>

**New Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/recordings/<recording_uuid>?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/voice_uuid/recordings/recording_uuid?recording_uuid={recording_uuid}&voice_uuid={voice_uuid}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| recording_uuid | string |  |
| voice_uuid | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/recordings/<recording_uuid>?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://docs.app.resemble.ai/docs/create_voices/resource_recording/one

### Create a recording

**Method:** POST
**LowCodeAPI Path:** /v2/voices/<voice_uuid>/recordings

**New Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/recordings?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/voice_uuid/recordings?voice_uuid={voice_uuid}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| voice_uuid | string |  |

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| text | string |  |
| emotion | string |  |
| file | file |  |
| fill | boolean |  |
| is_active | boolean |  |
| name | string |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/recordings?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://docs.app.resemble.ai/docs/create_voices/resource_recording/create

### Update a recording

**Method:** PUT
**LowCodeAPI Path:** /v2/voices/<voice_uuid>/recordings/<recording_uuid>


**New Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/recordings/<recording_uuid>
?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/voice_uuid/recordings/recording_uuid?recording_uuid={recording_uuid}&voice_uuid={voice_uuid}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| recording_uuid | string |  |
| voice_uuid | string |  |

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| text | string |  |
| emotion | string |  |
| fill | boolean |  |
| is_active | boolean |  |
| name | string |  |

**Example Request (New Format):**

```bash
curl -X PUT 'https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/recordings/<recording_uuid>
?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://docs.app.resemble.ai/docs/create_voices/resource_recording/update

### Delete a recording

**Method:** DELETE
**LowCodeAPI Path:** /v2/voices/<voice_uuid>/recordings/<recording_uuid>


**New Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/recordings/<recording_uuid>
?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/voice_uuid/recordings/recording_uuid?recording_uuid={recording_uuid}&voice_uuid={voice_uuid}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| recording_uuid | string |  |
| voice_uuid | string |  |

**Example Request (New Format):**

```bash
curl -X DELETE 'https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/recordings/<recording_uuid>
?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://docs.app.resemble.ai/docs/create_voices/resource_recording/delete

### Get all voices

**Method:** GET
**LowCodeAPI Path:** /v2/voices

**New Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| advanced | boolean |  |
| page | number |  |
| page_size | number |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/resembleai/v2/voices?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://docs.app.resemble.ai/docs/create_voices/resource_voice/all

### Get a voice

**Method:** GET
**LowCodeAPI Path:** /v2/voices/<voice_uuid>

**New Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/voice_uuid?voice_uuid={voice_uuid}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| voice_uuid | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| advanced | boolean |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://docs.app.resemble.ai/docs/create_voices/resource_voice/one

### Create a voice

**Method:** POST
**LowCodeAPI Path:** /v2/voices

**New Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices?api_token=YOUR_API_TOKEN

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| callback_uri | string |  |
| consent | string |  |
| namdataset_urle | string |  |
| name | string |  |
| voice_type | string |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/resembleai/v2/voices?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://docs.app.resemble.ai/docs/create_voices/resource_voice/create

### Build a voice

**Method:** POST
**LowCodeAPI Path:** /v2/voices/<voice_uuid>/build

**New Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/build?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voices/voice_uuid/build?api_token=YOUR_API_TOKEN

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| fill | boolean |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/resembleai/v2/voices/<voice_uuid>/build?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://docs.app.resemble.ai/docs/create_voices/resource_voice/build

### Create a voice from prompt

**Method:** POST
**LowCodeAPI Path:** /v2/voice_design

**New Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voice_design?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/resembleai/v2/voice_design?api_token=YOUR_API_TOKEN

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| callback_uri | string |  |
| name | string |  |
| prompt | string |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/resembleai/v2/voice_design?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://docs.app.resemble.ai/docs/create_voices/resource_voice_design/create


## Usage Examples

### Example 1: Basic Chat Completion

Creating a simple text completion or chat message:

```bash
# Create a chat completion - no path parameters needed
curl -X POST "https://api.lowcodeapi.com/resembleai/v1/chat/completions?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-model-name",
    "messages": [
      {"role": "user", "content": "Hello, how can you help me?"}
    ]
  }'

# Response includes generated content
```

### Example 2: Text Generation with Path Parameters

Generating text with specific model settings:

```bash
# Generate content using a specific model
curl -X POST "https://api.lowcodeapi.com/resembleai/v1/models/generate?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Write a short poem about technology",
    "max_tokens": 100
  }'

# Or if the provider uses model in the path:
curl -X POST "https://api.lowcodeapi.com/resembleai/v1/models/{MODEL_ID}:generateContent?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": [{"parts": [{"text": "Write a short story"}]}]
  }'
```

### Example 3: List Available Models

```bash
# Get list of available models
curl -X GET "https://api.lowcodeapi.com/resembleai/v1/models?api_token=YOUR_API_TOKEN"
```

## Error Handling

LowCodeAPI returns standard HTTP status codes. Common errors:

| Status Code | Description |
|-------------|-------------|
| 200 | Success - Request completed successfully |
| 400 | Bad Request - Invalid parameters or request body |
| 401 | Unauthorized - Invalid or missing API token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Endpoint or resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Server Error - Provider API error |

All error responses include error details:

```json
{
  "data": {
    "error": {
      "message": "Error description",
      "code": "ERROR_CODE"
    }
  }
}
```

## Complete Endpoint Reference

| Endpoint | Method | Category |
|----------|--------|----------|
| Get all recordings | GET | Create Voices / Recordings |
| Get a recording | GET | Create Voices / Recordings |
| Create a recording | POST | Create Voices / Recordings |
| Update a recording | PUT | Create Voices / Recordings |
| Delete a recording | DELETE | Create Voices / Recordings |
| Get all voices | GET | Create Voices / Voices |
| Get a voice | GET | Create Voices / Voices |
| Create a voice | POST | Create Voices / Voices |
| Build a voice | POST | Create Voices / Voices |
| Create a voice from prompt | POST | Create Voices / Voice Design |
| Delete a voice | DELETE | Create Voices / Voices |
| Detect Deepfake | POST | Detect / Deepfake Detection |
| Get Detection Result | GET | Detect / Deepfake Detection |
| Apply Watermark | POST | Detect / Watermark |
| Detect Watermark | POST | Detect / Watermark |
| Get all batches | GET | Generate Speech / Synthesize / Batch |
| Get a batch | GET | Generate Speech / Synthesize / Batch |
| Create a batch | POST | Generate Speech / Synthesize / Batch |
| Delete a batch | DELETE | Generate Speech / Synthesize / Batch |
| Get all clips | GET | Generate Speech / Synthesize / Clip |
| Get a clip | GET | Generate Speech / Synthesize / Clip |
| Create a clips | POST | Generate Speech / Synthesize / Clip |
| Update a clip | PUT | Generate Speech / Synthesize / Clip |
| Delete a clips | DELETE | Generate Speech / Synthesize / Clip |
| Get account information | GET | Management / Account |
| Get account teams | GET | Management / Account |
| Get all phonemes | GET | Management / Phoneme |
| Get a phoneme | GET | Management / Phoneme |
| Create a phoneme | POST | Management / Phoneme |
| Delete a phoneme | DELETE | Management / Phoneme |
| Get all projects | GET | Management / Project |
| Get a project | GET | Management / Project |
| Create a project | POST | Management / Project |
| Update a project | PUT | Management / Project |
| Delete a project | DELETE | Management / Project |
| Get all term substitutions | GET | Management / Term substitutions |
| Get a term substitution | GET | Management / Term substitutions |
| Create a term substitution | POST | Management / Term substitutions |
| Delete a term substitution | DELETE | Management / Term substitutions |

## API Definition Endpoints

You can fetch the complete API specification for this provider:

**New Format (OpenAPI spec):**
```bash
curl 'https://backend.lowcodeapi.com/resembleai/openapi'
```

**Old Format (API definition):**
```bash
curl 'https://backend.lowcodeapi.com/resembleai/definition'
```

## Response Format

All responses are wrapped in a `data` key:

```json
{
  "data": {
    // Actual response from provider (object or array)
  }
}
```