Piqae Docs
Reference

API and SDK

Use one small TypeScript client or the same versioned HTTP contract from any backend.

TypeScript

typescript
import {
  PiqaeClient,   // one workspace/environment
  PiqaePlatform, // many customer accounts
  PiqaeError
} from '@piqae/sdk';

HTTP

The native API is JSON over HTTPS under /v1. Platform account management uses only the platform bearer. Tenant operations add the exact workspace and environment selected by server-owned application state. Use Idempotency-Key on mutating requests that may be retried.

Errors

PiqaeError exposes a stable code, HTTP status, request ID, retryable flag, and structured details. Branch on the code, never on the human-readable message. Retry only operations marked retryable and preserve the same idempotency key.

Initial setup remains deliberate

Create, rotate, or revoke the first platform credential with the operator CLI or hosted account setup. Routine customer accounts, nodes, printers, jobs, API keys, webhooks, and usage are API/SDK resources.

Was this page useful?