Docs and guides

Docs

• Create ad: Creates an ad in a project
• Delete ad: Deletes an ad from a project
• List ads: Lists ads within a project
• Get ad: Gets an ad from a project
• Update ad: Updates an ad in a project
• Get ad analytics: Retrieve analytics for a single ad in a project.
• List ads analytics: Retrieve analytics overview for all ads in a project.
• Get content analytics: Retrieve analytics for some specific content.
• List content analytics: Retrieves an analytics overview for all content items in a project
• Get organization analytics: Retrieves analytics for all projects within an organization
• Get project analytics: Retrieves analytics for a project
• List projects analytics: Retrieves an analytics overview for all projects within an organization
• Create content: Creates a content item in your project
• Delete content: Delete a content item from your project
• List content: Lists content within a project
• Content overview: Overview of the content object and its properties
• Regenerate content: Reprocess content in a project.
• Introduction to segments
• Get content: Get a content item from your project
• Syndicated articles: Reuse audio articles across multiple projects or websites without generating audio for each one.
• Update content: Update a content item from your project
• Overview: Learn about the BeyondWords API
• Get player by content ID: Gets player data related to a content item
• Get player by playlist ID: Gets player data related to a playlist
• Get player by source ID: Gets player data related to a content item
• Get player by source URL: Gets player data related to a content item
• Get player by multiple identifiers: Gets player data related to a content item
• Create playlist: Creates a playlist in a project
• Delete playlist: Deletes a custom playlist from a project
• List playlists: Lists playlists within a project
• Get playlist: Gets a playlist from a project
• Get playlist settings: Gets the feed settings for a playlist
• Update playlist: Updates a playlist in a project
• Update playlist settings: Updates the feed settings for a playlist
• Create project: Creates a project in your organization
• Delete project: Deletes a project
• List projects: Lists all projects in your organization
• Get project: Gets a project from your organization
• Update project: Updates a project in your organization
• Get project voices: Gets a project voices
• Create pronunciation rule: Creates a rule in a organization
• Delete pronunciation rule: Deletes a rule from your organization
• List pronunciation rules: Lists rules in a organization
• Get pronunciation rule: Gets a rule from your organization
• Update pronunciation rule: Updates rule in a organizaiton
• Get project summarization settings: Get the summarization settings for your project
• Update project summarization settings: Update the summarization settings for your project
• Get video settings: Get the video settings for your project
• Update video settings: Update the video settings for your project
• Credits: Learn how BeyondWords credits work.
• Members and Roles: Learn how to manage team members and their roles in BeyondWords
• Organization: Update your organization details in BeyondWords
• Profile: Update your profile in BeyondWords
• Projects: Create and update your projects in BeyondWords
• SAML SSO: Learn how to enable SAML for your Organization to manage logins through an Identity Provider
• Subscription and billing: Manage your BeyondWords subscription and billing.
• Usage analytics: Track article and character usage across your whole organization.
• Event schema: Learn about the structure of analytics events
• Player: Track and analyze audio engagement
• Preferences: Configure analytics settings and preferences
• Changelog
• Audio articles: Learn how to manage your audio articles in BeyondWords
• Data attributes: Learn how content extraction can use data attributes.
• Editor: Learn how to generate audio and video using the Editor
• Background music: Learn how to add background music to your audio articles with BeyondWords
• Pronunciations: Learn how to customize the pronunciation of words in your articles with BeyondWords
• Scripts: Learn how to use script templates to transform your articles into editable scripts for audio and video, using prompts that shape tone, length, and format.
• Video: Learn how to turn your articles into videos with BeyondWords.
• Voices: Configure voice preferences
• Access tiers: Customize the player experience based on the visitor's access tier.
• Overview: Get started with the BeyondWords player
• Getting started
• Segments playback
• Custom CDN domain
• Getting started
• Segments playback
• Building your own UI
• Getting started
• Player events: List of player events emitted and listening for events
• Programmatic control
• Player settings: List of configurable properties in the player
• Segments playback
• Overview: The BeyondWords player SDKs
• Settings: Configure the BeyondWords player settings
• Playlists: Create, curate, publish, and share audio or video playlists.
• Podcast feeds: Create, curate, and share audio or video podcast feeds.
• Concepts: Understanding how BeyondWords is structured will help you get the most out of it.
• Overview: BeyondWords connects publishers and their audiences through the possibilities of AI voice.
• Quickstart: Learn how to make your first audio article with BeyondWords.
• API: Learn how to use the BeyondWords API
• Content extraction: Content Extraction settings
• Filters: Content filter settings
• Ghost: Integrate BeyondWords with Ghost
• Overview: Easily embed BeyondWords on any web page.
• Support: Frequently asked questions about setting up Magic Embed
• RSS Feed Importer: Turn articles from your RSS feeds into audio.
• Webhooks: Configure and manage webhooks
• Filters
• Plugin Overview: Integrate BeyondWords with WordPress
• Support
• API (Legacy): Migrate from legacy API to current version
• Player (Legacy): Migrate from legacy player to current version
• Custom: Launch direct ads with BeyondWords
• VAST: Connect to an ad server via VAST to serve ads through the BeyondWords player
• Customization: Learn how to customize voices used in BeyondWords.
• Languages: Discover the languages supported across each voice model.
• Overview: An overview of voice options and capabilities in BeyondWords.
• Premade voices: Use premade ElevenLabs voices for audio and video generation.
• Voice cloning: Learn how to create and use voice clones in BeyondWords.
• Voice generation: Create a custom AI voice from a text prompt.

OpenAPI Specs

• swagger
• openapi