Skip to main content
This page provides a quick, actionable path to authenticate, call REST endpoints, and capture streaming events from the middleware.

API Structure

The Praxis AI API is organized into three functional areas:

Authenticate

Sign in or authenticate to retrieve an access token.

Runtime

Endpoints for selecting a Digital Twin, creating conversations, developing assistants, and dialoguing with AI models.

Administration

Configure Digital Twins, set up permissions and entitlements, audit user history, and monitor activity.

Getting Started

1

Obtain an authorization token

All API requests require an authorization token issued after successful authentication. See the Authentication API for how to sign in and use the token in requests.
For automation, Admins can use a persistent API key. Interactive sign-in returns a session token that expires after 24 hours — fine for a user session, awkward for a script. Instead, an Admin can create a long-lived API key (format pria_…) from their profile’s API Key settings, store it as a secret, and exchange it for a fresh session token whenever needed:
Use the returned token as the x-access-token header on subsequent requests. The API key itself never expires (rotate or revoke it from the same settings panel), so automation can re-mint a session token on demand without storing user credentials.
API keys are available to Admin accounts and are scoped to that admin’s permissions — the key stops working if the account is deactivated or loses admin access.
2

Know your Base URLs

3

Make a test request

Use your token and send a simple JSON request to verify connectivity and headers.

Using the API

The Praxis API follows standard RESTful conventions:
  • JSON for all requests and responses
  • HTTP status codes communicate success/failure
  • Error responses return a consistent JSON shape with details
  • Rate limits protect service stability
If you’re building a browser client, ensure you include the correct auth header on every request. Authorization tokens are only valid for 24 hours.

Automating with the Live API Definition

Both APIs publish a live OpenAPI 3 (Swagger) definition that always reflects the currently deployed endpoints, schemas, parameters, and auth schemes. These are the exact specs that power this API Reference — fetching them programmatically gives you a machine-readable contract you can hand to code generators, AI coding agents, and orchestration platforms.
Because these URLs serve the live definition, anything you generate from them stays aligned with the deployed API — re-fetch after a Praxis AI release to pick up new endpoints and fields automatically.

Why use the live definition

  • Always current — no hand-maintained endpoint lists to drift out of date.
  • Machine-readable — standard OpenAPI 3 JSON that virtually every tool and agent understands.
  • Self-describing — request/response schemas, required parameters, and auth schemes are all encoded, so tools can scaffold correct calls without guesswork.

Use it with AI coding agents (Claude, Claude Code)

AI coding assistants such as Claude and Claude Code can consume the OpenAPI definition directly to scaffold typed clients, write request code, or build an MCP server that exposes Pria endpoints as tools.
1

Fetch the definition

Download the spec so the agent can read it locally:
2

Point the agent at it

Give the agent the file (or the live URL) and describe what you want. For example:
“Using pria-runtime-openapi.json, generate a typed TypeScript client for the Q&A and conversation endpoints, with x-access-token auth wired in.”
“From this OpenAPI spec, build an MCP server that exposes the Runtime API as tools so I can call Pria from my agent.”
3

Wire in authentication

The spec describes the auth scheme, but the agent still needs a valid token. Supply one from the Authentication API and have the agent attach it as the x-access-token header.
For Claude tool use / function calling, transform each OpenAPI operation into a tool definition so the model can invoke Pria endpoints directly. Most agent frameworks (and Claude Code) can do this automatically from an OpenAPI file or URL.

Import into orchestration platforms

Low-code/iPaaS tools, API clients, and agent frameworks accept an OpenAPI URL or file to auto-generate connectors — no manual endpoint mapping required:
The OpenAPI definition describes every endpoint, but access is still governed by your token’s permissions and entitlements. Administrator API operations require admin credentials — generating a client does not grant access you don’t already hold.

HTTP Streaming with Server-Sent Events (SSE)

Start here. SSE is the recommended way to stream responses for most integrations. It’s a pure HTTP, stateless endpoint with nothing to manage beyond a standard request — ideal for automation, SDKs, and server-side code. Reach for Socket.IO only when you specifically need a persistent, bidirectional real-time connection (typically a browser app).
Praxis AI offers a pure HTTP streaming endpoint using Server-Sent Events (SSE). This approach is ideal for:
  • Server-side applications (Node.js, Python, Go, etc.)
  • Automation, agents, and orchestration tools
  • Environments where WebSockets are restricted
  • Simpler integrations without persistent socket connections
  • SDK and CLI tool development
The SSE streaming endpoint uses the same JWT authentication as other REST endpoints. No Socket.IO connection is required.

Endpoint

Request Headers

Request Body

cURL Example

Use -s to suppress progress output and -N to disable buffering, so SSE chunks appear in real time.

Response Headers

Response Format

The endpoint returns text/event-stream; charset=utf-8 content type with SSE-formatted JSON chunks. Each line is prefixed with data: followed by a JSON object and two newlines. Example SSE Response:
The prompt field on stream events is cumulative (full response up to this point); the delta field contains only the new characters since the last event. Use delta for incremental UI rendering and prompt for the current full text.
thinking events are gated by an institution-level Display Thinking Details toggle (default on). When disabled, no thinking events fire and the underlying History record stores no thinking text. Personal users (no institution) always receive thinking events. Providers that do not expose thinking (Mistral) simply emit no thinking events. OpenAI emits summary-only thinking — OpenAI hides raw chain-of-thought by policy.
Bedrock Opus 4.6/4.7 reasoning is opaque. These models use Anthropic’s adaptive thinking mode, which emits an encrypted reasoning signature only — no plaintext. No thinking events fire and no lightbulb appears in the UI even when the toggle is on. To see plaintext reasoning on Bedrock, use Claude Sonnet 3.7+ or Opus 4.0/4.5 (standard thinking with budget_tokens). Plaintext reasoning is also available on Anthropic Direct API, Google Gemini 2.5+, xAI Grok 3-mini / 4.x, and OpenAI Responses API (summary-only).
Thinking is collected per tool round — each round of model output before/after a tool call gets its own entry, keyed by id (round-0, round-1, …). Intermediate frames within a round are append-only deltas; the round closes with a single done: true frame carrying the authoritative full text and (for Anthropic / Bedrock) a signature used for provider-side multi-step continuation.

Node.js Client Example

Using Fetch API (Browser/Node.js 18+)

Cancelling an HTTP Stream

To cancel an in-flight HTTP stream request, you can abort the fetch request:
The HTTP SSE endpoint is stateless - each request is independent. This makes it ideal for serverless functions, CLI tools, and microservices where maintaining WebSocket connections is impractical.

Comparing Socket.IO vs HTTP SSE


Streaming with Socket.IO

Socket.IO is an alternative to the HTTP SSE method above. Prefer it when you need a persistent, bidirectional real-time connection — for example, an interactive browser client. For automation, SDKs, CLIs, and most server-side integrations, use SSE instead.
You can connect to Praxis AI middleware to receive streaming events while REST requests are in-flight. The server emits stream chunks to your socket; you must include the current socket ID in Q&A requests to link streams to your session.

1 Install the Socket.IO Client

2 Connect and register your user

3 Listen for streaming and diagnostic events

These are typical events payload received from the stream
prompt: Contains the full response from the beginning of the interaction. delta Contains only the last text segment reported type: “STREAM” for messages streamed by the LLM
Note that the final response may differ from the prompt returned while streaming.

Event types

All RECEIVE_STREAM payloads carry a type field. Branch on it to handle each kind:
THINKING — model reasoning stream
THINKING events surface the model’s internal reasoning text (a.k.a. chain-of-thought / “thinking” mode) for the providers that expose it: Anthropic, AWS Bedrock, Google Gemini, OpenAI (summary only — OpenAI hides raw chain-of-thought by policy), and xAI. Mistral does not expose thinking at all and emits no THINKING events. Thinking is collected per tool round — each round of model output before/after a tool call gets its own entry, keyed by id of the form round-0, round-1, etc. Frames within a round are append-only deltas; the round closes with a single done: true frame carrying the authoritative full text and (for Anthropic / Bedrock) a signature for provider-side continuation.
The THINKING stream is gated by an institution-level Display Thinking Details toggle (default on). When the institution disables the toggle, no THINKING events fire and the underlying History record stores no thinking text. Personal users (no institution) always receive thinking events.
Render thinking deltas in a collapsible UI block separate from the main answer — users tend to find the chain-of-thought interesting as context, not as the answer itself. The Praxis UI shows thinking under a 💡 lightbulb <details> toggle.

4 Include socketId in your Q&A API requests

The server requires the active Socket.IO session ID to stream chunks to your client. Include socketId in requestArgs.
If you wrap Q&A calls, pass socketId from your Socket.IO context into the wrapper and expose a stream callback to consume RECEIVE_STREAM chunks.]

5 Manage reconnections

When the QANDA request response includes "streamingFailed": true, it indicates that the middleware has lost the backend Socket ID mapping (user email to client socket ID), preventing it from communicating response chunks back to the client. This typically occurs when multiple browser windows or tabs are open for the same user email, causing them to compete for the same backend session and overwriting each other’s socket registrations. To resolve this issue, you can re-establish the socket connection to re-register the most current client handle and restore proper communication between the middleware and the active client session.

6 Abort requests

To abort a request while executing, emit a cancel_request event:
The cancel_request message signals the controller API to interrupt the ongoing communication and attempt a graceful termination of the conversation. While the controller works to terminate resources cleanly, there may be a slight delay before the process completes. You will only be charged for any partial response generated up to the point of cancellation.

7 Stop streaming the current request

To stop streaming the current response without aborting the request itself, emit a cancel_streaming event:
cancel_streaming applies only to the current response stream and is cleared automatically before the next interaction.

API vs SDK

While the API provides direct access to all capabilities, the TypeScript/JavaScript SDK simplifies most tasks.

API Benefits

• Direct access to all Praxis features
• Language-agnostic integration
• Fine-grained request/response control
• Ideal for custom platforms or gateways, mobile applications

SDK Benefits

• Higher-level abstractions
• Seamless SSO authentication • UI Ready to use
• Supports LMS Such as Canvas, Moodle, D2L, LTI
For most use cases, we recommend using our SDKs, while the API remains available for mobile applications, low-level or platform-neutral integrations.

Error Handling

The API uses standard HTTP status codes:
  • 2xx: Success
  • 4xx: Client error (invalid request, missing parameters, unauthorized)
  • 5xx: Server error
When an error occurs, the JSON body includes details to help diagnose and resolve issues.

Next Steps

Explore endpoint-specific docs:

Authentication

How to authenticate requests and attach tokens.

AI Q&A

Send conversation requests and receive streaming responses.

SSE Streaming

Stream AI responses over HTTP using Server-Sent Events.