Overview

The Hyperclast API provides programmatic access to your pages, projects, and organizations.

Base URL

All API endpoints are relative to:

<BASE_URL>/api/v1/

Note: The previous base path /api/ continues to work as a backwards-compatible alias but is not recommended for new integrations.

Authentication

All requests require a bearer token in the Authorization header:

Authorization: Bearer <ACCESS_TOKEN>

Getting your token:

1. Log in to the web app
2. Go to Settings
3. Copy your token from the "Developer" section

Example request:

curl -H "Authorization: Bearer <ACCESS_TOKEN>" \
     <BASE_URL>/api/v1/pages/

Request Format

Include these headers with all requests:

Response Format

Success

Single resource:

{
  "external_id": "abc123",
  "title": "My Page",
  "created": "2025-01-15T10:30:00Z"
}

List (paginated):

{
  "items": [...],
  "count": 42
}

Errors

All error responses (status 400+) use a consistent shape:

{
  "error": "error_code",
  "message": "Human-readable description",
  "detail": null
}

Validation error (422):

{
  "error": "error",
  "message": "An error occurred.",
  "detail": [
    {
      "loc": ["body", "title"],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

Pagination

List endpoints support pagination:

GET /api/v1/pages/?limit=20&offset=40

Timestamps

All timestamps use ISO 8601 format in UTC:

2025-01-15T10:30:00Z

Resources