Delphi Documentation

website·Indexed 30 days ago

https://docs.delphi.ki-kombinat.com

Documentation for the Delphi voice product platform, including the Flow Designer visual editor, TelAPI (0.9.17-patch1) for WebRTC and webhook integration, and the Delphi SDK. Covers platform administration, AI vendor provider configuration (OpenAI, Azure, Pythia, TOBi), and infrastructure management via the Ops service.

Tokens
1.1M
Snippets
2.8K
Records
7.9K
Agent score
37%

What's inside Delphi

  1. Overview of Browser Actions (BOA) for AI-driven UI flows

    Browser Actions (BOA) are used to handle AI-driven UI side-flows within the Delphi SDK. They enable the AI to trigger specific browser-level operations such as navigation, displaying alerts, copying text to the clipboard, and executing custom handlers with support for asynchronous results.
  2. Overview of TelAPI surfaces and authentication

    TelAPI is the REST and WebSocket gateway for the Delphi platform. It consists of three distinct surfaces with different authentication and gating requirements:

    1. Health check: Publicly accessible endpoint used by load balancers and probes.
    2. Async LLM webhooks: Inbound endpoints for external async LLM/tool providers. Uses a per-callback token model and is enabled for LLM-flow tenants.
    3. Browser & SDK API: The primary interface for backends and browser/mobile clients. Requires an API key with specific scopes (bearer token) and is gated by the webrtc feature flag (which controls the entire surface, not just voice calls).
    GET /health
    POST /api/v1/webhooks/*
    GET /api/v1/* (Browser & SDK API)
  3. Overview of Flow Designer Inspectors

    Inspectors are the right-panel editors in the Flow Designer that open upon clicking elements on the canvas. They provide specialized interfaces for configuring different components of a flow, including:

    • Node Inspector: Configure specific node properties.
    • Endpoint Inspector: Manage endpoint settings.
    • Flow Settings: Global configuration for the flow.
    • Provider Editor: Manage external providers.
    • Variable Catalogue: Access and manage flow variables.
    • Version History: View and manage previous versions of the flow.
  4. Overview of the Flow Designer interface

    The Flow Designer is the primary visual editor for an app, used to wire up endpoints, configure providers, edit nodes, run test calls, and publish flows. It is located at the path /apps/{appId}/flows/builder.

    Key interface areas include:

    • Canvas: A React Flow graph visualizing the session path from AI conversation to termination. It contains both executable flow nodes and virtual structural nodes.
    • Toolbar: Provides access to test calls, publishing, source view (JSON), version history, import/export, and flow settings.
    • Right-panel inspector: A context-sensitive panel that opens when clicking a node, edge, or endpoint.
    • AI Flow Builder panel: An optional natural language interface for briefing and drafting flows.
  5. Overview of the TelAPI service instance

    The API service runs the TelAPI server, a Fastify-based HTTP and WebSocket API responsible for handling call tokens, browser-to-ARI channel communication, and external API endpoints. The service is scalable and operates within a private network without public IP addresses; all incoming traffic is routed through a managed load balancer.
  6. Overview of SigNoz telemetry integration in Delphi

    SigNoz serves as the central observability platform for Delphi deployments. Every service host runs an OpenTelemetry (OTel) collector that forwards telemetry to the SigNoz service.

    Connectivity Details:

    • OTLP gRPC: 10.0.1.10:4317
    • OTLP HTTP: 10.0.1.10:4318
    • UI Access: Exposed via Caddy proxy at https://${DOMAIN_SIGNOZ}

    Telemetry Signals:

    • Traces: Used to follow requests end-to-end (e.g., TelAPI WebSocket lifecycle, TelPhi conversation spans).
    • Logs: Application logs and structured JSON from TelPro/TelSys/RTPEngine for failure searching by service, trace ID, or call ID.
    • Metrics: Container resource usage (CPU/Memory), request/error rates, and ClickHouse storage health.
    • SIP / Call Spans: Debugging call setup, routing, and audio issues via Kamailio SIP ladders and RTPEngine stats.
  7. Overview of the Flow Designer interface

    The Flow Designer is the primary visual editor for an app, used to configure endpoints, providers, nodes, and publish flows. It is located at the path /apps/{appId}/flows/builder. The interface consists of the following key areas:

    • Canvas: A React Flow graph visualizing the session path from AI conversation to termination, combining structural and executable nodes.
    • Toolbar: Provides access to test calls, publishing, source view, version history, import/export, and flow settings.
    • Right-panel inspector: A context-sensitive panel that opens when clicking a node, edge, or endpoint.
    • AI Flow Builder panel: An optional natural language interface for briefing and drafting flows.
  8. Overview of the Delphi Dashboard

    The Delphi Dashboard provides a customizable analytics overview tailored per team. It features a set of analytics widgets, a timeframe toolbar for filtering data, and an edit mode for customizing the layout and content of the dashboard.
  9. Overview of the Flow Designer interface

    The Flow Designer is the primary visual editor for an app, located at /apps/{appId}/flows/builder. It is used to wire up endpoints, configure providers, edit nodes, run test calls, and publish flows. The interface consists of the following key areas:

    • Canvas: A React Flow graph displaying the session path from AI conversation to termination, mixing virtual structural nodes and real flow nodes.
    • Toolbar: Provides access to test calls, publishing, source view, version history, import/export, and flow settings.
    • Right-panel inspector: A context-sensitive panel that opens when clicking a node, edge, or endpoint.
    • AI Flow Builder panel: An optional top panel for briefing the flow using natural language.
  10. Overview of TelAPI Browser and Mobile Client Surface

    The browser and mobile client surface of TelAPI provides the necessary endpoints for API-key authentication, call-token minting, app discovery, and the WebSocket channel. This surface is gated by the webrtc platform flag; if this flag is disabled, only the /health and async LLM webhooks endpoints remain functional.
  11. Overview of Team Subscription Management

    The team subscription dashboard is located at /settings → My Subscription tab. It provides a comprehensive view of the team's plan, current usage, billing, and plan management, integrating directly with Stripe. Key fields in the subscription overview include Plan Name, Status (e.g., active, past_due), Price, User Count, Billing Period, Overage Rate, Spending Cap, and Customer Since date.
  12. Overview of SigNoz monitoring in Delphi

    Delphi services utilize OpenTelemetry (OTel) collectors to send observability data to SigNoz. The data transmitted includes logs, traces, metrics, health signals, and call debugging data.