Partner API#

The Partner API lets partners distribute free trials of NucleI to their own users. A partner creates a referral link (or generates one programmatically with an API key), shares it, and end-users claim a trial through that link — which creates their account and issues a time-limited license in a single step.

Base URL#

https://api.terraquant.tech/api

All paths on this page are relative to that base URL. For example, the full URL for POST /partner/trial/claim is https://api.terraquant.tech/api/partner/trial/claim.

Who calls what#

The API has three kinds of consumers, each with its own authentication:

Consumer	Auth	Typical endpoints
Logged-in partner (dashboard / scripts)	JWT Bearer token	Manage referral links and API keys
Partner automation (servers, integrations)	`X-API-Key` header	Create referral links programmatically
End-user (public, no account yet)	None (rate-limited)	Validate a code, claim a trial

See Authentication for details on each mode.

Typical flow#

sequenceDiagram
    participant P as Partner
    participant API as Partner API
    participant U as End-user
    P->>API: POST /partner/referral-links
    API-->>P: referral link (code + url)
    P->>U: Share trial URL
    U->>API: GET /partner/referral/{code}/validate
    API-->>U: valid + trial duration
    U->>API: POST /partner/trial/claim
    API-->>U: account + license key + JWT tokens

Pages#

Page	Contents
Authentication	JWT, API keys, and public access
Referral Links & API Keys	Create, list, and revoke links and keys
Trial Claim	Public endpoints end-users hit to claim a trial
Errors	Status codes and error messages