API
Learn how to use the BeyondWords API
Overview
The BeyondWords API is a RESTful API that provides headless access to the entire platform. It has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Base URL
The base URL for the API is: https://api.beyondwords.io/v1/
Authentication
To access the API endpoints, you will need a Project ID and API Key. To obtain these, you will need to create a project and go to Project > Settings > Integrations > API.
Core Resources
The API provides access to several resources. The primary ones include:
Projects
This object represents your project and its settings. You can list, create, retrieve, update and delete projects.
Content
This object represents your generated content and its associated metadata. You can list, create, retrieve, update and delete content.
Player
You can use the API to retrieve audio and player configurations. The Player endpoints allow you to fetch player data using different identifiers such as:
- Content ID
- Source ID
- Source URL
- Playlist ID
- Multiple identifiers
Analytics
You can use the API to retrieve analytics for an organization, project, content item, or ad. You can retrieve data for a specific time period and aggregate by year, month, week, day, or hour. You can also filter the data based on specific metrics.
Languages
You can use the API to retrieve a list of languages available on your account, along with their locale codes.
Voices
You can use the API to retrieve a list of voices available on your account. You can also use this endpoint to configure settings for each voice.
Upload
You can use the API to upload media files, such as images and videos, for submitting to image and media URLs.
Additional Resources
For complete API documentation, please refer to our API Reference.