Skip to main content
This section contains the complete API reference documentation. Make sure you have your API credentials ready to start making requests.

​
Overview

Our API follows RESTful principles and allows you to programmatically access our platform’s core functionality. All API requests are made over HTTPS and return responses in JSON format.

​
Authentication

All API endpoints require authentication using an API key. Include your API key in the x-api-key header: 
x-api-key: YOUR_API_KEY

curl -X GET https://platform.abundant.ai/api/endpoint \
  -H "x-api-key: YOUR_API_KEY"

​
Base URL

All API requests should be made to: 
https://platform.abundant.ai/api/

​
Response Format

Responses are returned in JSON format. A typical successful response looks like: 
{
  "success": true,
  "data": {
    // Response data
  }
}

​
Error Handling

When an error occurs, you’ll receive an appropriate HTTP status code and an error response: 
{
  "success": false,
  "error": {
    "code": "error_code",
    "message": "A descriptive error message"
  }
}