> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beyondwords.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Complete BeyondWords API reference

The BeyondWords API is a RESTful API that provides headless access to the entire platform. It has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

This reference documents every endpoint, including admin, voice cloning, and advanced configuration APIs. For the curated integrator reference, see [API reference](/api-reference/overview).

## Base URL

All requests use the `v1` API. Prepend this base URL to every endpoint path:

```text theme={null}
https://api.beyondwords.io/v1/
```

## Authentication

Every request requires your API key in the `X-Api-Key` header. Find your Project ID and API Key under **Settings → Integrations → API**.

```bash theme={null}
-H "X-Api-Key: YOUR_API_KEY"
```

## Resources

### Content

Content items are the core resource. See the [developer guide](/api-reference/content/introduction) for processing types, the [content object](/api-reference/content/overview), and [syndication](/api-reference/content/syndicated).

* [Create and generate content](/full-api-reference/content/create)
* [Get content](/full-api-reference/content/show)
* [Update content](/full-api-reference/content/update)
* [Delete content](/full-api-reference/content/delete)
* [Regenerate content](/full-api-reference/content/regenerate)
* [Summarize content](/full-api-reference/content/summarize)
* [Upload file](/full-api-reference/content/upload)
* [List content](/full-api-reference/content/list)
* [Duplicate content](/full-api-reference/content/duplicate)
* [Get content search fields](/full-api-reference/content/search-fields)
* [Search content assets](/full-api-reference/content/search-assets)
* [Get content asset](/full-api-reference/content/get-asset)

### Extraction

**Filters**

* [Content filters overview](/full-api-reference/content-filters/overview)
* [List content filters](/full-api-reference/content-filters/list)
* [Create content filter](/full-api-reference/content-filters/create)
* [Get content filter](/full-api-reference/content-filters/show)
* [Update content filter](/full-api-reference/content-filters/update)
* [Delete content filter](/full-api-reference/content-filters/delete)

**Extraction settings**

* [Get content extraction settings](/full-api-reference/content-extraction-settings/show)
* [Update content extraction settings](/full-api-reference/content-extraction-settings/update)

**Preprocessing settings**

* [Get preprocessing settings](/full-api-reference/preprocessing-settings/show)
* [Update preprocessing settings](/full-api-reference/preprocessing-settings/update)

### Pronunciation settings

* [List pronunciation rules](/full-api-reference/rules/list)
* [Create pronunciation rule](/full-api-reference/rules/create)
* [Get pronunciation rule](/full-api-reference/rules/show)
* [Update pronunciation rule](/full-api-reference/rules/update)
* [Delete pronunciation rule](/full-api-reference/rules/delete)
* [Regenerate pronunciation preview](/full-api-reference/rules/regenerate-preview)
* [Preview pronunciation rule](/full-api-reference/rules/preview)
* [Get rule phonemes](/full-api-reference/rules/phonemes)
* [Transcribe pronunciation rule](/full-api-reference/rules/transcribe)
* [List pronunciation rule matches](/full-api-reference/rules/matches)

### Script settings

* [Get project script settings](/full-api-reference/summarization-settings/show)
* [Update project script settings](/full-api-reference/summarization-settings/update)

**Script templates**

* [List script templates](/full-api-reference/summarization-settings-templates/list)
* [Create script template](/full-api-reference/summarization-settings-templates/create)
* [Get script template](/full-api-reference/summarization-settings-templates/show)
* [Update script template](/full-api-reference/summarization-settings-templates/update)
* [Delete script template](/full-api-reference/summarization-settings-templates/delete)

### Video settings

* [Get video settings](/full-api-reference/video-settings/show)
* [Update video settings](/full-api-reference/video-settings/update)

**Video templates**

* [List video settings templates](/full-api-reference/video-settings-templates/list)
* [Create video settings template](/full-api-reference/video-settings-templates/create)
* [Get video settings template](/full-api-reference/video-settings-templates/show)
* [Update video settings template](/full-api-reference/video-settings-templates/update)
* [Delete video settings template](/full-api-reference/video-settings-templates/delete)
* [Preview video settings template](/full-api-reference/video-settings-templates/preview)

### Background music settings

* [List background tracks](/full-api-reference/background-tracks/list)
* [Create background track](/full-api-reference/background-tracks/create)
* [Get background track](/full-api-reference/background-tracks/show)
* [Update background track](/full-api-reference/background-tracks/update)
* [Delete background track](/full-api-reference/background-tracks/delete)

### Voices

**Voices**

* [List voices](/full-api-reference/voices/list)
* [Get voice](/full-api-reference/voices/show)
* [Update voice](/full-api-reference/voices/update)
* [Delete voice](/full-api-reference/voices/delete)

**Voice generation**

* [Design voice previews](/full-api-reference/voices/design-previews)
* [Finalize voice design](/full-api-reference/voices/finalize-design)

**Speakers**

* [List speakers](/full-api-reference/speakers/list)
* [Create speaker](/full-api-reference/speakers/create)
* [Get speaker](/full-api-reference/speakers/show)
* [Update speaker](/full-api-reference/speakers/update)
* [Delete speaker](/full-api-reference/speakers/delete)

**Voice cloning**

* [Create voice](/full-api-reference/voices/create)
* [Clone instant voice](/full-api-reference/voices/clone)

**Speaker verifications**

* [Get speaker verification](/full-api-reference/speaker-verifications/show)
* [Create speaker verification](/full-api-reference/speaker-verifications/create)
* [Update speaker verification](/full-api-reference/speaker-verifications/update)
* [Delete speaker verification](/full-api-reference/speaker-verifications/delete)

**Speaker verification evidences**

* [List speaker verification evidences](/full-api-reference/speaker-verification-evidences/list)
* [Create speaker verification evidence](/full-api-reference/speaker-verification-evidences/create)
* [Delete speaker verification evidence](/full-api-reference/speaker-verification-evidences/delete)

**Languages**

* [List languages](/full-api-reference/languages/list)

**Project voice permissions**

* [List project voice permissions](/full-api-reference/project-voices/list)
* [Create project voice permission](/full-api-reference/project-voices/create)
* [Get project voice permission](/full-api-reference/project-voices/show)
* [Delete project voice permission](/full-api-reference/project-voices/delete)

### Distribution

**Player**

* [Get player by content ID](/full-api-reference/player/by-content-id)
* [Get player by source ID](/full-api-reference/player/by-source-id)
* [Get player by source URL](/full-api-reference/player/by-source-url)
* [Get player by playlist ID](/full-api-reference/player/by-playlist-id)
* [Get player by multiple identifiers](/full-api-reference/player/by-identifiers)

**Player settings**

* [Get player settings](/full-api-reference/player-settings/show)
* [Update player settings](/full-api-reference/player-settings/update)

**Access tiers**

* [List access tiers](/full-api-reference/access-tiers/list)
* [Create access tier](/full-api-reference/access-tiers/create)
* [Get access tier](/full-api-reference/access-tiers/show)
* [Update access tier](/full-api-reference/access-tiers/update)

**Playlists**

* [List playlists](/full-api-reference/playlists/list)
* [Create playlist](/full-api-reference/playlists/create)
* [Get playlist](/full-api-reference/playlists/show)
* [Update playlist](/full-api-reference/playlists/update)
* [Delete playlist](/full-api-reference/playlists/delete)

**Podcast feeds**

* [Get podcast feed settings](/full-api-reference/podcast-feeds/get-settings)
* [Update podcast feed settings](/full-api-reference/podcast-feeds/update-settings)

### Integrations

**Webhooks**

* [List webhooks](/full-api-reference/webhooks/list)
* [Create webhook](/full-api-reference/webhooks/create)
* [Get webhook](/full-api-reference/webhooks/show)
* [Update webhook](/full-api-reference/webhooks/update)
* [Delete webhook](/full-api-reference/webhooks/delete)
* [Test webhook](/full-api-reference/webhooks/test)

**RSS feed importer**

* [List RSS feed imports](/full-api-reference/rss-feed/list)
* [Create RSS feed import](/full-api-reference/rss-feed/create)
* [Get RSS feed import](/full-api-reference/rss-feed/show)
* [Update RSS feed import](/full-api-reference/rss-feed/update)
* [Delete RSS feed import](/full-api-reference/rss-feed/delete)
* [Run RSS feed import](/full-api-reference/rss-feed/run)
* [Test RSS feed import](/full-api-reference/rss-feed/test)

**Magic Embed**

* [Get Magic Embed settings](/full-api-reference/magic-embed/show)
* [Update Magic Embed settings](/full-api-reference/magic-embed/update)

**Ghost**

* [Get Ghost integration](/full-api-reference/ghost/show)
* [Update Ghost integration](/full-api-reference/ghost/update)
* [Test Ghost integration](/full-api-reference/ghost/test)
* [Ghost posts webhook](/full-api-reference/ghost/posts)

### Analytics

**Organization**

* [Get organization analytics](/full-api-reference/analytics/organization-analytics)
* [Get billing analytics](/full-api-reference/analytics/billing-analytics)

**Projects**

* [List projects analytics](/full-api-reference/analytics/projects-analytics)
* [Get project analytics](/full-api-reference/analytics/project-analytics)

**Content**

* [List content analytics](/full-api-reference/analytics/contents-analytics)
* [Get content analytics](/full-api-reference/analytics/content-analytics)

**Ads**

* [List ads analytics](/full-api-reference/analytics/ads-analytics)
* [Get ad analytics](/full-api-reference/analytics/ad-analytics)

### Monetization

**Ads**

* [List ads](/full-api-reference/ads/list)
* [Create ad](/full-api-reference/ads/create)
* [Get ad](/full-api-reference/ads/show)
* [Update ad](/full-api-reference/ads/update)
* [Delete ad](/full-api-reference/ads/delete)

### Organization

**Projects**

* [List projects](/full-api-reference/projects/list)
* [Create project](/full-api-reference/projects/create)
* [Get project](/full-api-reference/projects/show)
* [Update project](/full-api-reference/projects/update)
* [Delete project](/full-api-reference/projects/delete)
* [Get project voices](/full-api-reference/projects/voices)

**Project members**

* [List project members](/full-api-reference/project-members/list)
* [Add member to project](/full-api-reference/project-members/add-member-to-project)
* [Remove project member](/full-api-reference/project-members/delete)

**Roles**

* [List roles](/full-api-reference/roles/list)
* [Create role](/full-api-reference/roles/create)
* [Get role](/full-api-reference/roles/show)
* [Update role](/full-api-reference/roles/update)
* [Delete role](/full-api-reference/roles/delete)
* [List role permissions](/full-api-reference/roles/permissions)

**Organization settings**

* [Get organization settings](/full-api-reference/organization-settings/show)
* [Update organization quota settings](/full-api-reference/organization-settings/update-quota-settings)

**Fonts**

* [List fonts](/full-api-reference/fonts/list)
* [Create font](/full-api-reference/fonts/create)
* [Get font](/full-api-reference/fonts/show)
* [Update font](/full-api-reference/fonts/update)
* [Delete font](/full-api-reference/fonts/delete)

**Plans**

* [List plans](/full-api-reference/plans/list)

**Member projects**

* [Update member project](/full-api-reference/member-projects/update)

## Error handling

The API uses conventional HTTP response codes. Error responses include a JSON body with details:

```json theme={null}
{
  "error": {
    "code": "invalid_request",
    "message": "A detailed error message",
    "details": {}
  }
}
```

## Getting help

* [Contact support](/docs-and-guides/support/get-support)