Skip to main content

Last updated:

API Documentation

Reference for the API gateway service. All paths below are relative to your gateway base URL (e.g. https://api.your-deployment.example)—not under a generic /api prefix.

Developers & AI agentsREST today; MCP tool exposure on the roadmap.

Request Enterprise AccessView CapabilitiesIntegration GuideMCP roadmap

Enterprise API Access

API Access Requires Enterprise Subscription

IntelliHuman AVI API is available to enterprise customers with active subscriptions. Full API documentation, authentication credentials, and integration support are provided after enterprise access is granted.

Integration Methods

REST API (available)

Today

Production routes on the API gateway: /ask, cases, ingest, audit, identity, catalog, integrations, SME APIs, and more. Authenticate per your deployment (API keys, tokens, etc.).

  • POST /ask for grounded Q&A with citations & audit_id
  • Case ingest, process, decision, override
  • Audit export and audit event lookup
  • Document ingest and catalog APIs
Jump to section

OAuth source connectors (available)

Today

Gateway routes for OAuth initiation and callbacks (e.g. Microsoft, Google, Salesforce) to connect enterprise data sources—scope varies by environment.

  • POST /oauth/initiate
  • Callbacks under /oauth/callback/*
  • Integration CRUD under /integrations
Learn more

MCP & agent tools (roadmap)

Roadmap

Model Context Protocol exposure so agents (OpenAI, Copilot, Claude, Gemini, custom) call IntelliHuman as a standard tool—with the same audit and tenancy model.

  • Discoverable tool schemas
  • Judgment / escalation patterns
  • Aligns with enterprise MCP rollout
Learn more

Webhooks & packaged connectors (roadmap)

Roadmap

Event subscriptions and first-party packaged connectors to CRM, EHR, and ITSM systems—scoped with customers during enterprise onboarding.

  • Outbound events for decisions and workflow state
  • Partner-built or IntelliHuman-maintained connectors
  • Discuss timelines on enterprise access
Learn more

API Capabilities

Selected routes implemented on the api-gateway. Many additional endpoints exist (identity, catalog, SME, notifications, layer indexing)—request full details with enterprise access.

Knowledge query (RAG + model)

POST /ask

Main Q&A: retrieval orchestration, reasoning coordinator, model generation. Returns answer, citations, retrieval_trace, model_used, query_id, conversation_id, audit_id.

Enterprise / deployment authEnterprise Only

Health check

GET /health

Liveness endpoint for monitors and load balancers.

NoneEnterprise Only

Ingest case

POST /cases/ingest

Submit a case payload for downstream processing.

Enterprise / deployment authEnterprise Only

Process case

POST /cases/:id/process

Run retrieval, models, and rules for a case; persists decision and audit event.

Enterprise / deployment authEnterprise Only

Get case decision

GET /cases/:id/decision

Retrieve the latest structured decision for a case.

Enterprise / deployment authEnterprise Only

Override decision (human)

POST /cases/:id/decision/override

Append-only override with reasoning; links audit trail to prior decision.

Enterprise / deployment authEnterprise Only

Compliance export

GET /audit/export

Export audit-oriented data for governance (see deployment for query params and scope).

Enterprise / deployment authEnterprise Only

Audit event by audit id

GET /audit/events/:auditId

Fetch a single immutable audit event by human-readable audit_id.

Enterprise / deployment authEnterprise Only

Full API documentation, authentication credentials, and integration support are provided to enterprise customers after access is granted.

Request Enterprise Access

Authentication & Security

Enterprise-grade authentication methods ensure secure API access for your organization.

API Key / headers

Server-to-server auth as configured for your deployment (e.g. API keys or gateway middleware).

Per deployment (e.g. X-API-Key or Bearer)

OAuth 2.0 (integrations)

OAuth flows for connecting external systems (Microsoft, Google, Salesforce, etc.) via gateway routes—not the same as end-user SSO for every API call.

Authorization: Bearer <token> (per integration docs)

Enterprise SSO

SAML/OIDC for workforce access may be configured for portals and admin surfaces; confirm with your implementation team.

IdP-specific

Authentication credentials and detailed implementation guides are provided to enterprise customers.

Get Enterprise Access

Integration Capabilities

IntelliHuman AVI provides enterprise API access for integrating with your systems, workflows, and AI agents. Available features include:

REST: POST /ask with citations, retrieval_trace, audit_id

Case and audit APIs for defensible workflows

OAuth-backed connectors for enterprise data sources

OpenAPI/spec slices available to enterprise customers

MCP agent tools: see Developers page (roadmap)

Webhooks: roadmap—coordinate with enterprise onboarding

View Integration GuideAgents & MCPRequest Access

Ready to Integrate?

Enterprise API access is available to customers with active subscriptions. Request access to get started.

Get API AccessIntegration Support