Skip to main content
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.

Base URL

All requests use the v1 API. Prepend this base URL to every endpoint path:
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.
-H "X-Api-Key: YOUR_API_KEY"

Resources

Content

Content items are the core resource. See the developer guide for processing types, the content object, and syndication.

Extraction

Filters Extraction settings Preprocessing settings

Pronunciation settings

Script settings

Script templates

Video settings

Video templates

Background music settings

Voices

Voices Voice generation Speakers Voice cloning Speaker verifications Speaker verification evidences Languages Project voice permissions

Distribution

Player Player settings Access tiers Playlists Podcast feeds

Integrations

Webhooks RSS feed importer Magic Embed Ghost

Analytics

Organization Projects Content Ads

Monetization

Ads

Organization

Projects Project members Roles Organization settings Fonts Plans Member projects

Error handling

The API uses conventional HTTP response codes. Error responses include a JSON body with details:
{
  "error": {
    "code": "invalid_request",
    "message": "A detailed error message",
    "details": {}
  }
}

Getting help