REFERENCE

API Documentation

The Aijy Data API is a REST interface served over HTTPS. All requests and responses use JSON.

Base URL

https://api.aijydata.com/v1

Authentication

Every request must include a project key in the Authorization header.

Authorization: Bearer <your-project-key>

Keys are scoped to a workspace. Sandbox keys are prefixed with sk_test_ and never return production data.

Endpoints

MethodPathDescription
GET/datasetsList available datasets
GET/datasets/{id}Retrieve dataset metadata
GET/datasets/{id}/recordsQuery records with filters
GET/statusService status and current API version

Example request

curl "https://api.aijydata.com/v1/datasets?limit=2" \
  -H "Authorization: Bearer $AIJY_KEY"

Example response

{
  "data": [
    { "id": "ds_001", "name": "markets", "region": "us", "updated_at": "2026-11-17T08:00:00Z" },
    { "id": "ds_002", "name": "weather", "region": "eu", "updated_at": "2026-11-17T08:05:00Z" }
  ],
  "next_cursor": null
}

Pagination

List endpoints accept limit (1–100) and cursor. When more results are available, the response includes a non-null next_cursor.

Errors

StatusMeaning
400Malformed request or invalid parameter
401Missing or invalid project key
403Key does not have access to this dataset
429Rate limit exceeded; retry after the window resets
5xxUnexpected server error; retry with backoff

Rate limits

Default limits are 120 requests per minute per key. Higher limits are available on team plans.

Versioning

The API is versioned in the path (/v1). Breaking changes are introduced only in a new major version, with at least six months of overlap.

Questions? Email admin@aijydata.com.