Developer Documentation · OpenAPI 3.0.3

Cloud REST API v2 & TypeScript SDK

Automate document pipelines with idempotency keys, SHA-256 checksums, signed HMAC upload/download grants and hashed pk_live_... API keys. Every POST /api/v2/jobs run deducts flat 1 credit per complete PDF job (zero per-page surcharges; 0 credits on Idempotency-Key retries & XML validation): Business ($39/mo · 15,000 jobs/mo ~680/workday · 5 keys) and Enterprise ($79/mo · 100,000 jobs/mo ~3,330/day at <$0.0008/job · 25 keys).

View API PlansOpenAPI 3.0.3 Spec (/openapi.json)

Quickstart with @pdftools/client-sdk

import { PdfToolsClient } from '@pdftools/client-sdk';

const client = new PdfToolsClient({
  baseUrl: 'https://api.stridepdf.com',
}).withBearerToken(process.env.STRIDEPDF_API_KEY ?? '');

// 1. Inspect tenant quota & Stripe subscription ledger
const account = await client.saas.getAccount();
const invoices = await client.saas.listInvoices();

// 2. Execute any of the 30 verified PDF, image & XML tools via V2 job pipeline
const jobStatus = await client.processing?.get('00000000-0000-4000-8000-000000000001');

Machine-readable contract available at GET /openapi.json. Legacy V1 routes (/api/v1/tools/*) fail closed with unsupported_operation.

REST API v2 Endpoints

  • GET /api/v2/plans · POST /api/v2/contact

    Public discovery of SaaS plan quotas, byte budgets, planned fax tariffs and rate-limited support intake.

  • POST /api/v2/auth/* · GET /api/v2/auth/me

    PBKDF2-SHA-256 authentication, 30-day sessions, single-use password reset tokens and instant account deletion.

  • GET /api/v2/account · /api/v2/api-keys

    Tenant credit telemetry plus creation and revocation of SHA-256-hashed pk_live_... API keys.

  • POST /api/v2/billing/checkout | portal | cancel

    Stripe checkout sessions, Customer Billing Portal links, HMAC webhooks and invoice ledger.

  • POST /api/v2/jobs

    Idempotent job execution for PDF, JPEG, PNG & XML artifacts with signed HMAC upload/download grants.

  • POST /api/v2/einvoice/validate | generate-xml

    Structured EN 16931 (Factur-X / ZUGFeRD / XRechnung) validation and Cross-Industry-Invoice XML generation.

Supported toolId Operations (30 Active)