For Agents
Create and terminate conversational AI sessions in Diarupt and list available faces and AI profiles for the session.
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Diarupt Engine API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
What an agent can do with Diarupt Engine API.
Start a new conversation session against a chosen face and profile
Terminate an active session cleanly when the interaction ends
Look up the status of a single session by ID
GET STARTED
Use for: I need to create a new Diarupt conversation session, List all currently active Diarupt sessions, Get the status of a specific session by ID, Terminate a session when the user closes the window
Not supported: Does not handle text-only chat, model fine-tuning, or video recording — use for managing Diarupt conversational AI session lifecycle and listing available faces and profiles only.
Jentic publishes the only available OpenAPI specification for Diarupt Engine API, keeping it validated and agent-ready. Diarupt provides a conversational AI engine for video-style interactions, exposing endpoints to create and terminate conversation sessions, list active sessions, and pull catalogues of available faces and AI profiles. Product teams use it to embed branded AI characters into their apps without running their own avatar pipeline. The 6-endpoint surface keeps integration shallow while covering the full session lifecycle.
List all active or recent sessions for monitoring and audit
Inspect available faces and AI profiles before creating a session
Patterns agents use Diarupt Engine API for, with concrete tasks.
★ Embedded Conversational AI Session
When a user opens the in-app AI assistant, the agent calls POST /create-session to start a Diarupt session bound to a chosen face and profile. The session ID is returned to the front-end so the conversational widget can render. Closing the widget triggers POST /terminate-session/{session_id} to release server resources.
Create a session with face_id 'aria' and profile_id 'support-bot' and return the new session_id
Session Inventory and Cleanup
Periodically list active sessions via GET /sessions and terminate any that have idled past a threshold. This avoids dangling sessions accumulating against the account quota and keeps cost predictable.
List all sessions and terminate any whose last activity is more than 30 minutes ago
Catalog Lookup Before Session Creation
Use GET /faces and GET /profiles to surface the available avatars and AI configurations to the user before they start a session. This lets product teams expose Diarupt's options dynamically rather than hard-coding face IDs into the front-end.
Return the list of available faces and profiles so the UI can present them to the user
Agent-Driven Conversational Onboarding
An AI orchestrator searches Jentic for 'create a conversational ai session', loads the Diarupt POST /create-session schema, and starts a session for the user inside an onboarding flow. The same agent terminates the session on flow completion. Wiring the avatar into a broader agent workflow becomes one or two intent searches rather than custom Diarupt SDK code.
On user request 'start the AI onboarding', create a Diarupt session with the default profile and store the session_id in the user's record
6 endpoints — jentic publishes the only available openapi specification for diarupt engine api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
/create-session
Create a conversation session
/terminate-session/{session_id}
Terminate a session
/session/{session_id}
Get a session by ID
/sessions
List all sessions
/faces
List available faces
/profiles
List AI profiles
/create-session
Create a conversation session
/terminate-session/{session_id}
Terminate a session
/session/{session_id}
Get a session by ID
/sessions
List all sessions
/faces
List available faces
Three things that make agents converge on Jentic-routed access.
Credential isolation
Diarupt API keys are stored encrypted in the Jentic vault and applied at execution time. The agent never sees the raw key in its context.
Intent-based discovery
Agents search intents like 'create a conversational AI session' and Jentic returns the matching Diarupt operation with its input schema.
Time to first call
Direct Diarupt integration: a few hours for auth, session lifecycle, and face/profile lookups. Through Jentic: under 30 minutes — search, load, execute.
Alternatives and complements available in the Jentic catalogue.
Specific to using Diarupt Engine API through Jentic.
Why is there no official OpenAPI spec for Diarupt Engine API?
Diarupt does not publish a public OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Diarupt Engine API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.
What authentication does the Diarupt Engine API use?
The API uses an API key via the `apiKeyAuth` scheme. Through Jentic, the key is stored encrypted in the vault and supplied to requests at execution time so the raw value never enters the agent's prompt.
Can I create a conversational AI session via the API?
Yes. POST /create-session starts a session bound to a chosen face and profile and returns a session_id. The front-end uses that ID to wire up the conversational widget.
How do I list available faces and profiles?
GET /faces returns all available avatar faces and GET /profiles returns the preconfigured AI profiles. Most apps surface these to users so they can pick a persona before starting a session.
What are the rate limits for the Diarupt Engine API?
The OpenAPI spec does not declare rate limits. Diarupt enforces per-account session quotas in production; back off on HTTP 429 responses and confirm exact limits with their support team.
How do I create a session through Jentic?
Run `pip install jentic`, search 'create a diarupt conversation session', and Jentic returns POST /create-session with its input schema. The agent supplies the face and profile IDs and executes against base URL https://engine.diarupt.ai.
/profiles
List AI profiles