SDK Reference186 exportsGenerated manifest

Arelis SDK Documentation

Operation-first reference split by SDK surface: Platform API Client for `/api/v1/*` wrappers and Runtime Governance SDK for in-process governed orchestration.

Install and initialize

Start with package install, then create a single shared client instance.

Install (Platform API Client)bash

npm install @arelis-ai/governance-api-client

Install (Runtime Governance SDK)bash

npm install @arelis-ai/arelis-governance-sdk

Initialize the clientTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
  maxRetries: 3,
  timeout: 30_000,
});

Choose your SDK surface

Use Platform API Client for `/api/v1/*` HTTP wrappers. Use Runtime Governance SDK for in-process governance orchestration (models, gates, compliance, and runtime registries).

Initialize the client

For Platform API Client flows, create one ArelisClient instance per process and reuse it for all HTTP operation groups.

Authentication modes

Use `apiKey` for service-to-service workloads and `token` for Firebase user-scoped operations. The client sends either `x-api-key` or `Authorization: Bearer` automatically.

Errors and retries

Request failures throw `ArelisApiError` with RFC 7807 fields (`type`, `title`, `status`, `detail`, `instance`). Retries apply to 429 and 5xx responses plus network errors.

Operation-first navigation

Each client method group page documents signatures, endpoint mapping, request parameters, return contracts, and dual code examples (SDK + REST).

Platform API client

HTTP wrapper operations mapped to `/api/v1/*` endpoints.

Events Proofs Risk Replay Graphs Governance Api Keys Usage Jobs Organization Quotas Billing Metering Telemetry Exports Namespaces Approvals Ai Systems Mcp Servers

Runtime governance SDK

In-process namespaces and capabilities from the published runtime SDK.

Models Agents Mcp Knowledge Prompts Memory Data Sources Approvals Evaluations Quotas Secrets Compliance Governance

Runtime module families

Required runtime module families detected from node_modules/@arelis-ai/arelis-governance-sdk/dist/index.d.ts.

agentsdataSourcesevaluationsknowledgemcpmemorymodelspolicypromptsquotassecretstelemetry-oteltools

Platform support modules

Additional workspace modules used for policy, metering, and audit contracts.

Governance quotas Governance quotas / Milestones Governance quotas / Stripe setup Governance audit Governance core

Stream essentials

Real-time events are exposed through client.stream() over SSE.

stream() signatureTypeScript

stream(options: {
    onEvent: (type: string, data: unknown) => void;
    eventTypes?: string[];
  }): StreamConnection

Path

/api/v1/stream?token={apiKeyOrToken}

Default events

event:created, proof:created, risk:evaluated, replay:completed, policy:updated, usage:updated, key:updated

Config contract

ArelisClientConfig

baseUrl: string

apiKey: string

token: string

maxRetries: number

timeout: number

Error contract

ArelisApiError

Open OpenAPI JSON Open quickstart