Piqae Docs
Hosted

Print in under ten minutes

Install the SDK, connect a customer, and send a durable PDF job from your server.

Install

Use Piqae Cloud unless you have a specific reason to operate the control plane yourself. Platform keys are server credentials and must never be used in a browser, mobile app, or distributed desktop client.

shell
pnpm add @piqae/sdk

# Server-only secret
PIQAE_PLATFORM_KEY=piq_platform_...

Connect one customer

typescript
import { PiqaePlatform } from '@piqae/sdk';

const piqae = new PiqaePlatform({
  platformKey: process.env.PIQAE_PLATFORM_KEY!
});

const customer = await piqae.accounts.getOrCreate('org_01JQ8K8M6Q', {
  name: 'Northwind Foods',
  metadata: { plan: 'pro' }
});

Print one PDF

typescript
const printer = (await customer.printers.list()).data[0];

const job = await customer.printPdf({
  printerId: printer.id,
  title: 'Order 10428 shipping label',
  pdf: await readFile('./shipping-label.pdf'),
  idempotencyKey: 'northwind-order-10428-label-v1',
  metadata: { order_id: '10428' }
});

Was this page useful?