API Reference

Learn about the BeyondWords API

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/

Authentication

To access the API endpoints, you will need a Project ID and API Key. To obtain these, you will need to create a BeyondWords account and create a project.

Your API key carries many privileges, so be sure to safeguard it against unauthorized access! Do not share your API key in in any publicly accessible places, such as in your client-side code or on GitHub

Please note that all API requests must be made using HTTPS to ensure the security of your data. Requests made over plain HTTP will fail, and requests without proper authentication will also be rejected.