API Reference

The Hypersave API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

All API requests should be made to:

https://api.hypersave.io

Endpoints Overview

Request Format

All requests must include the following headers:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Response Format

All responses follow a consistent format:

{
  "success": true,
  "data": { ... },
  "message": "Operation completed successfully"
}

Error Response

{
  "success": false,
  "error": "Error code",
  "message": "Human-readable error message",
  "details": { ... }
}

HTTP Status Codes

Rate Limits

Rate limits vary by plan:

When you exceed your rate limit, you'll receive a 429 response with a Retry-After header.

Pagination

List endpoints support pagination using limit and offset parameters:

GET /v1/memories?limit=20&offset=40

Response includes pagination metadata:

{
  "success": true,
  "data": [...],
  "pagination": {
    "limit": 20,
    "offset": 40,
    "total": 150,
    "hasMore": true
  }
}