Docs + Guides
Architecture, governance, and integration guidance for the Dailogue platform. Start here to understand scope hierarchy, authorization, and configuration patterns before moving to the API Reference for endpoint contracts.
Choose the right surface
At a glance
Reading order: 1) Quickstart, 2) capability and ecosystem choices, 3) governance and evaluation controls, 4) move to reference for request/response contracts.
Start from platform controls, then move into curated reference details.
1. Authenticate
Use tenant-scoped credentials and role policies to access approved API surfaces.
2. Configure a workload
Select model routing, RAG profile, and agent policies by tenant and application context.
3. Observe and improve
Track groundedness, relevance, and latency signals to continuously optimize outcomes.
Authorization model
Dailogue uses a WHO/TARGET header contract: WHO headers (X-Application-Tenant-Id, X-Application-Id) identify the calling application, and TARGET headers (X-Target-Tenant-Id, X-Target-Tenant-Scope) scope which tenant's data to access. Every API call requires both sets.
Run a retrieval search
Execute a tenant-scoped hybrid retrieval query with the WHO/TARGET authorization contract.
curl -X POST https://api.dailogue.ai/api/v2/retrieval/search \
-H "Authorization: Bearer <token>" \
-H "X-Application-Tenant-Id: <app-tenant-id>" \
-H "X-Application-Id: <app-entity-id>" \
-H "X-Target-Tenant-Id: <target-tenant-id>" \
-H "X-Target-Tenant-Scope: customer" \
-H "Content-Type: application/json" \
-d '{"query": "ESG reporting requirements", "strategy": "hybrid_rerank", "topK": 5}'Response
{
"results": [
{
"document_id": "doc_8f3a...",
"content": "Q4 ESG reporting requires disclosure of ...",
"score": 0.94,
"metadata": { "source": "policy-library", "tenant_id": "..." }
}
],
"strategy_used": "hybrid_rerank",
"total_results": 5
}import httpx
resp = httpx.post(
"https://api.dailogue.ai/api/v2/retrieval/search",
headers={
"Authorization": "Bearer <token>",
"X-Application-Tenant-Id": "<app-tenant-id>",
"X-Application-Id": "<app-entity-id>",
"X-Target-Tenant-Id": "<target-tenant-id>",
"X-Target-Tenant-Scope": "customer",
},
json={"query": "ESG reporting requirements", "strategy": "hybrid_rerank", "topK": 5},
)
print(resp.json())const resp = await fetch(
"https://api.dailogue.ai/api/v2/retrieval/search",
{
method: "POST",
headers: {
"Authorization": "Bearer <token>",
"X-Application-Tenant-Id": "<app-tenant-id>",
"X-Application-Id": "<app-entity-id>",
"X-Target-Tenant-Id": "<target-tenant-id>",
"X-Target-Tenant-Scope": "customer",
"Content-Type": "application/json",
},
body: JSON.stringify({
query: "ESG reporting requirements",
strategy: "hybrid_rerank",
topK: 5,
}),
}
);
console.log(await resp.json());Built for product, engineering, and AI teams adopting enterprise GenAI systems with configurable control surfaces.
Agentic Execution
Orchestrate workflows across four runtime providers with approvals and SSE observability.
RAG Orchestration
Configure retrieval quality with 17 strategies and adaptive selection.
LLM and Observability
Route to 100+ models with tenant-scoped policies and end-to-end tracing.
The platform supports configurable providers and libraries through policy controls, not ecosystem rewrites.
| Layer | Configurable Choices | Example Providers/Libraries | Selection Policy |
|---|---|---|---|
| Agent Orchestration | Workflow graph, tool permissions, approval checkpoints, MCP protocol | LangGraph, OpenAI Agents, Google ADK, Claude Agent SDK | Capability-aware selection for governed multi-step automation |
| Retrieval Stack | Semantic, lexical, hybrid retrieval, contextual compression, adaptive selection | Hybrid RRF, SPLADE, ColBERT, HyDE, RAG fusion | Balance recall and precision by tenant/application policy |
| Model Routing | Provider routing, model family, fallback policy, guardrails | OpenAI, Anthropic Claude, Google Gemini, Azure, Mistral via LiteLLM | Optimize by cost, quality, and latency profile per workload |
| Embeddings and Reranking | Embedding model, reranker strategy, cross-encoder stage | Voyage rerankers, provider-native rerank, policy-selected rerank pipelines | Raise retrieval precision for high-risk or regulated outputs |
Configure retrieval and grounding policies by vertical, tenant, and application requirements.
Semantic Retrieval
Vector-first retrieval for concept-level matches across long enterprise content.
When to use: Use for knowledge-heavy workloads where meaning is more important than exact keyword match.
Tradeoff: Higher recall, may need reranking to improve precision.
Hybrid Retrieval
Combine semantic retrieval with lexical search for stronger recall and precision.
When to use: Use for legal, compliance, and reporting flows that require both intent and exact term coverage.
Tradeoff: More configuration and runtime complexity, better groundedness outcomes.
Reranking and Cross-Encoder Stage
Apply a second-stage relevance ranker to tighten top-k evidence quality.
When to use: Use for customer-facing and compliance-critical outputs where precision matters most.
Tradeoff: Adds latency/cost, significantly improves relevance quality.
Query Understanding
Rewrite, decompose, and classify queries before retrieval execution.
When to use: Use for ambiguous, multi-part, or domain-specific user questions.
Tradeoff: Extra orchestration step, improves retrieval targeting.
Groundedness Controls
Attach citation and grounding policies to generation and approval flows.
When to use: Use when outputs are compliance-sensitive, auditable, or externally published.
Tradeoff: Can reduce generation flexibility, improves trust and auditability.
Reciprocal Rank Fusion (RRF)
Merge ranked lists from multiple retrieval sources using reciprocal rank scoring.
When to use: Use when combining dense and sparse retrieval signals for higher recall.
Tradeoff: Simple fusion, no trainable parameters — may not capture nuanced relevance.
Adaptive Strategy Selection
Automatically select the best retrieval strategy per query based on performance history.
When to use: Use when query types vary widely and no single strategy dominates.
Tradeoff: Requires performance tracking data; cold-start defaults to hybrid.
Hypothetical Document Embeddings (HyDE)
Generate a hypothetical answer, embed it, and use the embedding to retrieve real documents.
When to use: Use for abstract or exploratory queries where direct embedding yields poor recall.
Tradeoff: Extra LLM call per query increases latency and cost.
Controls inherit across the canonical hierarchy: platform → application → customer → organization → project. WHO headers identify the actor and TARGET headers identify the operated scope.
| Scope | What You Configure | Operational Outcome |
|---|---|---|
| Platform | Global model policy, safety baselines, observability defaults, and audit controls | Consistent governance guardrails for every downstream tenant scope |
| Application | Application-level routing policy, prompt bundles, and tool boundary defaults | Shared vertical controls without duplicating service code |
| Customer | Customer policy overlays for RAG thresholds, quality targets, and data boundaries | Per-customer control while preserving application defaults |
| Organization | Organization-level workflow approvals, review policy, and publication guardrails | Department-level governance for regulated output paths |
| Project | Project runtime tuning for prompts, retrieval strategy, and execution checkpoints | Fine-grained optimization for delivery teams and workloads |
Platform
Set default model safety baseline and required groundedness checks.
Consistent compliance guardrails across all tenants and applications.
Application + Customer
Switch retrieval profile to hybrid + reranking for legal tenants.
Domain-specific quality gains without branching platform code.
Organization + Project
Tune query understanding and agent approvals for newsletter publication by team.
Faster iteration per product workflow with governed automation.
Enterprise adoption requires grounded outputs, measurable quality, and operational traceability.
Groundedness Scorecards
Track groundedness and citation quality across workloads and release cycles.
Retrieval Quality Monitoring
Measure relevance, recall, and rerank lift to catch drift before it impacts users.
End-to-End Execution Traces
Trace ingest, process, retrieve, and generate stages for root-cause analysis.
Policy and Approval Audit Trail
Maintain tenant-aware logs for workflow approvals and regulated outputs.
Workflow execution progresses through defined states with approval checkpoints and failure handling.
Execution States
| State | Description |
|---|---|
pending | Execution request received and queued for provider dispatch. |
running | Active execution across the selected runtime provider (LangGraph, OpenAI Agents, Google ADK, or Claude Agent SDK). |
paused | Execution paused at a human-in-the-loop checkpoint or awaiting checkpoint resume. Transitions to running on approval, or to cancelled/failed on deny or timeout. |
completed | Execution finished successfully. Results available via the execution detail endpoint. |
failed | Execution encountered an unrecoverable error. Failure details attached to the execution record. |
cancelled | Execution cancelled by operator action or system timeout. |
Approval Lifecycle
| State | Description |
|---|---|
requested | Approval checkpoint reached. Execution is paused until an operator responds. |
approved | Operator approved the checkpoint. Execution resumes from the paused state. |
denied | Operator denied the checkpoint. Execution transitions to failed or cancelled. |
expired | Approval window elapsed without operator action. Configurable timeout policy determines the resulting execution state. |
Curated operation groups for internal reference. Full endpoint surface available via internal API explorer.
| Group | Operations | Status |
|---|---|---|
| Platform Health | 1 | Internal GA |
| Agentic | 1 | Internal Preview |
| Retrieval (RAG) | 1 | Internal Preview |
| LLM | 1 | Internal GA |
| Ingestion | 3 | Internal GA |
| Processing | 1 | Internal GA |
| Storage | 1 | Internal GA |
Common integration patterns using the Dailogue API with WHO/TARGET authorization headers.
Execute Agentic Workflow
curl -X POST https://api.dailogue.ai/api/v2/agentic/workflows/{workflow_id}/execute \
-H "Authorization: Bearer <token>" \
-H "X-Application-Tenant-Id: <app-tenant-id>" \
-H "X-Application-Id: <app-entity-id>" \
-H "X-Target-Tenant-Id: <target-tenant-id>" \
-H "X-Target-Tenant-Scope: application" \
-H "Content-Type: application/json" \
-d '{"input": {"query": "Summarize Q4 ESG reports"}}'Triggers workflow execution with provider-selected runtime and returns execution ID for SSE streaming.
Retrieval Search with Hybrid Strategy
curl -X POST https://api.dailogue.ai/api/v2/retrieval/search \
-H "Authorization: Bearer <token>" \
-H "X-Application-Tenant-Id: <app-tenant-id>" \
-H "X-Application-Id: <app-entity-id>" \
-H "X-Target-Tenant-Id: <target-tenant-id>" \
-H "X-Target-Tenant-Scope: customer" \
-H "Content-Type: application/json" \
-d '{
"query": "What are the ESG reporting requirements for Q4?",
"strategy": "hybrid_rerank",
"topK": 8
}'Combines vector + keyword retrieval with cross-encoder reranking for grounded context assembly.
Create Ingestion Source
curl -X POST https://api.dailogue.ai/api/v2/ingestion/sources \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"name": "Weekly Newsletter Feed",
"sourceType": "rss",
"config": {
"url": "https://example.com/feed.xml",
"schedule": "0 6 * * 1"
}
}'Use API Reference for endpoint-level request/response schemas and interactive exploration.
Separate Reference Experience
Guides explain architecture, configuration, and operational patterns. Reference focuses on endpoint contracts.