Overview

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

Base URL

All API endpoints are relative to:

<BASE_URL>/api/

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/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

Error format:

{ "message": "Error description" }

Pagination

List endpoints support pagination:

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

Timestamps

All timestamps use ISO 8601 format in UTC:

2025-01-15T10:30:00Z

Resources