Boreal.ai
Back to home
API Reference

API Reference

Complete reference for the Boreal.AI REST API. Authenticate, query, and integrate.

Base URL

https://api.borealtech.solutions/v1

Authentication

All API requests require a Bearer token in the Authorization header. Generate your API key from the dashboard under Settings > API Keys.

curl -X GET https://api.borealtech.solutions/v1/sources \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Endpoints

Available API endpoints grouped by resource category.

Data Sources

GET/sourcesList all connected data sources
POST/sourcesConnect a new data source
DELETE/sources/:idRemove a data source by ID

Analytics

GET/analytics/overviewGet analytics overview and summary
GET/analytics/reports/:idRetrieve a specific report by ID
POST/analytics/queryExecute a custom analytics query

Models

GET/modelsList all available AI models
POST/models/:id/predictRun a prediction on a model
GET/models/:id/metricsGet performance metrics for a model

Webhooks

POST/webhooksRegister a new webhook endpoint
DELETE/webhooks/:idRemove a webhook by ID

Rate Limits

API rate limits vary by plan. Exceeding the limit returns a 429 status code. Rate limits reset every minute.

100/min
Starter
1,000/min
Professional
10,000/min
Enterprise

Error Codes

CodeNameDescription
400Bad RequestThe request body is malformed or missing required fields.
401UnauthorizedInvalid or missing API key.
403ForbiddenYour API key does not have permission for this resource.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded. Wait before retrying.
500Internal Server ErrorAn unexpected error occurred. Contact support if it persists.