Skip to content

GETTING STARTED

API & SDK reference

Authentication, idempotency, typed errors, pagination and exact-revision contracts.

Last updated

Runtime endpoints

POST /v1/behavior/resolve, /v1/traces, /v1/feedback and /v1/outcomes. Every mutation requires Idempotency-Key. Runtime keys are scoped to project, application, environment and capability.

Control endpoints

Teach evidence, candidates, evaluations and deployments require control-plane authorization. Client tokens can write feedback but cannot publish.

Errors

Errors return code, message, requestId and optional safe details. JavaScript and Python SDKs expose ViraApiError. Retry transport and 5xx failures only; reuse the same idempotency key.

RELATED GUIDES

Quick startResolve an exact Behavior revision and attach the resulting trace.Privacy & retentionChoose capture depth, redact PII and execute auditable deletion jobs.Common API errorsLook up public-safe error codes, retry guidance, remediation steps and the support reference to keep.