Oloyid Docs
GitHub Back to site

API Reference

REST API served by FastAPI. Base URL: http://localhost:8000/api/v1. Interactive Swagger UI at /docs and ReDoc at /redoc.

Authentication: All endpoints except /auth/register and /auth/login require a JWT Bearer token in the Authorization header.

Authentication

MethodPathDescription
POST/auth/registerRegister user and organization
POST/auth/loginLogin, returns JWT tokens
POST/auth/refreshRefresh access token
GET/auth/meCurrent user profile

Organizations & Users

MethodPathDescription
GET/organizationsList organizations
GET/organizations/{id}Get organization
GET/usersList users in org
POST/users/inviteInvite user

Policies

MethodPathDescription
GET/policiesList policies
POST/policiesCreate policy
GET/policies/{id}Get policy
PUT/policies/{id}Update policy
DELETE/policies/{id}Delete policy
POST/policies/evaluateEvaluate policy against context
GET/policies/engine/catalogSymbolic rule catalog
GET/policies/engine/chainTenant policy chain

Guardrails

MethodPathDescription
GET/guardrailsList guardrails
GET/guardrails/{id}Get guardrail
PUT/guardrails/{id}/configUpdate config
POST/guardrails/evaluateEvaluate content

Inference (Guardrail Engine)

MethodPathDescription
POST/inference/completionsFull guardrail pipeline + LLM
POST/inference/evaluate-phaseSingle-phase evaluation
GET/inference/guardrailsEngine guardrail registry

HealthShield (HIPAA)

MethodPathDescription
POST/healthshield/activateActivate HIPAA pack
GET/healthshield/activationActivation status
DELETE/healthshield/deactivateDeactivate pack
POST/healthshield/scanScan for PHI
POST/healthshield/inferenceHIPAA-protected inference
POST/healthshield/consentsRecord patient consent
GET/healthshield/audit-logsPHI access audit trail

FinanceShield

MethodPathDescription
POST/financeshield/activateActivate finance pack
GET/financeshield/activationActivation status
POST/financeshield/scanScan financial data
POST/financeshield/inferenceFinance-protected inference
POST/financeshield/data-sourcesRegister data source
GET/financeshield/audit-logsFinancial audit trail

Model Router

MethodPathDescription
GET/model-router/modelsList available models
GET/model-router/routesList routing rules
POST/model-router/routesCreate route
PATCH/model-router/routes/{id}Update route
POST/model-router/selectSelect model for request

Audit Logs & Workflows

MethodPathDescription
GET/audit-logsSearch audit logs
GET/audit-logs/{id}Get audit entry
GET/workflowsList workflows
POST/workflowsCreate workflow
GET/workflows/requests/pendingPending approvals
POST/workflows/requests/{id}/resolveApprove/reject

Error format

{
  "error": {
    "type": "not_found",
    "code": "NOT_FOUND",
    "message": "Policy 'abc' not found",
    "details": {}
  }
}

Roles & permissions

RoleCapabilities
ownerFull access
adminAll except billing
policy_editorPolicies, guardrails, models
approverWorkflow approvals
viewerRead-only