Skip to main content
@praxa/sdk is the official TypeScript client for the Praxa Integration Gateway. It is credential-free by design: you supply a short-lived delegated OAuth access token at runtime, and the SDK contains no embedded secrets, no provider credentials, and no execution authority. With a single PraxaClient instance you can submit governed AI agent missions, stream their Server-Sent Event lifecycles in real time, search capabilities, query memory, and inspect traces and skills — all against the versioned /v8 API surface.

​
Installation

Install @praxa/sdk with your preferred package manager:

​
Requirements

  • Node.js >= 20 — the SDK relies on the global fetch, ReadableStream, and TextDecoder APIs that ship in Node 20’s runtime.
  • TypeScript (optional but strongly recommended) — the package ships full type declarations generated directly from the canonical OpenAPI contract. You get end-to-end type safety for every request body and response shape.
  • ESM module support — @praxa/sdk is published as an ES module. Your tsconfig.json should target "module": "NodeNext" or "module": "ESNext", and your package.json should include "type": "module" (or use .mts/.mjs file extensions).

​
What’s Included

@praxa/sdk exports everything you need to interact with the Praxa Integration Gateway:
  • PraxaClient — the main client class. Construct one instance per application and call its methods to create missions, stream events, and query the gateway.
  • PraxaClientError — the typed error class thrown for all HTTP error responses. Carries the HTTP status code and an optional RFC 9457 problem object.
  • PraxaClientOptions — the TypeScript type for the constructor configuration object.
  • All generated contract types — CreateMissionRequest, MissionProjection, AuraSseEvent, CapabilityRequirement, CapabilityManifest, MemoryQuery, ResourceBudget, Problem, JsonValue, JsonObject, and more, generated deterministically from the canonical OpenAPI document.
  • PRAXA_CONTRACT_VERSION — the wire-level contract version string sent on every request as the x-aura-contract-version header.
  • PRAXA_OPENAPI_VERSION — the semantic version of the OpenAPI document the SDK was generated from (currently "8.1.0").
  • PRAXA_OPENAPI_SHA256 — the SHA-256 fingerprint of the canonical OpenAPI source, for audit and validation.
  • PRAXA_ROUTE_CONTRACTS — a typed read-only array of every route’s operation ID, HTTP method, path, required OAuth scope, idempotency mode, and response format.

​
Exports

Import the client and error class from the main entry point. Version constants and route-contract metadata are also exported from the same @praxa/sdk package:
You can also import individual generated types for use in your own functions:

​
Contract Versions

The SDK is generated from a versioned OpenAPI document. Three constants let you verify exactly which contract version your installed package implements: You can assert the expected contract version at startup to guard against accidental package upgrades:

PraxaClient Reference

Full constructor options, every method signature, and working code examples.

Mission Events

Stream SSE lifecycle events from a running mission with an async generator.

Error Handling

Catch and inspect PraxaClientError with HTTP status and RFC 9457 problem details.