Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

API Overview

Optra Prism exposes two backend services with REST APIs.

ServicePurpose
IngestReceives OTLP telemetry (logs, metrics, traces)
Prism EngineQueries telemetry, scoring, intelligence, insights
ServiceBase URL
Ingesthttps://ingest.prism.optra-ai.com
EngineInternal (private)

The engine is not publicly exposed in deployed environments — the dashboard reaches it over internal networking, and a small subset of engine endpoints (/v1/telemetry/logs, /v1/insights/report, /v1/insights/report/generate) are proxied out through the ingest service for plugin / external callers.

See Authentication for details on API key usage.

All endpoints return JSON, but the response shape varies per endpoint — there is no uniform envelope. For example, /v1/intelligence/worst-prompts returns { "prompts": [...], "total": N }, while /prism/promptiq/score returns a PromptIqResult object directly. See the individual endpoint pages for concrete shapes.

Errors use a consistent shape in both services:

{
"code": 401,
"message": "Invalid API key"
}

Common (both services):

CodeMeaning
200Success
400Bad request (validation error)
401Unauthorized (missing or invalid API key)
500Internal server error

Ingest-only:

CodeMeaning
413Payload too large (OTLP body exceeds limit)
503Service unavailable — NATS backpressure; response includes Retry-After: 5