API Reference
The REST API is the fundamental fabric of Helix. All operations and communications between components, and external user commands are REST API calls that the Control Plane handles. For general background information, get familiar with the Helix architecture and the components involved.
With Helix’s API, you can access a wide range of features, including natural language processing, machine learning models, data analysis, and more. Here’s how to get started:
- API Key and Authentication: First, sign up on Helix and obtain your API key from the Account section. The API key is required to authenticate your requests and ensure secure communication between your application and Helix.
All API requests should include your API key in an Authorization HTTP header as follows:
Authorization: Bearer Helix_API_KEYMaking Requests: Use HTTP methods like GET, POST, PUT, and DELETE to interact with the API. Depending on the feature you’re utilizing, you may need to send JSON data, files, or other inputs in your requests.
Handling Responses: The API will return responses in JSON format, containing the results of your request, status codes, and any relevant error messages. Properly handle these responses in your application to ensure smooth operation.
More Information
Get your API key from Account page in the app.
For the rest of the endpoints, see the generated OpenAPI Spec or the code.
Please encourage us to write more on this on Discord!