# BeyondWords  Integration via LowCodeAPI

**Last Updated**: February 11, 2026

## Overview
Audio content platform for converting text to natural-sounding speech and managing audio content

**Categories:**
- {'id': 'text-to-audio', 'name': 'Text to Audio AI'}

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

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

## Authentication
**Type:** 

**Official Documentation:** https://developers.beyondwords.io/reference/api-overview

## 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

### List

**Method:** GET
**LowCodeAPI Path:** /v1/projects/{project_id}/ads

**New Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/ads?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads?project_id={project_id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| project_id | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| pagination[limit] | number |  |
| pagination[offset] | number |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/ads?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://developers.beyondwords.io/reference/advertsindex

### Create

**Method:** POST
**LowCodeAPI Path:** /v1/projects/{project_id}/ads

**New Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/ads?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads?project_id={project_id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| project_id | string |  |

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| type | enum |  |
| click_through_url | string |  |
| dark_theme | object |  |
| image_url | string |  |
| light_theme | object |  |
| media_url | string |  |
| placement | enum |  |
| theme | enum |  |
| time_range | object |  |
| title | string |  |
| vast_url | string |  |
| video_theme | object |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/ads?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://developers.beyondwords.io/reference/adscreate

### Update

**Method:** PUT
**LowCodeAPI Path:** /v1/projects/{project_id}/ads/{id}

**New Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/ads/{id}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads/id?id={id}&project_id={project_id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |
| project_id | string |  |

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| click_through_url | string |  |
| dark_theme | object |  |
| image_url | string |  |
| light_theme | object |  |
| media_url | string |  |
| placement | enum |  |
| theme | enum |  |
| time_range | object |  |
| title | string |  |
| video_theme | object |  |

**Example Request (New Format):**

```bash
curl -X PUT 'https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/ads/{id}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://developers.beyondwords.io/reference/adsupdate

### Show

**Method:** GET
**LowCodeAPI Path:** /v1/projects/{project_id}/ads/{id}

**New Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/ads/{id}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads/id?id={id}&project_id={project_id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |
| project_id | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/ads/{id}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://developers.beyondwords.io/reference/adsshow

### Delete

**Method:** DELETE
**LowCodeAPI Path:** /v1/projects/{project_id}/ads/{id}

**New Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/ads/{id}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads/id?id={id}&project_id={project_id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |
| project_id | string |  |

**Example Request (New Format):**

```bash
curl -X DELETE 'https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/ads/{id}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://developers.beyondwords.io/reference/adsdelete

### Organization analytics

**Method:** GET
**LowCodeAPI Path:** /v1/organization/analytics

**New Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/organization/analytics?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/organization/analytics?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| aggregation | enum |  |
| media_variants[] | array |  |
| metrics[] | array |  |
| time_range[end] | string |  |
| time_range[start] | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/beyondwords/v1/organization/analytics?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://developers.beyondwords.io/reference/organizationanalytics

### Projects analytics

**Method:** GET
**LowCodeAPI Path:** /v1/projects/analytics

**New Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/analytics?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/analytics?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| filter[title] | string |  |
| order[by] | enum |  |
| order[dir] | enum |  |
| pagination[limit] | number |  |
| pagination[offset] | number |  |
| time_range[end] | string |  |
| time_range[start] | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/beyondwords/v1/projects/analytics?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://developers.beyondwords.io/reference/projectanalytics_list

### Project analytics

**Method:** GET
**LowCodeAPI Path:** /v1/projects/{id}/analytics

**New Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/{id}/analytics?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/id/analytics?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| aggregation | enum |  |
| media_variants[] | array |  |
| metrics[] | array |  |
| time_range[end] | string |  |
| time_range[start] | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/beyondwords/v1/projects/{id}/analytics?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://developers.beyondwords.io/reference/projectanalytics

### Contents analytics

**Method:** GET
**LowCodeAPI Path:** /v1/projects/{project_id}/content/analytics

**New Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/content/analytics?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/analytics?project_id={project_id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| project_id | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| filter[title] | string |  |
| order[by] | enum |  |
| order[dir] | enum |  |
| pagination[limit] | number |  |
| pagination[offset] | number |  |
| time_range[end] | string |  |
| time_range[start] | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/content/analytics?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://developers.beyondwords.io/reference/contentanalytics_list

### Content analytics

**Method:** GET
**LowCodeAPI Path:** /v1/projects/{project_id}/content/{id}/analytics

**New Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/content/{id}/analytics?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/id/analytics?id={id}&project_id={project_id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |
| project_id | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| aggregation | enum |  |
| media_variants[] | array |  |
| metrics[] | array |  |
| time_range[end] | string |  |
| time_range[start] | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/beyondwords/v1/projects/{project_id}/content/{id}/analytics?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://developers.beyondwords.io/reference/contentanalytics


## 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/beyondwords/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/beyondwords/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/beyondwords/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/beyondwords/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 |
|----------|--------|----------|
| List | GET | Ads |
| Create | POST | Ads |
| Update | PUT | Ads |
| Show | GET | Ads |
| Delete | DELETE | Ads |
| Organization analytics | GET | Analytics |
| Projects analytics | GET | Analytics |
| Project analytics | GET | Analytics |
| Contents analytics | GET | Analytics |
| Content analytics | GET | Analytics |
| Ads analytics | GET | Analytics |
| Ad analytics | GET | Analytics |
| List | GET | Background tracks |
| Create | POST | Background tracks |
| Update | PUT | Background tracks |
| Show | GET | Background tracks |
| Delete | DELETE | Background tracks |
| List | GET | Content |
| Create | POST | Content |
| Update | PUT | Content |
| Show | GET | Content |
| Delete | DELETE | Content |
| Regenerate | POST | Content |
| Search fields | GET | Content |
| Summarize | POST | Content |
| List | GET | Html filters |
| Create | POST | Html filters |
| Update | PUT | Html filters |
| Show | GET | Html filters |
| Delete | DELETE | Html filters |
| List | GET | Languages |
| Show | GET | Player |
| Show | GET | Player |
| Show | GET | Player |
| Show | GET | Player |
| Show | GET | Player |
| Show | GET | Player settings |
| Update | PUT | Player settings |
| List | GET | Playlists |
| Create | POST | Playlists |
| Update | PUT | Playlists |
| Show | GET | Playlists |
| Delete | DELETE | Playlists |
| List | GET | Projects |
| Create | POST | Projects |
| Update | PUT | Projects |
| Show | GET | Projects |
| Delete | DELETE | Projects |
| List | GET | RSS Feed |
| Create | POST | RSS Feed |
| Update | PUT | RSS Feed |
| Delete | DELETE | RSS Feed |
| Run | POST | RSS Feed |
| Test | POST | RSS Feed |
| List | GET | Rules |
| Create | POST | Rules |
| Update | PUT | Rules |
| Show | GET | Rules |
| Delete | DELETE | Rules |
| Regenerate preview | POST | Rules |
| Preview | POST | Rules |
| Phonemes | GET | Rules |
| Show | GET | Summarization settings |
| Update | PUT | Summarization settings |
| Upload | POST | Upload |
| Show | GET | Video Settings |
| Update | PUT | Video Settings |
| List | GET | Voice issues |
| Create | POST | Voice issues |
| Update | PUT | Voice issues |
| Show | GET | Voice issues |
| Delete | DELETE | Voice issues |
| List | GET | Voices |
| Update | PUT | Voices |
| List | GET | Webhooks |
| Create | POST | Webhooks |
| Update | PUT | Webhooks |
| Show | GET | Webhooks |
| Delete | DELETE | Webhooks |
| Test | POST | Webhooks |

## API Definition Endpoints

You can fetch the complete API specification for this provider:

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

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

## Response Format

All responses are wrapped in a `data` key:

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