Skip to main content

API Reference

Programmatic access to Digital Twin core capabilities via REST.

Overview​

Viven exposes a REST API for querying twins, managing tokens, and integrating Digital Twin into custom apps and workflows.

Authenticate API requests with a Personal Access Token (PAT) for user-owned access, or a Service Account Token (SAT) for admin-managed, server-side automation.

When to use the API​

  1. Custom integrations — Embed twin Q&A in an internal portal, chatbot, or agent framework.
  2. Server-side automation — Run workflows on behalf of users with an SAT and the dt-viven-user impersonation header.
  3. Programmatic token management — Orchestrate PAT or SAT creation and revocation from your own admin tooling.

For MCP-based integrations (Cursor, Claude Desktop, custom MCP clients), see MCP Reference.

Detailed endpoint documentation​

For full OpenAPI documentation — endpoints, request/response schemas, and authentication details — go to your Viven instance → Apps → API Server and open View API Docs.

Endpoint reference is instance-specific and lives with your deployment.