API Documentation
Last updated October 21, 2024
API Documentation for Exactly.ai
Welcome to the API documentation for Exactly.ai. This guide is designed to help developers and technical users understand how to effectively use the Exactly.ai API to integrate our AI capabilities into your own applications.
The Exactly.ai API allows you to harness our powerful AI services, enabling you to automate processes, analyze data, and enhance your applications. In this documentation, you will find detailed instructions on how to authenticate, utilize various endpoints, and handle responses.
Getting Started
To start using the Exactly.ai API, follow these steps:
- 1. **Sign Up for an API Key**: Visit the Exactly.ai website and create an account. Once registered, navigate to the API section in your account settings to generate your unique API key.
- 2. **Read the API Documentation**: Familiarize yourself with the API endpoints, request structures, and response formats provided in this documentation.
- 3. **Make Your First API Call**: Use a tool like Postman or cURL to test the API. Ensure you pass your API key in the headers.
Authentication
All API requests require authentication using your API key. Please include the API key in the headers of each request as shown below:
Example:
API Endpoints
Here are some of the main endpoints available in the Exactly.ai API:
- 1. **/api/v1/analyze**: This endpoint allows you to submit data for analysis.
- 2. **/api/v1/results**: Use this endpoint to retrieve the results for your submitted analyses.
- 3. **/api/v1/status**: Check the current status of your API usage and limits.
Handling Responses
API responses are returned in JSON format. Each response includes a status code and a message indicating the outcome of the request.
Here's an example of a typical response:
Support and Resources
For additional support or questions about the API, please contact our support team via the help center or consult the community forums.
We hope you find this documentation helpful and look forward to seeing how you leverage Exactly.ai in your applications!