diff --git a/.agents/skills/review-agents-md/SKILL.md b/.agents/skills/review-agents-md/SKILL.md new file mode 100644 index 0000000..ecb703e --- /dev/null +++ b/.agents/skills/review-agents-md/SKILL.md @@ -0,0 +1,206 @@ +--- +name: review-agents-md +description: Audit Dograh `AGENTS.md` files for drift against the live repo and for bad scope boundaries between parent and child docs. Use when the user asks to review existing AGENTS files, identify stale guidance, decide whether a subtree needs its own `AGENTS.md`, or update the `AGENTS.md` hierarchy under the repo root, `api/`, or `ui/`. +--- + +# Review AGENTS.md + +Audit first. Report drift, missing coverage, and wrong ownership boundaries before editing docs unless the user explicitly asks for patches. + +## Freshness Rule + +Treat the repo as source of truth. + +- Trust current code and current directory layout over any `AGENTS.md`, `README.md`, or this skill's references. +- If prose and code disagree, report the prose as stale. +- If a reference file in this skill disagrees with the repo, trust the repo and mention the drift. + +## Workflow + +### 0. Refresh the seam reference before using it + +If subagents are available, refresh `references/dograh-seams.md` before relying on it. + +- Spawn exactly one subagent for this maintenance pass. +- Tell the subagent to inspect the live repo. +- Limit its patch set to `.agents/skills/review-agents-md/references/dograh-seams.md`. +- Also allow `.agents/skills/review-agents-md/scripts/inventory_agents_md.py`, but only if the helper itself needs a repo-specific fix. +- Tell the subagent not to recurse into this same seam-refresh workflow. This is a one-level maintenance pass, not an infinite self-audit loop. +- Tell the subagent not to review or patch any repo `AGENTS.md` files yet. Its job is only to refresh the seam reference and helper. +- After the subagent returns, review its diff quickly before using `dograh-seams.md` in the main audit. + +Use a prompt shaped like: + +```text +Review and refresh .agents/skills/review-agents-md/references/dograh-seams.md against the live Dograh repo. Patch only that file, and patch .agents/skills/review-agents-md/scripts/inventory_agents_md.py only if needed. Do not recurse into another seam-refresh pass. Do not review or edit any AGENTS.md files yet. +``` + +If subagents are not available, do the same seam refresh locally before continuing. + +### 1. Inventory the current hierarchy + +Run the helper first from the repo root: + +```bash +python .agents/skills/review-agents-md/scripts/inventory_agents_md.py +``` + +This prints: + +- every discovered `AGENTS.md` +- child `AGENTS.md` ownership boundaries +- immediate child directories for each scope +- large uncovered subtrees that may deserve their own `AGENTS.md` + +Then confirm with direct file discovery when needed: + +```bash +rg --files -g 'AGENTS.md' . +find api ui -name AGENTS.md | sort +``` + +### 2. Read top-down before judging details + +Read in this order: + +1. repo root `AGENTS.md` +2. `api/AGENTS.md` +3. `ui/AGENTS.md` +4. deeper `AGENTS.md` files under those trees + +For each file, write a one-line ownership statement in your notes: + +- what subtree it owns +- what shared rules it should contain +- which deeper docs, if any, should own implementation details instead + +### 3. Verify each doc against the live code + +Check directory trees, route aggregators, registration points, and extension seams instead of relying on filenames mentioned in prose. + +Dograh files worth checking early: + +- `api/routes/main.py` +- `api/routes/telephony.py` +- `api/services/integrations/loader.py` +- `api/services/integrations/registry.py` +- `api/services/pipecat/run_pipeline.py` +- `api/tasks/run_integrations.py` +- `api/services/telephony/registry.py` +- `api/services/telephony/factory.py` +- `api/services/telephony/providers/__init__.py` +- `ui/src/app/` +- `ui/src/components/` +- `ui/src/lib/auth/` +- `ui/src/client/` + +Read [dograh-seams.md](references/dograh-seams.md) when you need a fast repo-specific starting map. + +### 4. Apply the hierarchy tests + +Use these tests for every scope: + +- `parent-fit`: The parent doc explains immediate child systems, shared invariants, and navigation for the subtree it owns. +- `child-fit`: A deeper doc owns local extension contracts, module-specific gotchas, and file-level patterns for its own subtree. +- `no-duplication`: The parent does not restate detailed child implementation guidance that should live in the child doc. +- `downward-pointing`: The doc should point contributors toward the next relevant subdirectory or deeper `AGENTS.md` instead of trying to explain the whole subtree itself. +- `no-gaps`: If a large or extension-heavy subtree has rules the parent cannot explain cleanly in a few lines, flag a missing child `AGENTS.md`. +- `no-drift`: File trees, commands, extension points, and architecture claims still match the code. + +### 5. Dograh-specific review heuristics + +#### Root `AGENTS.md` + +Expect root to stay high-level. + +- It should describe the top-level project shape, shared stack, and shared local-development expectations. +- It should mention top-level applications and support directories that matter to contributors. +- It should not try to document backend-internal extension contracts or frontend component internals. +- If a top-level directory materially matters to contributors and is missing from root guidance, report `missing-parent-coverage`. + +#### `api/AGENTS.md` + +Expect `api/AGENTS.md` to orient a contributor across backend domains, not to document every local contract in full. + +- It should point to where routes, services, DB access, schemas, tasks, tests, and security invariants live. +- It should accurately describe where workflow execution lives. In current Dograh, that spans `api/services/workflow/`, `api/services/pipecat/`, and post-call work in `api/tasks/run_integrations.py`. +- It should accurately describe telephony as a substantial subsystem, not just as one route file. +- It should mention integration extensibility and defer package-level rules to `api/services/integrations/AGENTS.md`. +- If `api/services/telephony/` or `api/services/workflow/` are complex enough that the parent doc becomes vague or overloaded, report `missing-child-agents`. + +#### `api/services/integrations/AGENTS.md` + +Expect this file to own the integration package contract. + +- It should explain package registration, node model/spec patterns, runtime collection, completion handlers, optional routes, import discipline, and testing expectations. +- It should match the live registry/loader path instead of describing central manual wiring that no longer exists. +- It should not require edits to `workflow/dto.py`, `run_pipeline.py`, or route aggregation unless the generic framework genuinely changed. + +#### `ui/AGENTS.md` + +Expect `ui/AGENTS.md` to orient contributors across the frontend without documenting individual feature internals. + +- It should describe the App Router layout under `ui/src/app/`. +- It should point to reusable feature components under `ui/src/components/`. +- It should mention generated API client usage under `ui/src/client/`. +- It should mention auth readiness constraints under `ui/src/lib/auth/`. +- It should not describe removed folders or outdated stack details. + +### 6. Classify findings + +Use these categories: + +- `stale`: prose mentions files, commands, flows, or architecture that no longer match the repo +- `missing-parent-coverage`: a parent scope omits a major subsystem it should orient the reader to +- `missing-child-agents`: a deep subtree likely needs its own `AGENTS.md` +- `wrong-level`: content belongs in a parent or child scope instead +- `extra-detail`: a parent doc is too implementation-specific for its level + +### 7. Report format + +List findings first, ordered by severity. + +Use this shape: + +```text +: -> -> +``` + +Examples: + +```text +api/AGENTS.md: missing-child-agents -> telephony is a large extension surface with provider registration, transport, routes, and config rules but has no local AGENTS.md -> add api/services/telephony/AGENTS.md and keep api/AGENTS.md at navigation level +api/services/integrations/AGENTS.md: stale -> says central DTO edits are required for new integrations, but registry-based discovery handles node resolution -> update the doc to describe the registry path only +ui/AGENTS.md: wrong-level -> describes individual workflow-builder component behavior instead of frontend navigation rules -> move that detail to a deeper doc or remove it +``` + +After findings, include: + +- open questions or assumptions +- optional patch plan, only if the user asked for fixes or clearly wants them next + +## Editing Rules + +If the user wants the docs fixed: + +- patch the smallest set of `AGENTS.md` files that restores a clean hierarchy +- add a new `AGENTS.md` only when a subtree has distinct local rules or extension contracts +- keep parent docs short and navigational +- let child docs own local implementation rules +- avoid copying the same guidance into parent and child files +- prefer folders over files when writing navigation guidance, unless a file is the only real seam +- when adding a new child `AGENTS.md`, start with the shortest useful contract; avoid tutorial-style prose +- point the reader downward toward the next relevant subdirectory or child `AGENTS.md` +- if a draft feels forced or over-explained, compress it again + +## Useful Commands + +```bash +python .agents/skills/review-agents-md/scripts/inventory_agents_md.py +rg --files -g 'AGENTS.md' . +find api ui -name AGENTS.md | sort +find api/services -maxdepth 2 -type d | sort +find ui/src -maxdepth 2 -type d | sort +rg -n "include_router|all_routers" api/routes/main.py api/services/integrations +rg -n "register\\(|ProviderSpec|register_package|create_runtime_sessions|run_completion" api/services/telephony api/services/integrations +``` diff --git a/.agents/skills/review-agents-md/agents/openai.yaml b/.agents/skills/review-agents-md/agents/openai.yaml new file mode 100644 index 0000000..099cf0a --- /dev/null +++ b/.agents/skills/review-agents-md/agents/openai.yaml @@ -0,0 +1,4 @@ +interface: + display_name: "Review AGENTS.md" + short_description: "Audit AGENTS.md scope and drift" + default_prompt: "Use $review-agents-md to audit AGENTS.md files for drift, missing coverage, and wrong scope boundaries." diff --git a/.agents/skills/review-agents-md/references/dograh-seams.md b/.agents/skills/review-agents-md/references/dograh-seams.md new file mode 100644 index 0000000..96390a6 --- /dev/null +++ b/.agents/skills/review-agents-md/references/dograh-seams.md @@ -0,0 +1,126 @@ +# Dograh Seams + +Use this file as a starting map, not as source of truth. Verify every claim against the live repo. + +## Dynamic discovery only + +Do not record the current `AGENTS.md` inventory in this file. + +- discover the live hierarchy with `rg --files -g 'AGENTS.md' .` +- use the helper script to identify uncovered hot spots +- treat any baked-in inventory of existing `AGENTS.md` files as drift-prone and remove it + +## Root-level anchors + +The repo root still revolves around these contributor-relevant directories: + +- `api/` +- `ui/` +- `scripts/` +- `docs/` +- `pipecat/` + +Current code-heavy top-level subtrees that can matter during hierarchy reviews: + +- `evals/` for evaluation tooling, including `evals/visualizer/` +- `sdk/` for packaged SDK work, especially `sdk/python/` and `sdk/typescript/` + +Root `AGENTS.md` should stay at this level. + +## Backend anchors + +### Route aggregation + +- REST routers are aggregated in `api/routes/main.py`. +- Telephony has its main cross-provider route file at `api/routes/telephony.py`. +- Integration package routers are mounted through `api.services.integrations.all_routers()`. +- Node-type metadata is exposed from `api/routes/node_types.py`. + +### Workflow execution + +Workflow execution is not a single folder. + +- workflow graph, DTOs, node data, node-spec generation, QA, and tool helpers live under `api/services/workflow/` +- live pipeline execution lives under `api/services/pipecat/` +- Dograh-specific realtime provider adapters live under `api/services/pipecat/realtime/` +- post-call QA, registered integrations, and webhook execution live in `api/tasks/run_integrations.py` + +If `api/AGENTS.md` implies workflow execution lives in only one place, treat that as suspicious. + +### Node spec and SDK seam + +- core node specs are registered lazily from `api/services/workflow/dto.py` by `api/services/workflow/node_specs/__init__.py` +- integration node specs are merged through `api.services.integrations.all_node_specs()` +- the frontend and SDK-facing node catalog is served from `api/routes/node_types.py` + +### Telephony + +Current telephony architecture is registry-driven. + +- importing `api.services.telephony` eagerly loads `api/services/telephony/providers/` so provider packages self-register +- provider registration and `ProviderSpec` live in `api/services/telephony/registry.py` +- provider lookup, org-scoped config normalization, inbound matching, and run-scoped resolution live in `api/services/telephony/factory.py` +- per-provider HTTP routers live in `api/services/telephony/providers//routes.py` and are auto-mounted by `api/routes/telephony.py` +- provider-local implementations live in `api/services/telephony/providers//` +- current provider packages include `ari`, `cloudonix`, `plivo`, `telnyx`, `twilio`, `vobiz`, and `vonage` +- not every provider has an HTTP route module; for example, `ari` is transport-focused and skipped by the auto-mounter + +### Integrations + +Current integrations are also registry-driven. + +- package discovery lives in `api/services/integrations/loader.py` via `pkgutil.iter_modules(...)` +- package registration and runtime/completion orchestration live in `api/services/integrations/registry.py` +- shared package/session context types live in `api/services/integrations/base.py` +- a concrete package example exists at `api/services/integrations/tuner/` + +## Frontend anchors + +### Navigation and pages + +- page routes live under `ui/src/app/` +- `ui/src/app/layout.tsx` composes the global frontend providers and `AppLayout` +- runtime config handlers live under `ui/src/app/api/config/` +- auth/session handlers live under `ui/src/app/api/auth/` +- feature coverage should be discovered from the current `ui/src/app/` tree, not maintained as a static list here + +### Components and feature slices + +- shared primitives live under `ui/src/components/ui/` +- workflow builder primitives live under `ui/src/components/flow/` +- reusable workflow UI lives under `ui/src/components/workflow/` +- workflow run UI lives under `ui/src/components/workflow-runs/` +- telephony-related UI lives under `ui/src/components/telephony/` +- layout components live under `ui/src/components/layout/` +- workflow feature code is split between reusable components and route-local code under `ui/src/app/workflow/[workflowId]/`, especially `components/`, `contexts/`, `hooks/`, `stores/`, `utils/`, and nested `run/[runId]/` + +### Client and auth + +- generated API client code lives under `ui/src/client/`, with generated subtrees in `ui/src/client/client/` and `ui/src/client/core/` +- auth exports live in `ui/src/lib/auth/index.ts` +- auth provider wrappers live under `ui/src/lib/auth/providers/` +- server-side auth helpers live in `ui/src/lib/auth/server.ts` +- `AuthProvider` chooses between the Stack and local wrappers after fetching `/api/config/auth`, so docs that treat auth as compile-time static are suspicious + +## Known drift example from the audit + +`api/services/telephony/README.md` is still stale in the current repo snapshot: + +- it described flat provider files like `twilio_provider.py` and `vonage_provider.py` +- it told contributors to add schemas to `api/schemas/telephony_config.py` +- it referenced legacy patterns such as direct `TwilioService` usage + +The live code instead uses provider packages under `providers//`, registry-driven provider resolution, and route auto-mounting from `api/routes/telephony.py`. Use this as a reminder that prose in adjacent docs may have drifted even when the code is coherent. + +## Hotspot heuristics + +These are review prompts, not frozen conclusions. + +- pay extra attention to deep subtrees that define extension contracts, registration points, or multi-file execution paths +- in Dograh, common examples include telephony, workflow execution, generated SDK surfaces, and other service subtrees that span many files + +Ask: + +- does the parent doc have enough room to explain this subtree accurately without becoming overloaded? +- does the subtree have distinct extension rules, registration points, or local pitfalls? +- would a contributor benefit from a dedicated `AGENTS.md` here? diff --git a/.agents/skills/review-agents-md/scripts/inventory_agents_md.py b/.agents/skills/review-agents-md/scripts/inventory_agents_md.py new file mode 100644 index 0000000..7f629f8 --- /dev/null +++ b/.agents/skills/review-agents-md/scripts/inventory_agents_md.py @@ -0,0 +1,272 @@ +#!/usr/bin/env python3 +"""Inventory AGENTS.md scopes and large uncovered subtrees. + +Run from the repo root: + + python .agents/skills/review-agents-md/scripts/inventory_agents_md.py + +The output is intentionally heuristic. It helps with discovery; it does not +decide by itself whether a subtree must have its own AGENTS.md. +""" + +from __future__ import annotations + +import argparse +import os +from dataclasses import dataclass +from pathlib import Path + +IGNORE_DIRS = { + ".git", + ".hg", + ".svn", + ".next", + ".turbo", + ".venv", + "venv", + "node_modules", + "__pycache__", + ".pytest_cache", + ".ruff_cache", + ".mypy_cache", + ".cursor", + ".claude", + ".idea", + ".vscode", + "dist", + "build", +} + +CODE_EXTENSIONS = { + ".py", + ".ts", + ".tsx", + ".js", + ".jsx", + ".mjs", + ".cjs", +} + + +@dataclass(frozen=True) +class DirSummary: + path: Path + code_files: int + nested_dirs: int + has_agents_here: bool + descendant_agents: int + + +def parse_args() -> argparse.Namespace: + parser = argparse.ArgumentParser( + description="Summarize AGENTS.md coverage and likely missing deeper scopes.", + ) + parser.add_argument( + "roots", + nargs="*", + default=["."], + help="Directories to scan. Defaults to the current directory.", + ) + parser.add_argument( + "--hotspot-threshold", + type=int, + default=12, + help="Minimum code-file count for a subtree to be listed as a hotspot.", + ) + return parser.parse_args() + + +def should_skip_dir(name: str) -> bool: + return name in IGNORE_DIRS or name.startswith(".") + + +def walk_dirs(root: Path): + for current_root, dirnames, filenames in os.walk(root): + dirnames[:] = sorted(d for d in dirnames if not should_skip_dir(d)) + yield Path(current_root), dirnames, filenames + + +def discover_agents(roots: list[Path]) -> list[Path]: + found: set[Path] = set() + for root in roots: + for current_root, _dirnames, filenames in walk_dirs(root): + if "AGENTS.md" in filenames: + found.add((current_root / "AGENTS.md").resolve()) + return sorted(found) + + +def count_nested_dirs(root: Path) -> int: + count = 0 + for current_root, dirnames, _filenames in walk_dirs(root): + if Path(current_root) == root: + count += len(dirnames) + continue + count += len(dirnames) + return count + + +def count_code_files(root: Path) -> int: + count = 0 + for _current_root, _dirnames, filenames in walk_dirs(root): + for filename in filenames: + if Path(filename).suffix in CODE_EXTENSIONS: + count += 1 + return count + + +def descendant_agents(root: Path, agents: list[Path]) -> list[Path]: + root_resolved = root.resolve() + return [ + agent + for agent in agents + if agent.parent != root_resolved and root_resolved in agent.parents + ] + + +def immediate_child_dirs(root: Path) -> list[Path]: + children = [] + for child in sorted(root.iterdir()): + if child.is_dir() and not should_skip_dir(child.name): + children.append(child) + return children + + +def summarize_child(child: Path, agents: list[Path]) -> DirSummary: + desc_agents = descendant_agents(child, agents) + return DirSummary( + path=child, + code_files=count_code_files(child), + nested_dirs=count_nested_dirs(child), + has_agents_here=(child / "AGENTS.md").exists(), + descendant_agents=len(desc_agents), + ) + + +def format_path(path: Path, cwd: Path) -> str: + try: + return str(path.resolve().relative_to(cwd)) + except ValueError: + return str(path.resolve()) + + +def nested_hotspots(summary: DirSummary, agents: list[Path], threshold: int) -> list[DirSummary]: + if summary.has_agents_here: + return [] + if summary.code_files < threshold: + return [] + + nested_summaries = [ + summarize_child(child, agents) for child in immediate_child_dirs(summary.path) + ] + return [ + nested + for nested in nested_summaries + if ( + not nested.has_agents_here + and nested.code_files >= threshold + and nested.descendant_agents == 0 + ) + ] + + +def print_scope(scope_dir: Path, agents: list[Path], cwd: Path, threshold: int) -> None: + scope_agent = scope_dir / "AGENTS.md" + child_agents = descendant_agents(scope_dir, agents) + + print(f"AGENTS: {format_path(scope_agent, cwd)}") + + if child_agents: + print(" child AGENTS:") + for agent in child_agents: + print(f" - {format_path(agent, cwd)}") + else: + print(" child AGENTS: none") + + children = immediate_child_dirs(scope_dir) + if not children: + print(" immediate child dirs: none") + print() + return + + print(" immediate child dirs:") + summaries = [summarize_child(child, agents) for child in children] + for summary in summaries: + marker = "has AGENTS" if summary.has_agents_here else "no AGENTS" + extra = "" + if summary.descendant_agents and not summary.has_agents_here: + extra = f", {summary.descendant_agents} deeper AGENTS" + print( + " - " + f"{format_path(summary.path, cwd)}/ -> " + f"{summary.code_files} code files, " + f"{summary.nested_dirs} nested dirs, " + f"{marker}{extra}" + ) + + hotspots = [ + summary + for summary in summaries + if ( + not summary.has_agents_here + and summary.code_files >= threshold + and summary.descendant_agents == 0 + ) + ] + if hotspots: + print(" hotspot children without AGENTS:") + for summary in hotspots: + print( + " - " + f"{format_path(summary.path, cwd)}/ -> " + f"{summary.code_files} code files, {summary.nested_dirs} nested dirs" + ) + else: + print(" hotspot children without AGENTS: none") + + second_level_hotspots = [] + for summary in summaries: + for nested in nested_hotspots(summary, agents, threshold): + second_level_hotspots.append((summary.path, nested)) + + if second_level_hotspots: + print(" nested hotspot children under umbrella dirs:") + for parent, nested in second_level_hotspots: + print( + " - " + f"{format_path(nested.path, cwd)}/ -> " + f"{nested.code_files} code files, {nested.nested_dirs} nested dirs " + f"(under {format_path(parent, cwd)}/)" + ) + else: + print(" nested hotspot children under umbrella dirs: none") + + print() + + +def main() -> int: + args = parse_args() + cwd = Path.cwd().resolve() + roots = [Path(root).resolve() for root in args.roots] + agents = discover_agents(roots) + + if not agents: + print("No AGENTS.md files found.") + return 0 + + print("# AGENTS inventory") + print(f"roots: {', '.join(format_path(root, cwd) for root in roots)}") + print() + + scope_dirs = sorted(agent.parent for agent in agents) + for scope_dir in scope_dirs: + print_scope(scope_dir, agents, cwd, args.hotspot_threshold) + + print("Notes:") + print("- This is a heuristic inventory, not an automatic decision engine.") + print("- A hotspot is only a candidate for a deeper AGENTS.md.") + print("- Always verify architecture claims against live code before reporting drift.") + return 0 + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/.agents/skills/review-pr/SKILL.md b/.agents/skills/review-pr/SKILL.md new file mode 100644 index 0000000..a01d2ce --- /dev/null +++ b/.agents/skills/review-pr/SKILL.md @@ -0,0 +1,285 @@ +--- +name: review-pr +description: Review a Dograh pull request, branch diff, or pasted patch for repo-specific security and correctness risks that are not obvious from generic FastAPI, Next.js, or Python conventions. Use when the user asks to review a PR, audit a diff, check whether changes are safe to merge, review their own changes, or asks what to look for in a Dograh PR. Focus on tenant isolation, route auth, webhook signing and org derivation, DB layering, worker-sync, migrations, generated SDK usage, and test hazards. +--- + +# Reviewing PRs (dograh) + +This skill is for reviewing any PR, including PRs written by maintainers. Focus on Dograh-specific regression risks. Skip generic lint, formatting, and type-check comments unless they connect to one of the repo-specific issues below. + +The main failure modes in this repo are: + +- Missing org scoping on request-reachable reads or writes +- Authless routes or websockets +- Trusting unsigned webhook fields +- SQL written outside `api/db/*_client.py` +- Per-worker cache state updated without worker sync +- UI calls that bypass the generated SDK +- Migrations that are not safe on existing production data + +## How to drive the review + +1. Get the diff: + - GitHub PR: `gh pr diff ` or `gh pr view --json files,additions,deletions` + - Local branch: `git diff origin/main...HEAD` +2. Bucket changed files into the sections below. +3. Read the current repo as source of truth before finalizing findings: + - `api/AGENTS.md` for org scoping and worker-sync + - `ui/AGENTS.md` for generated client rules + - Touched models, DB clients, routes, services, and migrations +4. Run only the sections relevant to the changed files. +5. Report findings as `: -> -> `. + +## Freshness rule + +Treat this file as review policy and navigation, not as a frozen inventory. + +- If the current repo conflicts with this skill, trust the repo and mention the drift. +- Do not rely on static allowlists or exact line numbers from this file. +- Review against the code in the PR and the current local repo, not against old prose. + +### File to section map + +| Path pattern in diff | Sections to run | +| ----------------------------------------------------- | --------------- | +| `api/routes/*.py` | 1, 2, 8 | +| `api/db/*_client.py`, `api/db/models.py` | 2, 3 | +| `api/services/**/*.py` | 2, 3, 4 | +| `api/tasks/*.py` | 2, 3, 5 | +| `api/alembic/versions/*.py` | 6 | +| `api/mcp_server/**`, `api/services/workflow/mcp_*.py` | 1, 2, 7 | +| `ui/**` | 9 | +| `api/constants.py`, anything `os.getenv` | 10 | +| `api/tests/**` | 11 | +| `api/schemas/*.py` | 12 | + +--- + +## 1. Route authentication (`api/routes/*.py`) + +There is no global auth middleware. Each route declares its own auth behavior. Forgetting one creates a silently public endpoint. + +Common auth deps from `api.services.auth.depends`: + +- `get_user` +- `get_user_ws` +- `get_superuser` + +Checks: + +- A new `@router.(...)` handler with no auth dependency is public. Treat that as a finding unless the current file already establishes a deliberate public auth pattern such as public token auth, signed webhook auth, or an equivalent websocket token flow. +- `get_user` on an impersonation, cross-org, or global reporting endpoint should usually be `get_superuser`. +- A route that reimplements bearer or API-key parsing instead of using the shared auth dependency is a finding. +- A websocket handler without `Depends(get_user_ws)` and without a clear public token path is a finding. +- A PR tightening `CORSMiddleware` to a fixed origin list needs strong justification. Dograh relies on cross-origin embedding; endpoint auth is the real control. + +Useful commands: + +```bash +rg -n "Depends\\((get_user|get_user_ws|get_superuser)\\)" api/routes +rg -n "@router\\.(get|post|put|delete|patch|websocket)" api/routes +``` + +--- + +## 2. Organization scoping (the cross-tenant rule) + +This is the highest priority rule in the repo. Every request-reachable read or write of an org-scoped resource must filter or validate by `organization_id`. + +Use `api/AGENTS.md` as the canonical summary. + +Determine scope from the current code: + +- Direct scope: the model has `organization_id` +- Indirect scope: the model reaches an org through a parent FK or relationship +- Legacy spelling may exist in old migrations or old code, but new runtime code should use `organization_id` + +Checks: + +- Any `*_by_id(...)` call in a route handler is suspicious. If request-reachable and unscoped, it is usually a finding. +- New `list_*` or `get_*` endpoints must filter in SQL, not in Python after `.all()`. +- If a request writes an FK to another org-scoped resource, the route must first fetch that target row with `user.selected_organization_id` and reject if it does not belong to the org. +- Services called from routes must preserve scoping. If a service method or DB client call drops `organization_id`, trace the caller. +- Background tasks do not get org context for free. They must reload the parent row and derive org from there. +- Webhooks must derive org from a signed or otherwise authenticated identifier, not from caller-supplied body fields like `organization_id`. +- New runtime code should use canonical `organization_id`, not `org_id`, `tenant_id`, or `organisation_id`. + +Useful commands: + +```bash +rg -n "_by_id\\(" api/routes api/services api/tasks +rg -n "db_client\\.get_\\w+\\(" api/routes api/services api/tasks +rg -n "organization_id|selected_organization_id" api/routes api/services api/tasks api/db +``` + +--- + +## 3. DB query layering (`api/db/` is the only home for SQL) + +Production SQL belongs in `api/db/*_client.py`. Routes, services, and tasks should call DB client methods, not write SQLAlchemy directly. + +Checks: + +- `select`, `update`, `delete`, `insert`, `AsyncSession`, `sessionmaker`, or `async_session` in `api/routes/`, `api/services/`, or `api/tasks/` is a finding. +- `api/services/admin_utils/` is the exception. It is not a template for production code. +- Session lifecycle belongs inside the DB client. +- New DB client parameters should use canonical `organization_id`. + +Useful commands: + +```bash +rg -n "(from sqlalchemy|AsyncSession|sessionmaker|async_session)" api/routes api/services api/tasks +``` + +--- + +## 4. Worker sync - multi-process state coherence (`api/services/worker_sync/`) + +Production runs multiple workers. Per-process mutable caches become stale unless updates are broadcast. + +Use `api/AGENTS.md` as the canonical summary. + +Checks: + +- A new module-level or class-level mutable cache written by an endpoint needs a `WorkerSyncManager` broadcast path. +- Local invalidation alone is not enough if other workers can still serve stale state. +- If a PR introduces a new cached object, the diff should usually contain all three: + - the broadcast call + - the event type or equivalent signal definition + - the handler registration that reloads fresh state + +--- + +## 5. Background tasks (`api/tasks/`, ARQ) + +Checks: + +- User-triggered enqueue paths must validate org ownership before enqueue. +- Tasks that accept IDs and reload rows must derive org from those rows, not assume shared context. +- Tasks must be idempotent or explicitly retry-safe. +- Only real task entrypoints belong in `api/tasks/arq.py::WorkerSettings.functions`. +- Secret logging rules from section 10 apply here too. + +--- + +## 6. Migrations (`api/alembic/versions/`) + +Checks: + +- `upgrade()` and `downgrade()` should both exist and be meaningfully reversible unless the change truly cannot be reversed. +- Adding a `NOT NULL` column to a populated table needs a safe default or a backfill before the constraint. +- Tightening nullable to non-nullable needs the backfill before `alter_column(..., nullable=False)`. +- New JSON columns should match the table's existing JSON or JSONB conventions. +- Large backfills in a migration should be questioned; they often belong out-of-band. +- Indexes on large tables need concurrent-safe handling. +- Do not turn historical migration naming into a finding by itself. Review the migration being changed, not old untouched migration prose. + +--- + +## 7. MCP server (`api/mcp_server/`) + +Checks: + +- New tools should use `authenticate_mcp_request()`, not reimplement API-key validation. +- New tool DB lookups should preserve org scoping just like REST routes. +- Tools that call external URLs must validate those URLs and consider SSRF. + +--- + +## 8. Telephony and webhook handlers + +Checks: + +- New provider webhook flows should implement `verify_inbound_signature()` or the provider equivalent. +- Minimal pre-verification work may be required to identify the candidate config, but the route should not do unrelated workflow, user, or stateful work before verification. +- Org derivation should come from provider identifiers that are validated by the webhook auth flow, then the derived org/config should drive downstream lookups. +- A webhook must not trust raw body `organization_id`. +- If a webhook references a phone number, validate that the number exists for the derived org. + +--- + +## 9. UI (`ui/`) - generated SDK only + +Use `ui/AGENTS.md` as the canonical summary. + +The frontend should talk to the backend through `ui/src/client/`. Raw `fetch` to internal `/api/v1/` routes is suspicious by default. + +Checks: + +- `fetch('/api/v1/...')` or `fetch(\`${backendUrl}/api/v1/...\`)` in app code is usually a finding unless the current code proves a narrow exception. +- Hardcoded backend URLs are a finding. +- Manual `Authorization` header construction in regular components is a finding; auth should be injected centrally. +- SDK calls fired before auth state is ready are a finding. +- Local interfaces that duplicate generated types are a finding. +- If backend API shape changed and the UI consumes it, `ui/src/client/` should usually change too. + +Useful commands: + +```bash +rg -n "fetch\\(['\"\\`].*api/v1" ui/src +rg -n "Authorization" ui/src +``` + +--- + +## 10. Logging, secrets, constants + +Checks: + +- New code should use Loguru, not stdlib `logging`. +- New `os.getenv(...)` outside `api/constants.py` is a finding. +- Do not log API keys, bearer tokens, credentials, full webhook bodies, or PII. + +Common offender shapes: + +- `logger.info(f"config: {config}")` +- `logger.debug(request_body)` +- Logging raw config or user configuration rows + +--- + +## 11. Tests (`api/tests/`) + +Checks: + +- Async waits in tests should use `asyncio.wait_for(...)` or another bounded timeout pattern. +- Tests should run against `.env.test`, not `.env`. +- Integration tests should not be neutered by replacing real DB behavior with mocks just to make the test pass. +- Tests that depend on mutable shared DB state across test cases are suspicious. + +--- + +## 12. Schemas (`api/schemas/`) + +Checks: + +- New response schemas should not expose internal FKs or IDs unless the caller genuinely needs them. +- Request schemas that accept org-scoped FK values are a trigger to inspect the corresponding route for section 2 ownership validation. + +--- + +## Final pass: shape the report + +Present findings in three buckets: + +- **Blocker** + - Missing org scope on a request-reachable lookup + - Route added without auth and without a proven deliberate public auth mechanism + - Webhook without signature verification, or significant unrelated work done before verification + - Migration without safe backfill or without a meaningful downgrade + - UI bypasses generated SDK for internal API calls + - Secrets logged + +- **Should-fix** + - Cached state mutated without worker sync + - JSON vs JSONB inconsistency + - Response schema leaks internal identifiers + - Backend API changed without client regen where UI consumes it + - Test path can hang indefinitely + +- **Nit** + - Naming inconsistencies + - Minor convention drift + - Low-risk schema or report-shape cleanup + +Cite `file:line` for each finding. Skip anything a formatter, linter, or IDE would already catch unless it connects to one of the repo-specific risks above. diff --git a/AGENTS.md b/AGENTS.md index b74bf7a..3147249 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -25,21 +25,7 @@ dograh/ ## Local Development -### Starting Services - -```bash -# Start infrastructure services (postgres, redis, minio) -./scripts/start_services_dev.sh - -# Stop all services -./scripts/stop_services.sh -``` - -On Windows (PowerShell): -```powershell -.\scripts\start_services_dev.ps1 -.\scripts\stop_services.ps1 -``` +Contributor setup and service startup are documented in `docs/contribution/setup.mdx`. ## Environment Configuration diff --git a/README.md b/README.md index 55f70e2..cd62044 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,8 @@

📖 Docs  ·  - 📜 BSD 2-Clause + 📜 BSD 2-Clause  ·  + 🌐 中文

diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 0000000..0ab8448 --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,182 @@ +# Dograh AI + +> 💡 **Notice**: This documentation is community-maintained. If you spot any translation inaccuracies or content that has drifted from the English version, please feel free to open a PR! +> +> 💡 **提示**:本文档由社区共同维护。如果您发现翻译不准确,或与英文版本存在出入,欢迎随时提交 PR! + +**开源、可自托管的 Vapi 与 Retell 替代方案** —— 通过拖拽式工作流编辑器构建生产级语音智能体,2 分钟内即可上线一个能用的语音机器人。 + +

+ + 体验云端版本 + +   + + 60 秒自托管 + +   + + 加入 Slack + +

+ +

+ 📖 文档  ·  + 📜 BSD 2-Clause  ·  + 🌐 English +

+ +

+ Dograh 实战演示 —— 搭建工作流、启动语音智能体、直接对话 +

+ +- **100% 开源**,可自托管 —— 不像 Vapi 或 Retell,没有任何厂商绑定 +- **完全可控且透明** —— 每一行代码都是开放的,LLM / TTS / STT 集成灵活可换 +- **由 YC 校友与连续创业者维护**,致力于让语音 AI 始终保持开放 + +## 🎥 媒体推荐 + +
+ + Better Stack 介绍 Dograh + +
+ Better Stack 上手实测 —— 深入体验 Dograh +
+ +
+📺 想看 2 分钟产品快速演示?点这里。 + + + +
+ +## ⚖️ Dograh vs Vapi vs Retell + +针对正在评估语音 AI 平台的团队,这里是一份在最关键的维度上诚实的对比。 + +| | **Dograh** | **Vapi** | **Retell** | +|---|---|---|---| +| **协议** | BSD 2-Clause(开源) | 闭源 | 闭源 | +| **可自托管** | ✅ 可以 —— 一条 Docker 命令 | ❌ 仅 SaaS | ❌ 仅 SaaS | +| **定价** | 免费(自托管)·按用量计费(云端) | 按分钟计费的 SaaS | 按分钟计费的 SaaS | +| **自带 LLM / STT / TTS** | ✅ 任意厂商,也可使用 Dograh 自带方案 | 在其集成范围内可配置 | 在其集成范围内可配置 | +| **源码级定制** | ✅ 每行代码都可自由修改 | ❌ 闭源 | ❌ 闭源 | +| **数据驻留** | 部署在自家基础设施,规则自己定 | 厂商云端 | 厂商云端 | +| **厂商绑定** | 无 | 完全绑定 | 完全绑定 | + + +## 🚀 快速开始 + +##### 在本地机器下载并部署 Dograh + +> **提示** +> 我们会收集匿名使用数据以改进产品。如需关闭,请在下面的命令中将 `ENABLE_TELEMETRY` 设为 `false`。 + +> **提示** +> 如果希望在远程服务器上运行该平台,请参考[文档](https://docs.dograh.com/deployment/docker#option-2:-remote-server-deployment)。 + +```bash +curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/main/docker-compose.yaml && REGISTRY=ghcr.io/dograh-hq ENABLE_TELEMETRY=true docker compose up --pull always +``` + +> **提示** +> 首次启动需要 2-3 分钟拉取所有镜像。启动完成后,打开 http://localhost:3010 即可创建你的第一个 AI 语音助手! +> 常见问题及解决方案请参见 🔧 **[故障排查](docs/troubleshooting.md)**。 + +### 🎙️ 你的第一个语音机器人 + +1. 在浏览器中打开 [http://localhost:3010](http://localhost:3010)。 +2. 选择 **Inbound(呼入)** 或 **Outbound(外呼)**,为机器人命名(例如 _销售线索筛选_),再用 5-10 个词描述用途(例如 _筛选保险表单中的购买意向_)。 +3. 点击 **Web Call**,直接和你的机器人对话。 + +> 🔑 **无需 API Key。** Dograh 自带一套自动生成的密钥,以及内置的 LLM / TTS / STT 栈。你可以随时接入自己的 LLM、TTS、STT 或电信服务商(如 Twilio、Vonage、Telnyx)。 + +## 功能特性 + +### 语音能力 + +- 电信集成:内置 Twilio、Vonage、Vobiz、Cloudonix 等(其他厂商也易于扩展),支持转接到人工坐席 +- 语言:支持英语(可扩展到其他语言) +- 自定义模型:可接入自己的 TTS / STT 模型 +- 实时处理:低延迟语音交互 + +### 开发者体验 + +- 零配置启动:自动生成 API Key,即开即用 +- 基于 Python:基于 Python 构建,便于二次开发 +- Docker 优先:容器化部署,环境一致 +- 模块化架构:按需替换各个组件 + +### 测试与质量 + +- **测试模式**:在发布前端到端试跑你的智能体,既不会产生真实通话,也不会影响生产数据 +- **面板内 Web 通话**:在搭建过程中直接和机器人对话,无需配置任何电信服务 +- **QA 节点**:内置的工作流节点,可分析其他节点中提示词的质量 + +## 部署方式 + +### 本地开发 + +参见[本地部署](https://docs.dograh.com/contribution/setup)。 + +### 自托管部署 + +如需了解远程服务器部署及 HTTPS 配置的详细步骤,请参见我们的 [Docker 部署指南](https://docs.dograh.com/deployment/docker)。 + +### 云端版本 + +托管云版本请访问 [https://www.dograh.com](https://www.dograh.com/)。 + +## 📚 文档 + +完整文档请访问 [https://docs.dograh.com](https://docs.dograh.com/)。 + +## 🤝 社区与支持 + +> 👋 **从 Better Stack 视频过来的朋友?** 欢迎在我们[置顶的 GitHub Discussion](https://github.com/orgs/dograh-hq/discussions/291) 里留下你的使用场景 —— 每一条留言我们都会看,创始团队会亲自对接早期用户。 + +- **Slack** —— Dograh AI 协作的主阵地。在这里和维护者交流、在动手前讨论功能、获取部署帮助,并跟进每一轮贡献活动。 +- **GitHub Discussions** —— 分享使用场景、提问、交流工作流配方。 +- **GitHub Issues** —— 报告 bug 或提交功能请求。 + +👉 加入我们 → [Dograh 社区 Slack](https://join.slack.com/t/dograh-community/shared_invite/zt-3czr47sw5-MSg1J0kJ7IMPOCHF~03auQ) + +## 🙌 参与贡献 + +我们欢迎一切贡献!Dograh AI 100% 开源,也会一直保持下去。 + +### 入门步骤 + +- Fork 本仓库 +- 创建特性分支(`git checkout -b feature/AmazingFeature`) +- 提交你的改动(`git commit -m 'Add some AmazingFeature'`) +- 推送到该分支(`git push origin feature/AmazingFeature`) +- 提交一个 Pull Request + +## ⭐ Star 历史 + + + Dograh 的 Star 历史 + + +## 📄 许可协议 + +Dograh AI 基于 [BSD 2-Clause 协议](LICENSE)开源 —— 与构建 Dograh AI 时所采用的项目使用相同的协议,确保兼容性,以及自由使用、修改和分发的权利。 + +## 🏢 关于我们 + +由 **Dograh**(Zansat Technologies Private Limited)用 ❤️ 打造。 +创始团队由 YC 校友与连续创业者组成,致力于让语音 AI 始终开放、人人可用。 + +


+ +

+ ⭐ 给我们一个 Star | + ☁️ 试用云端版本 | + 💬 加入 Slack +

diff --git a/api/AGENTS.md b/api/AGENTS.md index f57e8e8..d1c9d1d 100644 --- a/api/AGENTS.md +++ b/api/AGENTS.md @@ -6,35 +6,40 @@ FastAPI backend for the Dograh voice AI platform. ``` api/ -├── app.py # Application entry point, FastAPI setup ├── routes/ # API endpoint handlers -├── services/ # Business logic and integrations +├── services/ # Domain logic, runtime systems, and extension seams ├── db/ # Database models and data access ├── schemas/ # Pydantic request/response schemas -├── tasks/ # Background jobs (ARQ) -├── utils/ # Utility functions +├── tasks/ # Background jobs and post-call work +├── mcp_server/ # MCP surface exposed by the backend +├── utils/ # Shared utilities ├── alembic/ # Database migrations -├── constants.py # Environment variables and constants └── tests/ # Test suite ``` ## Where to Find Things -| Looking for... | Go to... | -| ---------------------- | ------------------------------------------------------------------------ | -| API endpoints | `routes/` - each file is a router module, aggregated in `routes/main.py` | -| Business logic | `services/` - organized by domain (telephony, workflow, campaign, etc.) | -| Database models | `db/models.py` | -| Database queries | `db/*_client.py` files (repository pattern) | -| Request/response types | `schemas/` | -| Background tasks | `tasks/` - uses ARQ for async job processing | -| Environment config | `constants.py` | +| Looking for... | Go to... | +| ---------------------------- | ----------------------------------------------------------------------------- | +| API endpoints | `routes/` - domain routers mounted under `/api/v1` | +| Workflow graph and node data | `services/workflow/` | +| Live pipeline runtime | `services/pipecat/` | +| Telephony providers/call flow| `services/telephony/` | +| Third-party integrations | `services/integrations/` | +| Campaign and other domains | `services/` | +| Database access | `db/` | +| Request/response types | `schemas/` | +| Background jobs | `tasks/` | +| MCP backend surface | `mcp_server/` | +| Tests | `tests/` | ## API Structure - All routes are mounted at `/api/v1` prefix -- Routes are organized by domain (workflow, telephony, campaign, user, etc.) -- `routes/main.py` aggregates all routers +- Routes are organized by domain under `routes/` +- Workflow execution spans `services/workflow/`, `services/pipecat/`, and `tasks/` +- Telephony is a full subsystem under `services/telephony/`, with provider-specific packages under `services/telephony/providers/` +- Integrations extend through `services/integrations/`; package-specific rules should live in that subtree's own `AGENTS.md` ## Database Migrations diff --git a/api/Dockerfile b/api/Dockerfile index bcda1a6..b871000 100644 --- a/api/Dockerfile +++ b/api/Dockerfile @@ -20,7 +20,7 @@ RUN pip install --user --no-cache-dir -r requirements.txt && \ # Copy and install pipecat from local submodule COPY pipecat /tmp/pipecat -RUN pip install --user --no-cache-dir '/tmp/pipecat[cartesia,deepgram,openai,elevenlabs,groq,google,azure,sarvam,soundfile,silero,webrtc,speechmatics,openrouter,camb]' && \ +RUN pip install --user --no-cache-dir '/tmp/pipecat[cartesia,deepgram,openai,elevenlabs,groq,google,azure,sarvam,soundfile,silero,webrtc,speechmatics,openrouter,camb,mcp]' && \ # Swap opencv-python (pulled by pipecat[webrtc]) for opencv-python-headless # to drop X11/Qt dependencies that otherwise require libxcb etc. in runner. pip uninstall -y opencv-python && \ diff --git a/api/alembic/versions/0a1b2c3d4e5f_add_mcp_in_toolcategory.py b/api/alembic/versions/0a1b2c3d4e5f_add_mcp_in_toolcategory.py new file mode 100644 index 0000000..34b006a --- /dev/null +++ b/api/alembic/versions/0a1b2c3d4e5f_add_mcp_in_toolcategory.py @@ -0,0 +1,64 @@ +"""add mcp in ToolCategory + +Revision ID: 0a1b2c3d4e5f +Revises: 4c1f1e3e8ef2 +Create Date: 2026-05-16 00:00:00.000000 + +""" + +from typing import Sequence, Union + +from alembic import op +from alembic_postgresql_enum import TableReference + +# revision identifiers, used by Alembic. +revision: str = "0a1b2c3d4e5f" +down_revision: Union[str, None] = "4c1f1e3e8ef2" +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.sync_enum_values( + enum_schema="public", + enum_name="tool_category", + new_values=[ + "http_api", + "end_call", + "transfer_call", + "calculator", + "native", + "integration", + "mcp", + ], + affected_columns=[ + TableReference( + table_schema="public", table_name="tools", column_name="category" + ) + ], + enum_values_to_rename=[], + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.sync_enum_values( + enum_schema="public", + enum_name="tool_category", + new_values=[ + "http_api", + "end_call", + "transfer_call", + "calculator", + "native", + "integration", + ], + affected_columns=[ + TableReference( + table_schema="public", table_name="tools", column_name="category" + ) + ], + enum_values_to_rename=[], + ) diff --git a/api/alembic/versions/19d2a4b6c8ef_rename_integrations_organisation_id.py b/api/alembic/versions/19d2a4b6c8ef_rename_integrations_organisation_id.py new file mode 100644 index 0000000..a39bb0a --- /dev/null +++ b/api/alembic/versions/19d2a4b6c8ef_rename_integrations_organisation_id.py @@ -0,0 +1,33 @@ +"""rename integrations organisation_id to organization_id + +Revision ID: 19d2a4b6c8ef +Revises: 0a1b2c3d4e5f +Create Date: 2026-05-19 00:00:00.000000 + +""" + +from typing import Sequence, Union + +from alembic import op + +# revision identifiers, used by Alembic. +revision: str = "19d2a4b6c8ef" +down_revision: Union[str, None] = "0a1b2c3d4e5f" +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + op.alter_column( + "integrations", + "organisation_id", + new_column_name="organization_id", + ) + + +def downgrade() -> None: + op.alter_column( + "integrations", + "organization_id", + new_column_name="organisation_id", + ) diff --git a/api/constants.py b/api/constants.py index a98612f..ef949eb 100644 --- a/api/constants.py +++ b/api/constants.py @@ -143,11 +143,4 @@ FORCE_TURN_RELAY = os.getenv("FORCE_TURN_RELAY", "false").lower() == "true" OSS_JWT_SECRET = os.getenv("OSS_JWT_SECRET", "change-me-in-production") OSS_JWT_EXPIRY_HOURS = int(os.getenv("OSS_JWT_EXPIRY_HOURS", "720")) # 30 days -# REMOVE-AFTER 2026-05-15: transitional flag. When True, Telnyx webhook -# signature verification is skipped for configs that have no -# webhook_public_key set (existing configs predating the field). Set in prod -# through 2026-05-15 to give users time to add their key; once removed, -# configs without a key will fail signature verification. -TELNYX_WEBHOOK_VERIFICATION_OPTIONAL = ( - os.getenv("TELNYX_WEBHOOK_VERIFICATION_OPTIONAL", "false").lower() == "true" -) +TUNER_BASE_URL = os.getenv("TUNER_BASE_URL", "https://api.usetuner.ai") diff --git a/api/db/integration_client.py b/api/db/integration_client.py index e1a7c54..6837be7 100644 --- a/api/db/integration_client.py +++ b/api/db/integration_client.py @@ -14,7 +14,7 @@ class IntegrationClient(BaseDBClient): async with self.async_session() as session: result = await session.execute( select(IntegrationModel).where( - IntegrationModel.organisation_id == organization_id + IntegrationModel.organization_id == organization_id ) ) return result.scalars().all() @@ -23,7 +23,7 @@ class IntegrationClient(BaseDBClient): self, integration_id: str, provider: str, - organisation_id: int, + organization_id: int, connection_details: dict, created_by: int = None, is_active: bool = True, @@ -32,7 +32,7 @@ class IntegrationClient(BaseDBClient): async with self.async_session() as session: new_integration = IntegrationModel( integration_id=integration_id, - organisation_id=organisation_id, + organization_id=organization_id, created_by=created_by, is_active=is_active, provider=provider, @@ -96,7 +96,7 @@ class IntegrationClient(BaseDBClient): async with self.async_session() as session: result = await session.execute( select(IntegrationModel).where( - IntegrationModel.organisation_id == organization_id, + IntegrationModel.organization_id == organization_id, IntegrationModel.is_active == True, ) ) diff --git a/api/db/models.py b/api/db/models.py index 2771025..08b5954 100644 --- a/api/db/models.py +++ b/api/db/models.py @@ -292,8 +292,10 @@ class IntegrationModel(Base): __tablename__ = "integrations" id = Column(Integer, primary_key=True, index=True) - integration_id = Column(String, nullable=False, index=True) # Nango Connection ID - organisation_id = Column(Integer, ForeignKey("organizations.id"), nullable=False) + integration_id = Column( + String, nullable=False, index=True + ) # External connection ID + organization_id = Column(Integer, ForeignKey("organizations.id"), nullable=False) provider = Column(String, nullable=False) created_by = Column(Integer, ForeignKey("users.id")) is_active = Column(Boolean, default=True, nullable=False) @@ -598,8 +600,8 @@ class CampaignModel(Base): ) # Source configuration - source_type = Column(String, nullable=False, default="google-sheet") - source_id = Column(String, nullable=False) # Sheet URL + source_type = Column(String, nullable=False, default="csv") + source_id = Column(String, nullable=False) # CSV file key # State management state = Column( diff --git a/api/enums.py b/api/enums.py index 8497ddc..1255705 100644 --- a/api/enums.py +++ b/api/enums.py @@ -134,6 +134,7 @@ class ToolCategory(Enum): CALCULATOR = "calculator" # Built-in calculator tool NATIVE = "native" # Built-in integrations (future: dtmf_input) INTEGRATION = "integration" # Third-party integrations (future: Google Calendar, Salesforce, etc.) + MCP = "mcp" # Customer-provided MCP server exposing a tool catalog class ToolStatus(Enum): diff --git a/api/mcp_server/auth.py b/api/mcp_server/auth.py index 33a4a46..6c19d61 100644 --- a/api/mcp_server/auth.py +++ b/api/mcp_server/auth.py @@ -18,7 +18,9 @@ async def authenticate_mcp_request() -> UserModel: the `langfuse.user.id` / `langfuse.session.id` attributes make the span filterable in the Langfuse UI. """ - headers = get_http_headers() + # FastMCP strips Authorization by default unless explicitly included. + # Preserve it here so Bearer API keys work for MCP tool invocations. + headers = get_http_headers(include={"authorization"}) api_key = headers.get("x-api-key") if not api_key: auth = headers.get("authorization", "") diff --git a/api/mcp_server/instructions.py b/api/mcp_server/instructions.py index f0b2618..3c0b3af 100644 --- a/api/mcp_server/instructions.py +++ b/api/mcp_server/instructions.py @@ -7,6 +7,14 @@ handling, hard constraints). Design-level per-field guidance belongs in each `PropertySpec.llm_hint`; it flows out through `get_node_type` and doesn't need to be repeated here. +Tool names, parameters, and per-tool `error_code` values are NOT +authoritative here — they reach the model dynamically via `tools/list` +from each tool's own signature and docstring. Reference tools by bare +name and describe orchestration; do not restate signatures (they drift) +or re-enumerate error codes (document those on the tool itself). +`test_mcp_instructions_drift.py` fails if this guide names a tool that +is not registered, or if a tool's error codes aren't in its docstring. + Extend based on real LLM failures — every bullet below ideally maps to a mistake the system has seen at least once. """ @@ -16,18 +24,23 @@ You build and edit Dograh voice-AI workflows by emitting TypeScript that uses th ## Call order +### Reading documentation +1. `search_docs` — use first for keyword or acronym lookup when the user is asking how Dograh works or how to configure something. +2. `read_doc` — fetch the full page once one result looks likely. Prefer this over reasoning from search summaries alone. +3. `list_docs` — use when the user wants to browse a topic area or when search terms are too vague. Call it with no arguments for the top-level sections; returned section paths feed back into `list_docs`, returned page paths feed into `read_doc`. + ### Editing an existing workflow 1. `list_workflows` — locate the target workflow. -2. `get_workflow_code(workflow_id)` — fetch the current source. -3. (optional) `list_node_types` / `get_node_type(name)` — consult before adding or editing a node type whose fields aren't already visible in the current code. +2. `get_workflow_code` — fetch the current source for that workflow. +3. (optional) `list_node_types` / `get_node_type` — consult before adding or editing a node type whose fields aren't already visible in the current code. 4. Mutate the code in place. Preserve existing nodes, edges, and variable names unless the task requires removing or renaming them. -5. `save_workflow(workflow_id, code)` — persist as a new draft. The published version is untouched. +5. `save_workflow` — persist as a new draft. The published version is untouched. ### Creating a new workflow 1. Create a simple 1-node workflow with only `startCall`. The user can iteratively add complexity by editing it. -2. `list_node_types` / `get_node_type(name)` — consult to learn the fields available on the node types you intend to use. +2. `list_node_types` / `get_node_type` — consult to learn the fields available on the node types you intend to use. 3. Author SDK TypeScript from scratch. The `new Workflow({ name: "..." })` call is required — `name` becomes the workflow's display name. -4. `create_workflow(code)` — persists a new workflow as version 1 (published). Returns the new `workflow_id`. For subsequent edits use `save_workflow(workflow_id, code)` (which writes a draft). +4. `create_workflow` — persists a new workflow as version 1 (published). Returns the new `workflow_id`. For subsequent edits use `save_workflow` (which writes a draft). ## Allowed source shape @@ -68,14 +81,7 @@ Example: ## Iterating on errors -`save_workflow` and `create_workflow` return one of: -- `parse_error` — Disallowed construct (see grammar above) or malformed TypeScript. -- `validation_error` — Node data failed spec validation (unknown field, missing required, wrong type, bad `options` value). -- `graph_validation` — Structural rule broken (missing startCall, unreachable node, edge to/from wrong node type). -- `missing_name` — (`create_workflow` only) `new Workflow({ name })` is absent or empty. -- `bridge_error` — Internal; retry once, then surface to the user. - -Every error carries `line` and `column`. Fix at that location and resubmit the **complete source** — this tool does not accept patches. +A failed `save_workflow` / `create_workflow` returns a result with `saved`/`created` set to false, a machine-readable `error_code`, and a human-readable `error` message — carrying `line` and `column` when the problem is locatable in your source. The full set of `error_code` values and their meanings is documented on each tool (visible in its description). Read the `error` message, fix at the reported location, and resubmit the **complete source** — these tools do not accept patches. If a failure looks internal or transient rather than a problem with your code, retry once before surfacing it to the user. ## Field conventions diff --git a/api/mcp_server/server.py b/api/mcp_server/server.py index 12ad42e..5deef6c 100644 --- a/api/mcp_server/server.py +++ b/api/mcp_server/server.py @@ -1,4 +1,5 @@ from fastmcp import FastMCP +from mcp.types import ToolAnnotations from api.mcp_server.instructions import DOGRAH_MCP_INSTRUCTIONS from api.mcp_server.tools.catalog import ( @@ -8,6 +9,7 @@ from api.mcp_server.tools.catalog import ( list_tools, ) from api.mcp_server.tools.create_workflow import create_workflow +from api.mcp_server.tools.docs_search import list_docs, read_doc, search_docs from api.mcp_server.tools.get_workflow_code import get_workflow_code from api.mcp_server.tools.node_types import get_node_type, list_node_types from api.mcp_server.tools.save_workflow import save_workflow @@ -29,3 +31,13 @@ for _tool in ( save_workflow, ): mcp.tool(_tool) + +_DOCS_TOOL_ANNOTATIONS = ToolAnnotations( + readOnlyHint=True, + idempotentHint=True, + destructiveHint=False, + openWorldHint=False, +) + +for _tool in (list_docs, read_doc, search_docs): + mcp.tool(_tool, annotations=_DOCS_TOOL_ANNOTATIONS) diff --git a/api/mcp_server/tools/create_workflow.py b/api/mcp_server/tools/create_workflow.py index 38e4037..7953d6a 100644 --- a/api/mcp_server/tools/create_workflow.py +++ b/api/mcp_server/tools/create_workflow.py @@ -12,10 +12,10 @@ Execution flow mirrors `save_workflow`: 4. Persist via `db_client.create_workflow` — workflow row + v1 published definition in a single transaction. -Error codes surfaced to the LLM match `save_workflow`. An additional -`missing_name` error is returned when the source omits -`new Workflow({ name: "..." })` — the name is required and there is no -prior workflow to fall back to. +Each failure path returns an `error_code` via `_error_result`. Those +codes and their meanings are documented in the `create_workflow` +docstring (the description shipped to the LLM via `tools/list`); keep the +two in sync — `test_mcp_instructions_drift.py` enforces it. """ from __future__ import annotations @@ -86,6 +86,22 @@ async def create_workflow(code: str) -> dict[str, Any]: On success the new workflow is published as version 1. Use `save_workflow(workflow_id, code)` for subsequent edits — those go to a draft. + + On failure the result has `created: false`, a machine-readable + `error_code`, and a human-readable `error` (with file:line:column + where the problem is locatable). Resubmit the full corrected source — + patches are not accepted. Possible `error_code` values: + - `parse_error` — disallowed construct or malformed TypeScript. + - `validation_error` — node data failed spec validation (unknown + field, missing required, wrong type, option out of range). + - `schema_validation` — wire-format (DTO) rejection; rare. + - `graph_validation` — structural rule broken (e.g. no start node, + unreachable node, edge to/from the wrong node type). + - `missing_name` — `new Workflow({ name })` is absent or empty; the + name is required and there is no prior workflow to fall back to. + - `trigger_path_conflict` — a trigger node's path is already used by + another workflow in this organization; rename it and resubmit. + - `bridge_error` — internal/transient; retry once, then surface it. """ user = await authenticate_mcp_request() diff --git a/api/mcp_server/tools/docs_search.py b/api/mcp_server/tools/docs_search.py new file mode 100644 index 0000000..b679e44 --- /dev/null +++ b/api/mcp_server/tools/docs_search.py @@ -0,0 +1,704 @@ +"""MCP docs discovery tools over the Mintlify docs tree. + +The docs surface is intentionally split into three steps: + +- ``list_docs`` for lightweight navigation over the published hierarchy +- ``search_docs`` for keyword lookup across the visible docs catalog +- ``read_doc`` for the full content of one chosen page (or one section) + +The runtime index is derived from ``docs/docs.json`` plus the referenced +``.mdx``/``.md`` files. That keeps navigation, ordering, and visibility in +sync with the published docs rather than indexing every file under ``docs/``. +""" + +from __future__ import annotations + +import json +import os +import re +from collections import Counter +from dataclasses import dataclass, replace +from functools import lru_cache +from pathlib import Path +from typing import Any + +import yaml +from fastapi import HTTPException + +from api.mcp_server.auth import authenticate_mcp_request +from api.mcp_server.tracing import traced_tool + +DOCS_SEARCH_MAX_LIMIT = 25 +DOCS_LIST_MAX_DEPTH = 3 +_ROOT_SECTION_PATH = "__root__" + +_TOKEN_RE = re.compile(r"[A-Za-z0-9_]+") +_FRONTMATTER_RE = re.compile(r"\A---\s*\n(.*?)\n---\s*\n?", re.DOTALL) +_HEADING_RE = re.compile(r"^(#{1,6})\s+(.*?)\s*$", re.MULTILINE) +_STOPWORDS = { + "a", + "an", + "and", + "are", + "at", + "be", + "by", + "can", + "do", + "for", + "from", + "how", + "i", + "if", + "in", + "is", + "it", + "me", + "my", + "of", + "on", + "or", + "the", + "to", + "what", + "when", + "where", + "with", + "you", + "your", +} + + +@dataclass(frozen=True) +class DocSection: + title: str + slug: str + level: int + content: str + + +@dataclass(frozen=True) +class DocPage: + path: str + file_path: str + title: str + description: str + llm_hint: str + aliases: tuple[str, ...] + breadcrumb: tuple[str, ...] + content: str + sections: tuple[DocSection, ...] + order: int + + def breadcrumb_text(self) -> str: + return " > ".join(self.breadcrumb) + + def routing_hint(self) -> str: + return self.llm_hint or self.description + + def to_catalog_dict(self, section: DocSection | None = None) -> dict: + data = { + "kind": "page", + "path": self.path, + "title": self.title, + "breadcrumb": self.breadcrumb_text(), + "llm_hint": self.routing_hint(), + } + if section is not None: + data["section_title"] = section.title + data["section_slug"] = section.slug + return _compact_dict(data) + + def to_read_dict(self, section: DocSection | None = None) -> dict: + active_section = section + content = self.content + if active_section is not None: + content = active_section.content + + return _compact_dict( + { + "path": self.path, + "title": self.title, + "breadcrumb": self.breadcrumb_text(), + "llm_hint": self.routing_hint(), + "section_title": active_section.title if active_section else None, + "section_slug": active_section.slug if active_section else None, + "content": content, + "sections": [ + {"title": sec.title, "slug": sec.slug} + for sec in self.sections + if sec.title and sec.slug + ], + } + ) + + +@dataclass(frozen=True) +class NavSection: + path: str + title: str + breadcrumb: tuple[str, ...] + children: tuple[tuple[str, str], ...] + descendant_page_count: int = 0 + + def breadcrumb_text(self) -> str: + return " > ".join(self.breadcrumb) + + def to_mcp_dict(self) -> dict: + hint = None + if self.descendant_page_count: + hint = f"Browse {self.descendant_page_count} docs in this section." + return _compact_dict( + { + "kind": "section", + "path": self.path, + "title": self.title, + "breadcrumb": self.breadcrumb_text(), + "llm_hint": hint, + "has_children": bool(self.children), + "child_count": len(self.children), + "page_count": self.descendant_page_count, + } + ) + + +@dataclass(frozen=True) +class DocsIndex: + pages_by_path: dict[str, DocPage] + sections_by_path: dict[str, NavSection] + + +def _compact_dict(data: dict[str, Any]) -> dict[str, Any]: + return { + key: value for key, value in data.items() if value not in (None, "", [], (), {}) + } + + +def _slugify(value: str) -> str: + slug = re.sub(r"[^a-z0-9]+", "-", value.lower()).strip("-") + return slug or "section" + + +def _coerce_docs_root(candidate: Path) -> Path | None: + candidate = candidate.expanduser().resolve() + if (candidate / "docs.json").is_file(): + return candidate + nested = candidate / "docs" + if (nested / "docs.json").is_file(): + return nested + return None + + +def _resolve_docs_root() -> Path | None: + """Return the path to the on-disk docs tree, or None if not found.""" + override = os.environ.get("DOGRAH_DOCS_PATH") + if override: + resolved = _coerce_docs_root(Path(override)) + if resolved is not None: + return resolved + + docker_default = _coerce_docs_root(Path("/app/docs")) + if docker_default is not None: + return docker_default + + for parent in Path(__file__).resolve().parents: + resolved = _coerce_docs_root(parent / "docs") + if resolved is not None: + return resolved + + return None + + +def _split_frontmatter(contents: str) -> tuple[dict[str, Any], str]: + match = _FRONTMATTER_RE.match(contents) + if not match: + return {}, contents + try: + frontmatter = yaml.safe_load(match.group(1)) or {} + except yaml.YAMLError: + return {}, contents + if not isinstance(frontmatter, dict): + frontmatter = {} + return frontmatter, contents[match.end() :].lstrip("\n") + + +def _strip_frontmatter(contents: str) -> str: + """Drop the YAML frontmatter block from a docs page body.""" + return _split_frontmatter(contents)[1] + + +def _clean_heading_text(raw: str) -> str: + text = re.sub(r"\s*\{#.*\}\s*$", "", raw.strip()) + return " ".join(text.split()) + + +def _extract_page_title(contents: str, fallback: str) -> str: + """Pull a human-readable title for a docs page.""" + frontmatter, body = _split_frontmatter(contents) + title = frontmatter.get("title") + if isinstance(title, str) and title.strip(): + return title.strip() + + match = _HEADING_RE.search(body) + if match: + return _clean_heading_text(match.group(2)) + + return fallback + + +def _normalize_text(value: Any) -> str: + if isinstance(value, str): + return " ".join(value.strip().split()) + return "" + + +def _normalize_aliases(value: Any) -> tuple[str, ...]: + if isinstance(value, str): + aliases = [value] + elif isinstance(value, list): + aliases = [item for item in value if isinstance(item, str)] + else: + aliases = [] + return tuple(alias.strip() for alias in aliases if alias.strip()) + + +def _extract_sections(body: str) -> tuple[DocSection, ...]: + matches = list(_HEADING_RE.finditer(body)) + stripped_body = body.strip() + if not matches: + if not stripped_body: + return () + return ( + DocSection( + title="Overview", + slug="overview", + level=1, + content=stripped_body, + ), + ) + + sections: list[DocSection] = [] + preamble = body[: matches[0].start()].strip() + if preamble: + sections.append( + DocSection( + title="Overview", + slug="overview", + level=1, + content=preamble, + ) + ) + + for index, match in enumerate(matches): + start = match.start() + end = matches[index + 1].start() if index + 1 < len(matches) else len(body) + title = _clean_heading_text(match.group(2)) + sections.append( + DocSection( + title=title or "Section", + slug=_slugify(title or "section"), + level=len(match.group(1)), + content=body[start:end].strip(), + ) + ) + return tuple(sections) + + +def _tokenize_text(text: str) -> list[str]: + return [ + token + for token in _TOKEN_RE.findall(text.lower()) + if len(token) >= 2 and token not in _STOPWORDS + ] + + +def _tokenize_query(query: str) -> list[str]: + """Split a user query into lowercased keyword terms.""" + seen: set[str] = set() + terms: list[str] = [] + for token in _TOKEN_RE.findall(query.lower()): + if len(token) < 2 or token in _STOPWORDS or token in seen: + continue + seen.add(token) + terms.append(token) + return terms + + +def _resolve_doc_file(root: Path, route_path: str) -> Path | None: + candidates = ( + root / f"{route_path}.mdx", + root / f"{route_path}.md", + root / route_path / "index.mdx", + root / route_path / "index.md", + ) + for candidate in candidates: + if candidate.is_file(): + return candidate + return None + + +def _build_doc_page( + root: Path, + route_path: str, + *, + breadcrumb: tuple[str, ...], + order: int, +) -> DocPage | None: + file_path = _resolve_doc_file(root, route_path) + if file_path is None: + return None + try: + contents = file_path.read_text(encoding="utf-8") + except (OSError, UnicodeDecodeError): + return None + + frontmatter, body = _split_frontmatter(contents) + fallback = route_path.rsplit("/", 1)[-1].replace("-", " ").title() + title = _extract_page_title(contents, fallback=fallback) + description = _normalize_text(frontmatter.get("description")) + llm_hint = _normalize_text(frontmatter.get("llm_hint")) + aliases = _normalize_aliases(frontmatter.get("aliases")) + content = body.strip() + + return DocPage( + path=route_path, + file_path=file_path.relative_to(root).as_posix(), + title=title, + description=description, + llm_hint=llm_hint, + aliases=aliases, + breadcrumb=breadcrumb, + content=content, + sections=_extract_sections(content), + order=order, + ) + + +def _score_counter(counter: Counter[str], term: str, *, weight: int, cap: int) -> int: + return min(counter.get(term, 0), cap) * weight + + +def _normalized_phrase(text: str) -> str: + return " ".join(_tokenize_text(text)) + + +def _score_section(section: DocSection, terms: list[str]) -> int: + title_counts = Counter(_tokenize_text(section.title)) + body_counts = Counter(_tokenize_text(section.content)) + score = 0 + matched_terms = 0 + for term in terms: + term_score = _score_counter( + title_counts, term, weight=7, cap=2 + ) + _score_counter(body_counts, term, weight=1, cap=4) + if term_score: + matched_terms += 1 + score += term_score + score += matched_terms * 4 + + phrase = " ".join(terms) + if phrase and phrase in _normalized_phrase(section.content): + score += 6 + return score + + +def _score_page(page: DocPage, terms: list[str]) -> tuple[int, DocSection | None]: + if not terms: + return 0, None + + path_counts = Counter(_tokenize_text(page.path)) + title_counts = Counter(_tokenize_text(page.title)) + breadcrumb_counts = Counter(_tokenize_text(" ".join(page.breadcrumb))) + hint_counts = Counter(_tokenize_text(page.routing_hint())) + alias_counts = Counter(_tokenize_text(" ".join(page.aliases))) + + score = 0 + matched_terms = 0 + for term in terms: + term_score = ( + _score_counter(path_counts, term, weight=6, cap=3) + + _score_counter(title_counts, term, weight=10, cap=2) + + _score_counter(breadcrumb_counts, term, weight=4, cap=2) + + _score_counter(hint_counts, term, weight=7, cap=3) + + _score_counter(alias_counts, term, weight=7, cap=3) + ) + if term_score: + matched_terms += 1 + score += term_score + + best_section = None + best_section_score = 0 + for section in page.sections: + section_score = _score_section(section, terms) + if section_score > best_section_score: + best_section = section + best_section_score = section_score + + if score == 0 and best_section_score == 0: + return 0, None + + score += matched_terms * 8 + best_section_score + + phrase = " ".join(terms) + if phrase: + if phrase in _normalized_phrase(page.title): + score += 12 + elif phrase in _normalized_phrase(page.routing_hint()): + score += 8 + elif phrase in _normalized_phrase(page.path): + score += 8 + elif best_section is not None and phrase in _normalized_phrase( + best_section.content + ): + score += 4 + + return score, best_section + + +def _set_descendant_counts( + sections_by_path: dict[str, NavSection], + section_path: str, +) -> int: + section = sections_by_path[section_path] + page_count = 0 + for child_kind, child_path in section.children: + if child_kind == "page": + page_count += 1 + else: + page_count += _set_descendant_counts(sections_by_path, child_path) + sections_by_path[section_path] = replace(section, descendant_page_count=page_count) + return page_count + + +@lru_cache(maxsize=1) +def _docs_index() -> DocsIndex: + root = _resolve_docs_root() + if root is None: + return DocsIndex(pages_by_path={}, sections_by_path={}) + + try: + docs_config = json.loads((root / "docs.json").read_text(encoding="utf-8")) + except (OSError, UnicodeDecodeError, json.JSONDecodeError): + return DocsIndex(pages_by_path={}, sections_by_path={}) + + pages_by_path: dict[str, DocPage] = {} + sections_by_path: dict[str, NavSection] = {} + page_order = 0 + + def ensure_unique_section_path(base_path: str) -> str: + if base_path not in sections_by_path: + return base_path + suffix = 2 + while f"{base_path}-{suffix}" in sections_by_path: + suffix += 1 + return f"{base_path}-{suffix}" + + def walk_pages( + items: list[Any], + *, + section_path: str, + section_title: str, + ancestor_breadcrumb: tuple[str, ...], + ) -> None: + nonlocal page_order + children: list[tuple[str, str]] = [] + page_breadcrumb = ancestor_breadcrumb + (section_title,) + + for item in items: + if isinstance(item, str): + route_path = item.strip("/") + if not route_path: + continue + if route_path not in pages_by_path: + page = _build_doc_page( + root, + route_path, + breadcrumb=page_breadcrumb, + order=page_order, + ) + if page is not None: + pages_by_path[route_path] = page + page_order += 1 + if route_path in pages_by_path: + children.append(("page", route_path)) + continue + + if not isinstance(item, dict): + continue + group_title = str(item.get("group", "")).strip() + nested_pages = item.get("pages") + if not group_title or not isinstance(nested_pages, list): + continue + + child_path = ensure_unique_section_path( + f"{section_path}/{_slugify(group_title)}" + ) + walk_pages( + nested_pages, + section_path=child_path, + section_title=group_title, + ancestor_breadcrumb=page_breadcrumb, + ) + children.append(("section", child_path)) + + sections_by_path[section_path] = NavSection( + path=section_path, + title=section_title, + breadcrumb=ancestor_breadcrumb, + children=tuple(children), + ) + + root_children: list[tuple[str, str]] = [] + tabs = docs_config.get("navigation", {}).get("tabs", []) + for tab in tabs: + if not isinstance(tab, dict): + continue + tab_title = str(tab.get("tab", "")).strip() or "Docs" + for group in tab.get("groups", []): + if not isinstance(group, dict): + continue + group_title = str(group.get("group", "")).strip() + group_pages = group.get("pages") + if not group_title or not isinstance(group_pages, list): + continue + top_level_path = ensure_unique_section_path( + f"{_slugify(tab_title)}/{_slugify(group_title)}" + ) + walk_pages( + group_pages, + section_path=top_level_path, + section_title=group_title, + ancestor_breadcrumb=(tab_title,), + ) + root_children.append(("section", top_level_path)) + + sections_by_path[_ROOT_SECTION_PATH] = NavSection( + path=_ROOT_SECTION_PATH, + title="Docs", + breadcrumb=(), + children=tuple(root_children), + ) + _set_descendant_counts(sections_by_path, _ROOT_SECTION_PATH) + + return DocsIndex(pages_by_path=pages_by_path, sections_by_path=sections_by_path) + + +def _get_page_or_404(path: str) -> DocPage: + page = _docs_index().pages_by_path.get(path.strip("/")) + if page is None: + raise HTTPException(status_code=404, detail=f"Unknown docs page: {path!r}") + return page + + +def _find_section(page: DocPage, section: str) -> DocSection | None: + target = section.strip().lower() + for candidate in page.sections: + if candidate.slug.lower() == target or candidate.title.lower() == target: + return candidate + return None + + +def _expand_nav_entries( + index: DocsIndex, + section_path: str, + depth: int, +) -> list[dict]: + section = index.sections_by_path[section_path] + results: list[dict] = [] + for child_kind, child_path in section.children: + if child_kind == "section": + child_section = index.sections_by_path[child_path] + results.append(child_section.to_mcp_dict()) + if depth > 1: + results.extend(_expand_nav_entries(index, child_path, depth - 1)) + else: + results.append(index.pages_by_path[child_path].to_catalog_dict()) + return results + + +@traced_tool +async def list_docs(path: str | None = None, depth: int = 1) -> list[dict]: + """Browse the Dograh docs hierarchy before reading a page in full. + + ``path`` addresses navigation sections exposed by this tool. Page paths + returned by ``search_docs`` and ``read_doc`` are the published docs routes + instead, for example ``voice-agent/tools/mcp-tool``. + """ + await authenticate_mcp_request() + + if depth < 1 or depth > DOCS_LIST_MAX_DEPTH: + raise ValueError(f"`depth` must be between 1 and {DOCS_LIST_MAX_DEPTH}.") + + index = _docs_index() + if not index.sections_by_path: + return [] + + if path is None: + return _expand_nav_entries(index, _ROOT_SECTION_PATH, depth) + + normalized = path.strip("/") + if normalized in index.sections_by_path: + return _expand_nav_entries(index, normalized, depth) + if normalized in index.pages_by_path: + return [index.pages_by_path[normalized].to_catalog_dict()] + + raise HTTPException(status_code=404, detail=f"Unknown docs section: {path!r}") + + +@traced_tool +async def read_doc(path: str, section: str | None = None) -> dict: + """Read one docs page after you have narrowed to a likely match.""" + await authenticate_mcp_request() + + if not isinstance(path, str) or not path.strip(): + raise ValueError("`path` must be a non-empty string.") + + page = _get_page_or_404(path) + active_section = None + if section is not None: + active_section = _find_section(page, section) + if active_section is None: + raise HTTPException( + status_code=404, + detail=f"Unknown section {section!r} for docs page {path!r}", + ) + return page.to_read_dict(section=active_section) + + +@traced_tool +async def search_docs(query: str, limit: int = 5) -> list[dict]: + """Search the Dograh documentation and return a lean ranked shortlist. + + Use this first for keyword or acronym lookup. Once the right page looks + likely, call ``read_doc(path)`` instead of reasoning from summaries alone. + """ + await authenticate_mcp_request() + + if not isinstance(query, str) or not query.strip(): + raise ValueError("`query` must be a non-empty string.") + if limit < 1: + raise ValueError("`limit` must be at least 1.") + + terms = _tokenize_query(query) + if not terms: + raise ValueError( + "`query` must contain at least one non-stopword alphanumeric term." + ) + + index = _docs_index() + if not index.pages_by_path: + return [] + + capped_limit = min(limit, DOCS_SEARCH_MAX_LIMIT) + ranked: list[tuple[int, int, DocPage, DocSection | None]] = [] + for page in index.pages_by_path.values(): + score, best_section = _score_page(page, terms) + if score <= 0: + continue + ranked.append((score, page.order, page, best_section)) + + ranked.sort(key=lambda item: (-item[0], item[1], item[2].path)) + return [ + page.to_catalog_dict(section=best_section) + for _, _, page, best_section in ranked[:capped_limit] + ] diff --git a/api/mcp_server/tools/node_types.py b/api/mcp_server/tools/node_types.py index 04e8c55..83d2369 100644 --- a/api/mcp_server/tools/node_types.py +++ b/api/mcp_server/tools/node_types.py @@ -40,15 +40,17 @@ async def list_node_types() -> dict: @traced_tool async def get_node_type(name: str) -> dict: - """Fetch the full schema for a node type, including every property's - type, default, conditional visibility rules, and LLM-readable - description, plus worked examples. + """Fetch the authoring schema for a node type: each property's name, + type, default, requiredness, enum options, validation bounds, and + LLM-readable description, plus worked examples and graph constraints. - Use the property `description` and the `examples` list to understand - semantics — types alone are not enough. + UI-only metadata (display labels, placeholders, conditional visibility + rules, renderer hints) is intentionally omitted — set only the fields + you need. Use the property `description`/`llm_hint` and the `examples` + list to understand semantics; types alone are not enough. """ await authenticate_mcp_request() spec = get_spec(name) if spec is None: raise HTTPException(status_code=404, detail=f"Unknown node type: {name!r}") - return spec.model_dump(mode="json") + return spec.to_mcp_dict() diff --git a/api/mcp_server/tools/save_workflow.py b/api/mcp_server/tools/save_workflow.py index 41130d7..5a11a97 100644 --- a/api/mcp_server/tools/save_workflow.py +++ b/api/mcp_server/tools/save_workflow.py @@ -10,16 +10,12 @@ Execution flow: 4. Save as a new draft via `db_client.save_workflow_draft` — the published version stays intact, so edits are rollback-safe. -Error codes surfaced to the LLM: - parse_error — TS parse failed or a disallowed construct was used - validation_error — node data failed spec validation (unknown field, - missing required, wrong type, option out of range) - schema_validation — ReactFlowDTO Pydantic rejection (rare; parser bug) - graph_validation — semantic graph rule broken (e.g. no start node) - bridge_error — Node subprocess failed before returning JSON - -All LLM-facing errors include file:line:column where available so the -LLM can correct its code directly. +Each failure path returns an `error_code` via `_error_result`. Those +codes and their meanings are documented in the `save_workflow` docstring +(the description shipped to the LLM via `tools/list`); keep the two in +sync — `test_mcp_instructions_drift.py` enforces it. All LLM-facing +errors include file:line:column where available so the LLM can correct +its code directly. """ from __future__ import annotations @@ -91,6 +87,18 @@ async def save_workflow(workflow_id: int, code: str) -> dict[str, Any]: On success the draft version is saved; the published version is untouched. + + On failure the result has `saved: false`, a machine-readable + `error_code`, and a human-readable `error` (with file:line:column + where the problem is locatable). Resubmit the full corrected source — + patches are not accepted. Possible `error_code` values: + - `parse_error` — disallowed construct or malformed TypeScript. + - `validation_error` — node data failed spec validation (unknown + field, missing required, wrong type, option out of range). + - `schema_validation` — wire-format (DTO) rejection; rare. + - `graph_validation` — structural rule broken (e.g. no start node, + unreachable node, edge to/from the wrong node type). + - `bridge_error` — internal/transient; retry once, then surface it. """ user = await authenticate_mcp_request() diff --git a/api/requirements.txt b/api/requirements.txt index 4801572..d96083e 100644 --- a/api/requirements.txt +++ b/api/requirements.txt @@ -18,4 +18,5 @@ bcrypt==5.0.0 email-validator==2.3.0 posthog==7.11.1 fastmcp==3.2.4 +tuner-pipecat-sdk==0.2.0 PyNaCl==1.6.2 diff --git a/api/routes/campaign.py b/api/routes/campaign.py index 407cef7..cb5f541 100644 --- a/api/routes/campaign.py +++ b/api/routes/campaign.py @@ -152,8 +152,8 @@ class CircuitBreakerConfigResponse(BaseModel): class CreateCampaignRequest(BaseModel): name: str = Field(..., min_length=1, max_length=255) workflow_id: int - source_type: str = Field(..., pattern="^(google-sheet|csv)$") - source_id: str # Google Sheet URL or CSV file key + source_type: str = Field(..., pattern="^csv$") + source_id: str # CSV file key # Optional during the legacy → multi-config migration window. Required in # a follow-up. When omitted, the dispatcher falls back to the org's # default config. @@ -929,8 +929,6 @@ async def get_campaign_source_download_url( user: UserModel = Depends(get_user), ) -> CampaignSourceDownloadResponse: """Get presigned download URL for campaign CSV source file - - Only works for CSV source type. For Google Sheets, use the source_id directly. Validates that the campaign belongs to the user's organization for security. """ # Verify campaign exists and belongs to organization diff --git a/api/routes/integration.py b/api/routes/integration.py deleted file mode 100644 index ae4d98c..0000000 --- a/api/routes/integration.py +++ /dev/null @@ -1,266 +0,0 @@ -""" -Route for 3rd party integrations. Currently being backed by nango. -""" - -from dataclasses import dataclass -from typing import Any, Dict, List, Optional, TypedDict - -from fastapi import APIRouter, Depends, HTTPException, Request -from loguru import logger -from pydantic import BaseModel - -from api.db import db_client -from api.db.models import UserModel -from api.services.auth.depends import get_user -from api.services.integrations.nango import nango_service - -router = APIRouter(prefix="/integration") - - -@dataclass -class IntegrationResponse: - id: int - integration_id: str - organisation_id: int - created_by: Optional[int] - provider: str - is_active: bool - created_at: str - action: str - provider_data: dict - - -class SessionResponse(TypedDict): - session_token: str - expires_at: str - - -class WebhookResponse(TypedDict): - status: str - message: str - - -class UpdateIntegrationRequest(BaseModel): - selected_files: List[Dict[str, Any]] - - -class AccessTokenResponse(BaseModel): - access_token: Optional[str] - refresh_token: Optional[str] - expires_at: Optional[str] - connection_id: str - - -def build_integration_response(integration) -> IntegrationResponse: - """Build a standardized integration response with provider-specific data.""" - provider_data = {} - - if integration.provider == "google-sheet": - # For Google Sheets, include selected_files - provider_data["selected_files"] = integration.connection_details.get( - "selected_files", [] - ) - elif integration.provider == "slack": - # For Slack, include channel information - channel = integration.connection_details.get("connection_config", {}).get( - "incoming_webhook.channel" - ) - if channel: - provider_data["channel"] = channel - - return IntegrationResponse( - id=integration.id, - integration_id=integration.integration_id, - organisation_id=integration.organisation_id, - created_by=integration.created_by, - provider=integration.provider, - is_active=integration.is_active, - created_at=integration.created_at.isoformat(), - action=integration.action, - provider_data=provider_data, - ) - - -@router.get("/") -async def get_integrations( - user: UserModel = Depends(get_user), -) -> list[IntegrationResponse]: - """ - Get all integrations for the user's selected organization. - - Returns: - List of integrations associated with the user's selected organization - """ - if not user.selected_organization_id: - raise HTTPException( - status_code=400, detail="No organization selected for the user" - ) - - integrations = await db_client.get_integrations_by_organization_id( - user.selected_organization_id - ) - - return [build_integration_response(integration) for integration in integrations] - - -@router.post("/session") -async def create_session( - user: UserModel = Depends(get_user), -) -> SessionResponse: - """ - Create a Nango session for the user's selected organization. - - Returns: - Session token and ID for the created session - """ - if not user.selected_organization_id: - raise HTTPException( - status_code=400, detail="No organization selected for the user" - ) - - try: - session_data = await nango_service.create_session( - user_id=str(user.id), organization_id=user.selected_organization_id - ) - - return { - "session_token": session_data["data"]["token"], - "expires_at": session_data["data"]["expires_at"], - } - except ValueError as e: - raise HTTPException(status_code=500, detail=str(e)) - except Exception as e: - raise HTTPException( - status_code=500, detail=f"Failed to create session: {str(e)}" - ) - - -@router.put("/{integration_id}") -async def update_integration( - integration_id: int, - request: UpdateIntegrationRequest, - user: UserModel = Depends(get_user), -) -> IntegrationResponse: - """ - Update an integration's selected files (for Google Sheets). - - Args: - integration_id: The ID of the integration to update - request: The update request containing selected files - user: The authenticated user - - Returns: - Updated integration details - """ - if not user.selected_organization_id: - raise HTTPException( - status_code=400, detail="No organization selected for the user" - ) - - # Get the integration first to verify ownership - integrations = await db_client.get_integrations_by_organization_id( - user.selected_organization_id - ) - - integration = next((i for i in integrations if i.id == integration_id), None) - if not integration: - raise HTTPException(status_code=404, detail="Integration not found") - - # Only allow updating selected_files for google-sheet provider - if integration.provider != "google-sheet": - raise HTTPException( - status_code=400, - detail="This endpoint only supports updating Google Sheet integrations", - ) - - # Update the connection_details with the new selected_files - updated_connection_details = integration.connection_details.copy() - updated_connection_details["selected_files"] = request.selected_files - - # Update the integration - updated_integration = await db_client.update_integration_connection_details( - integration_id=integration_id, connection_details=updated_connection_details - ) - - if not updated_integration: - raise HTTPException(status_code=500, detail="Failed to update integration") - - return build_integration_response(updated_integration) - - -@router.get("/{integration_id}/access-token") -async def get_integration_access_token( - integration_id: int, - user: UserModel = Depends(get_user), -) -> AccessTokenResponse: - """ - Get the latest access token for an integration from Nango. - - Args: - integration_id: The ID of the integration - user: The authenticated user - - Returns: - Dict containing access token and expiration info - """ - if not user.selected_organization_id: - raise HTTPException( - status_code=400, detail="No organization selected for the user" - ) - - # Get the integration to verify ownership and get connection details - integrations = await db_client.get_integrations_by_organization_id( - user.selected_organization_id - ) - - integration = next((i for i in integrations if i.id == integration_id), None) - if not integration: - raise HTTPException(status_code=404, detail="Integration not found") - - try: - # Fetch the latest access token from Nango - token_data = await nango_service.get_access_token( - connection_id=integration.integration_id, - provider_config_key=integration.provider, - ) - - # Extract relevant fields - return AccessTokenResponse( - access_token=token_data.get("credentials", {}).get("access_token"), - refresh_token=token_data.get("credentials", {}).get("refresh_token"), - expires_at=token_data.get("credentials", {}).get("expires_at"), - connection_id=integration.integration_id, - ) - - except Exception as e: - logger.error(f"Failed to get access token: {str(e)}") - raise HTTPException( - status_code=500, detail=f"Failed to fetch access token: {str(e)}" - ) - - -@router.post("/webhook", include_in_schema=False) -async def handle_nango_webhook( - request: Request, -) -> WebhookResponse: - """ - Handle Nango integration webhook requests. - - Processes webhook events from Nango when integrations are created/updated - and stores the integration details in the database. - - Args: - request: The raw FastAPI request object - - Returns: - WebhookResponse with status and message - """ - raw_body = await request.body() - - # Get signature from headers (you may need to adjust the header name) - signature = request.headers.get("X-Nango-Signature") - - # Use the nango service to process the webhook - result = await nango_service.process_webhook(raw_body, signature) - - return result diff --git a/api/routes/main.py b/api/routes/main.py index 514b65c..f62aa81 100644 --- a/api/routes/main.py +++ b/api/routes/main.py @@ -6,7 +6,6 @@ from api.routes.agent_stream import router as agent_stream_router from api.routes.auth import router as auth_router from api.routes.campaign import router as campaign_router from api.routes.credentials import router as credentials_router -from api.routes.integration import router as integration_router from api.routes.knowledge_base import router as knowledge_base_router from api.routes.node_types import router as node_types_router from api.routes.organization import router as organization_router @@ -27,6 +26,7 @@ from api.routes.workflow import router as workflow_router from api.routes.workflow_embed import router as workflow_embed_router from api.routes.workflow_recording import router as workflow_recording_router from api.routes.workflow_text_chat import router as workflow_text_chat_router +from api.services.integrations import all_routers router = APIRouter( tags=["main"], @@ -41,7 +41,6 @@ router.include_router(user_router) router.include_router(campaign_router) router.include_router(credentials_router) router.include_router(tool_router) -router.include_router(integration_router) router.include_router(organization_router) router.include_router(s3_router) router.include_router(service_keys_router) @@ -59,6 +58,9 @@ router.include_router(auth_router) router.include_router(node_types_router) router.include_router(agent_stream_router) +for _integration_router in all_routers(): + router.include_router(_integration_router) + class HealthResponse(BaseModel): status: str diff --git a/api/routes/public_download.py b/api/routes/public_download.py index 38793d9..c84cc24 100644 --- a/api/routes/public_download.py +++ b/api/routes/public_download.py @@ -1,8 +1,9 @@ """Public download endpoints for workflow recordings and transcripts. These endpoints provide secure, token-based public access to workflow artifacts -without requiring authentication. Tokens are generated on-demand when webhooks -are executed and included in the webhook payload. +without requiring authentication. Tokens are generated on-demand during +post-call processing for runs that execute integrations, QA, or campaign +reporting. """ from typing import Literal diff --git a/api/routes/tool.py b/api/routes/tool.py index ce3d217..b7fa97e 100644 --- a/api/routes/tool.py +++ b/api/routes/tool.py @@ -1,10 +1,12 @@ """API routes for managing tools.""" +import asyncio import re from datetime import datetime from typing import Annotated, Any, Dict, List, Literal, Optional, Union from fastapi import APIRouter, Depends, HTTPException +from loguru import logger from pydantic import BaseModel, Field, field_validator from api.db import db_client @@ -13,9 +15,23 @@ from api.enums import PostHogEvent, ToolCategory, ToolStatus from api.sdk_expose import sdk_expose from api.services.auth.depends import get_user from api.services.posthog_client import capture_event +from api.services.workflow.mcp_tool_session import discover_mcp_tools +from api.services.workflow.tools.mcp_tool import ( + McpDefinitionError, + validate_mcp_definition, +) +from api.services.workflow.tools.mcp_tool import ( + McpToolConfig as SharedMcpToolConfig, +) +from api.services.workflow.tools.mcp_tool import ( + McpToolDefinition as SharedMcpToolDefinition, +) router = APIRouter(prefix="/tools") +McpToolConfig = SharedMcpToolConfig +McpToolDefinition = SharedMcpToolDefinition + # Request/Response schemas class ToolParameter(BaseModel): @@ -183,6 +199,7 @@ ToolDefinition = Annotated[ EndCallToolDefinition, TransferCallToolDefinition, CalculatorToolDefinition, + McpToolDefinition, ], Field(discriminator="type"), ] @@ -248,6 +265,14 @@ class ToolResponse(BaseModel): from_attributes = True +class McpRefreshResponse(BaseModel): + """Result of re-discovering an MCP server's tool catalog.""" + + tool_uuid: str + discovered_tools: list = Field(default_factory=list) + error: Optional[str] = None + + def build_tool_response(tool, include_created_by: bool = False) -> ToolResponse: """Build a response from a tool model.""" created_by = None @@ -336,6 +361,52 @@ async def list_tools( return [build_tool_response(tool) for tool in tools] +async def _fetch_credential(credential_uuid: Optional[str], organization_id: int): + """Best-effort credential lookup for MCP auth. A missing/failed credential + degrades to ``None`` (unauthenticated) rather than failing the request.""" + if not credential_uuid: + return None + try: + return await db_client.get_credential_by_uuid(credential_uuid, organization_id) + except Exception as e: # noqa: BLE001 + logger.warning(f"MCP: credential fetch failed: {e}") + return None + + +async def _populate_discovered_tools(definition: dict, *, organization_id: int) -> dict: + """Best-effort: for an MCP definition, connect to the server, list its + tools, and overwrite ``config.discovered_tools``. Never raises and never + blocks tool save — a dead server yields ``discovered_tools: []``. Non-MCP + definitions pass through untouched.""" + if not isinstance(definition, dict) or definition.get("type") != "mcp": + return definition + try: + cfg = validate_mcp_definition(definition) + except McpDefinitionError: + return definition + + credential = await _fetch_credential(cfg.get("credential_uuid"), organization_id) + + # Run discovery in an isolated asyncio task so an anyio cancel-scope + # CancelledError doesn't bleed into the parent task and corrupt the + # subsequent DB write. _run() never raises (degrades to []). + async def _run() -> list: + try: + return await discover_mcp_tools( + url=cfg["url"], + credential=credential, + timeout_secs=cfg["timeout_secs"], + sse_read_timeout_secs=cfg["sse_read_timeout_secs"], + ) + except BaseException as e: # noqa: BLE001 + logger.warning(f"MCP discovery failed; caching empty list: {e}") + return [] + + discovered = await asyncio.ensure_future(_run()) + definition["config"]["discovered_tools"] = discovered + return definition + + @router.post("/") async def create_tool( request: CreateToolRequest, @@ -357,11 +428,16 @@ async def create_tool( validate_category(request.category) + definition = await _populate_discovered_tools( + request.definition.model_dump(), + organization_id=user.selected_organization_id, + ) + tool = await db_client.create_tool( organization_id=user.selected_organization_id, user_id=user.id, name=request.name, - definition=request.definition.model_dump(), + definition=definition, category=request.category, description=request.description, icon=request.icon, @@ -410,6 +486,67 @@ async def get_tool( return build_tool_response(tool, include_created_by=True) +@router.post("/{tool_uuid}/mcp/refresh") +async def refresh_mcp_tools( + tool_uuid: str, + user: UserModel = Depends(get_user), +) -> McpRefreshResponse: + """Re-discover an MCP tool's server catalog and overwrite the cached + ``definition.config.discovered_tools``. Server down → 200 with error + (cache not overwritten on transient failure).""" + if not user.selected_organization_id: + raise HTTPException( + status_code=400, detail="No organization selected for the user" + ) + + tool = await db_client.get_tool_by_uuid( + tool_uuid, user.selected_organization_id, include_archived=True + ) + if not tool: + raise HTTPException(status_code=404, detail="Tool not found") + if tool.category != ToolCategory.MCP.value: + raise HTTPException(status_code=400, detail="Tool is not an MCP tool") + + try: + cfg = validate_mcp_definition(tool.definition) + except McpDefinitionError as e: + raise HTTPException(status_code=400, detail=f"Invalid MCP definition: {e}") + + credential = await _fetch_credential( + cfg.get("credential_uuid"), user.selected_organization_id + ) + + try: + discovered = await discover_mcp_tools( + url=cfg["url"], + credential=credential, + timeout_secs=cfg["timeout_secs"], + sse_read_timeout_secs=cfg["sse_read_timeout_secs"], + ) + except Exception as e: # noqa: BLE001 + logger.warning(f"MCP refresh discovery failed: {e}") + discovered = [] + + if not discovered: + error = ( + f"Could not reach the MCP server at {cfg['url']} " + f"(or it exposes no tools). Previously cached list retained." + ) + # Do NOT clobber a previously-good cache with [] on a transient outage. + return McpRefreshResponse(tool_uuid=tool_uuid, discovered_tools=[], error=error) + + new_def = dict(tool.definition or {}) + new_def["config"] = {**new_def.get("config", {}), "discovered_tools": discovered} + await db_client.update_tool( + tool_uuid=tool_uuid, + organization_id=user.selected_organization_id, + definition=new_def, + ) + return McpRefreshResponse( + tool_uuid=tool_uuid, discovered_tools=discovered, error=None + ) + + @router.put("/{tool_uuid}") async def update_tool( tool_uuid: str, @@ -434,12 +571,21 @@ async def update_tool( if request.status: validate_status(request.status) + definition = ( + await _populate_discovered_tools( + request.definition.model_dump(), + organization_id=user.selected_organization_id, + ) + if request.definition + else None + ) + tool = await db_client.update_tool( tool_uuid=tool_uuid, organization_id=user.selected_organization_id, name=request.name, description=request.description, - definition=request.definition.model_dump() if request.definition else None, + definition=definition, icon=request.icon, icon_color=request.icon_color, status=request.status, diff --git a/api/routes/webrtc_signaling.py b/api/routes/webrtc_signaling.py index e39b13d..c2ea683 100644 --- a/api/routes/webrtc_signaling.py +++ b/api/routes/webrtc_signaling.py @@ -18,6 +18,7 @@ import asyncio import ipaddress import os from datetime import UTC, datetime +from enum import Enum from typing import Dict, List, Optional from aiortc import RTCIceServer @@ -49,6 +50,63 @@ from api.services.quota_service import check_dograh_quota router = APIRouter(prefix="/ws") +class NonRelayFilterPolicy(Enum): + """What to filter from non-relay ICE candidates. Relay candidates always pass.""" + + NONE = "none" # filter nothing — pass all candidates + PRIVATE = "private" # filter non-relay candidates with private/CGNAT IPs + ALL = "all" # filter all non-relay candidates (relay-only mode) + + +def is_local_or_cgnat_ip(ip_str: str) -> bool: + """Return True for RFC1918, loopback, link-local, and CGNAT addresses.""" + + try: + ip = ipaddress.ip_address(ip_str) + except ValueError: + return False + + is_cgnat = ip.version == 4 and ip in ipaddress.ip_network("100.64.0.0/10") + return ip.is_private or ip.is_loopback or ip.is_link_local or is_cgnat + + +def resolve_ice_filter_policies( + environment: str, + force_turn_relay: bool, + server_ip: str, +) -> tuple[NonRelayFilterPolicy, NonRelayFilterPolicy]: + """Resolve outbound and inbound non-relay filtering for this deployment.""" + + private_lan_deployment = ( + environment != Environment.LOCAL.value and is_local_or_cgnat_ip(server_ip) + ) + + if force_turn_relay: + # Relay-only diagnostics stay explicit. On private LAN deployments we + # must still accept inbound private candidates for relay<->host pairs. + outbound_policy = NonRelayFilterPolicy.ALL + inbound_policy = ( + NonRelayFilterPolicy.NONE + if private_lan_deployment + else NonRelayFilterPolicy.PRIVATE + ) + return outbound_policy, inbound_policy + + if environment == Environment.LOCAL.value or private_lan_deployment: + return NonRelayFilterPolicy.NONE, NonRelayFilterPolicy.NONE + + # Public remote deployment: drop private-IP host candidates to avoid + # coturn denied-peer-ip errors against Docker bridge and LAN interfaces. + return NonRelayFilterPolicy.PRIVATE, NonRelayFilterPolicy.PRIVATE + + +ICE_OUTBOUND_POLICY, ICE_INBOUND_POLICY = resolve_ice_filter_policies( + ENVIRONMENT, + FORCE_TURN_RELAY, + os.getenv("SERVER_IP", ""), +) + + def is_private_ip_candidate(candidate_str: str) -> bool: """Check if ICE candidate contains a private IP address or CGNAT IP Address. @@ -69,61 +127,58 @@ def is_private_ip_candidate(candidate_str: str) -> bool: if "typ" in parts: typ_index = parts.index("typ") ip_str = parts[typ_index - 2] - ip = ipaddress.ip_address(ip_str) - is_cgnat = ip in ipaddress.ip_network("100.64.0.0/10") - return ip.is_private or is_cgnat + return is_local_or_cgnat_ip(ip_str) except (ValueError, IndexError): pass return False -def filter_outbound_sdp(sdp: str) -> str: - """Strip ICE candidates from an outbound answer SDP based on env config. +def _keep_candidate(candidate_str: str, policy: NonRelayFilterPolicy) -> bool: + """Return True if this ICE candidate should be kept under the given policy. - Two filters apply: - - 1. In non-LOCAL environments, drop host candidates with private/CGNAT IPs. - aiortc gathers host candidates from every interface on the box, including - Docker bridges (172.17.0.1, 172.18.0.1). Advertising those to the browser - causes coturn "peer IP X denied" errors when the browser asks TURN to - permit them. - - 2. When FORCE_TURN_RELAY is set, drop every non-relay candidate so the - only path the browser can use is via TURN. Lets you verify TURN - connectivity end-to-end — if TURN is broken, the call simply fails. + Relay candidates always pass — a relay with a private IP (LAN TURN server) + must never be dropped regardless of policy. """ - if ENVIRONMENT == Environment.LOCAL.value and not FORCE_TURN_RELAY: + if " typ relay" in candidate_str: + return True + if policy == NonRelayFilterPolicy.NONE: + return True + if policy == NonRelayFilterPolicy.ALL: + return False + # PRIVATE: drop non-relay candidates with private/CGNAT IPs + return not is_private_ip_candidate(candidate_str) + + +def filter_outbound_sdp(sdp: str) -> str: + """Strip ICE candidates from an outbound answer SDP based on ICE_OUTBOUND_POLICY.""" + if ICE_OUTBOUND_POLICY == NonRelayFilterPolicy.NONE: return sdp lines = sdp.split("\r\n") filtered: List[str] = [] - dropped_non_relay = 0 + dropped = 0 kept_relay = 0 for line in lines: if line.startswith("a=candidate:"): candidate_str = line[2:] - if FORCE_TURN_RELAY and " typ relay" not in candidate_str: - dropped_non_relay += 1 + if not _keep_candidate(candidate_str, ICE_OUTBOUND_POLICY): + dropped += 1 continue - if ENVIRONMENT != Environment.LOCAL.value and is_private_ip_candidate( - candidate_str - ): - continue - if FORCE_TURN_RELAY: + if " typ relay" in candidate_str: kept_relay += 1 filtered.append(line) - if FORCE_TURN_RELAY: + if ICE_OUTBOUND_POLICY == NonRelayFilterPolicy.ALL: if kept_relay == 0: logger.warning( "FORCE_TURN_RELAY is on but the answer SDP has no relay candidates " - f"(dropped {dropped_non_relay} non-relay). TURN may be unreachable; " + f"(dropped {dropped} non-relay). TURN may be unreachable; " "the connection will fail." ) else: logger.info( f"FORCE_TURN_RELAY: kept {kept_relay} relay candidates, " - f"dropped {dropped_non_relay} non-relay" + f"dropped {dropped} non-relay" ) return "\r\n".join(filtered) @@ -370,9 +425,7 @@ class SignalingManager: Uses SmallWebRTC's native ICE trickling support via add_ice_candidate(). Candidates are parsed using aiortc's candidate_from_sdp() for proper formatting, consistent with SmallWebRTCRequestHandler.handle_patch_request(). - - In non-local environments, private IP candidates are filtered out to prevent - TURN relay errors when coturn blocks private IP ranges (denied-peer-ip). + Candidates are filtered according to ICE_INBOUND_POLICY before being added. """ pc_id = payload.get("pc_id") candidate_data = payload.get("candidate") @@ -389,13 +442,9 @@ class SignalingManager: if candidate_data: candidate_str = candidate_data.get("candidate", "") - # Filter out private IP candidates in non-local environments - # This prevents TURN relay errors when coturn blocks private IP ranges - if ENVIRONMENT != Environment.LOCAL.value and is_private_ip_candidate( - candidate_str - ): + if not _keep_candidate(candidate_str, ICE_INBOUND_POLICY): logger.debug( - f"Skipping private IP candidate in {ENVIRONMENT}: {candidate_str[:50]}..." + f"Dropping inbound candidate per policy ({ICE_INBOUND_POLICY.value}): {candidate_str[:50]}..." ) return diff --git a/api/services/auth/depends.py b/api/services/auth/depends.py index ecb793f..7ffabfb 100644 --- a/api/services/auth/depends.py +++ b/api/services/auth/depends.py @@ -129,22 +129,6 @@ async def get_user( return user_model -async def get_user_optional( - authorization: Annotated[str | None, Header()] = None, - x_api_key: Annotated[str | None, Header(alias="X-API-Key")] = None, -) -> UserModel | None: - """ - Same as get_user but returns None instead of raising 401 if unauthorized. - Useful for endpoints that need to work both with and without auth. - """ - try: - return await get_user(authorization, x_api_key) - except HTTPException as e: - if e.status_code == 401: - return None - raise - - async def _handle_oss_auth(authorization: str | None) -> UserModel: """ Handle authentication for OSS deployment mode. diff --git a/api/services/campaign/source_sync.py b/api/services/campaign/source_sync.py index 5393b65..1f0ee67 100644 --- a/api/services/campaign/source_sync.py +++ b/api/services/campaign/source_sync.py @@ -183,9 +183,7 @@ class CampaignSourceSyncService(ABC): async def get_source_credentials( self, organization_id: int, source_type: str ) -> Dict[str, Any]: - """Gets OAuth tokens or API credentials via Nango""" - # This would be implemented to work with Nango service - # For now, returning placeholder + """Gets source credentials when a sync service requires them.""" logger.info( f"Getting credentials for org {organization_id}, source {source_type}" ) diff --git a/api/services/campaign/source_sync_factory.py b/api/services/campaign/source_sync_factory.py index 2e05f1b..8725f4f 100644 --- a/api/services/campaign/source_sync_factory.py +++ b/api/services/campaign/source_sync_factory.py @@ -1,15 +1,12 @@ from api.services.campaign.source_sync import CampaignSourceSyncService from api.services.campaign.sources.csv import CSVSyncService -from api.services.campaign.sources.google_sheets import GoogleSheetsSyncService def get_sync_service(source_type: str) -> CampaignSourceSyncService: """Returns appropriate sync service based on source type""" services = { - "google-sheet": GoogleSheetsSyncService, "csv": CSVSyncService, - # Add more as needed: "hubspot": HubSpotSyncService, } service_class = services.get(source_type) diff --git a/api/services/campaign/sources/__init__.py b/api/services/campaign/sources/__init__.py index 3c283ee..1a4dc5d 100644 --- a/api/services/campaign/sources/__init__.py +++ b/api/services/campaign/sources/__init__.py @@ -1,5 +1,3 @@ """Campaign source sync services""" -from .google_sheets import GoogleSheetsSyncService - -__all__ = ["GoogleSheetsSyncService"] +__all__: list[str] = [] diff --git a/api/services/campaign/sources/google_sheets.py b/api/services/campaign/sources/google_sheets.py deleted file mode 100644 index ea473f5..0000000 --- a/api/services/campaign/sources/google_sheets.py +++ /dev/null @@ -1,224 +0,0 @@ -import re -from typing import Any, Dict, List, Optional - -import httpx -from loguru import logger - -from api.db import db_client -from api.services.campaign.source_sync import ( - CampaignSourceSyncService, - ValidationError, - ValidationResult, -) -from api.services.integrations.nango import NangoService - - -class GoogleSheetsSyncService(CampaignSourceSyncService): - """Implementation for Google Sheets synchronization""" - - def __init__(self): - self.nango_service = NangoService() - self.sheets_api_base = "https://sheets.googleapis.com/v4/spreadsheets" - - async def _get_access_token(self, organization_id: int) -> str: - """Get OAuth access token for Google Sheets via Nango.""" - integrations = await db_client.get_integrations_by_organization_id( - organization_id - ) - integration = None - for intg in integrations: - if intg.provider == "google-sheet" and intg.is_active: - integration = intg - break - - if not integration: - raise ValueError("Google Sheets integration not found or inactive") - - token_data = await self.nango_service.get_access_token( - connection_id=integration.integration_id, provider_config_key="google-sheet" - ) - return token_data["credentials"]["access_token"] - - async def _fetch_all_sheet_data( - self, sheet_url: str, organization_id: int - ) -> List[List[str]]: - """Fetch all data from a Google Sheet. Returns all rows including header.""" - access_token = await self._get_access_token(organization_id) - sheet_id = self._extract_sheet_id(sheet_url) - - metadata = await self._get_sheet_metadata(sheet_id, access_token) - if not metadata.get("sheets"): - raise ValueError("No sheets found in the spreadsheet") - - sheet_name = metadata["sheets"][0]["properties"]["title"] - - return await self._fetch_sheet_data(sheet_id, f"{sheet_name}!A:Z", access_token) - - async def validate_source( - self, source_id: str, organization_id: Optional[int] = None - ) -> ValidationResult: - """Validate a Google Sheet source for campaign creation.""" - if organization_id is None: - return ValidationResult( - is_valid=False, - error=ValidationError( - message="Organization ID is required for Google Sheets validation" - ), - ) - - # Validate URL format first - pattern = r"/spreadsheets/d/([a-zA-Z0-9-_]+)" - if not re.search(pattern, source_id): - return ValidationResult( - is_valid=False, - error=ValidationError( - message=f"Invalid Google Sheets URL: {source_id}" - ), - ) - - try: - rows = await self._fetch_all_sheet_data(source_id, organization_id) - except ValueError as e: - return ValidationResult( - is_valid=False, - error=ValidationError(message=str(e)), - ) - except httpx.HTTPStatusError as e: - logger.error(f"HTTP error fetching Google Sheet: {e.response.status_code}") - return ValidationResult( - is_valid=False, - error=ValidationError( - message=f"Failed to fetch Google Sheet data: {e.response.status_code}" - ), - ) - except Exception as e: - logger.error(f"Error fetching Google Sheet: {e}") - return ValidationResult( - is_valid=False, - error=ValidationError(message="Failed to fetch Google Sheet data"), - ) - - if not rows or len(rows) < 2: - return ValidationResult( - is_valid=False, - error=ValidationError( - message="Google Sheet must have a header row and at least one data row" - ), - ) - - headers = rows[0] - data_rows = rows[1:] - - return self.validate_source_data(headers, data_rows) - - async def sync_source_data(self, campaign_id: int) -> int: - """ - Fetches data from Google Sheets and creates queued_runs - """ - # Get campaign - campaign = await db_client.get_campaign_by_id(campaign_id) - if not campaign: - raise ValueError(f"Campaign {campaign_id} not found") - - rows = await self._fetch_all_sheet_data( - campaign.source_id, campaign.organization_id - ) - - if not rows or len(rows) < 2: - logger.warning(f"No data found in sheet for campaign {campaign_id}") - return 0 - - headers = self.normalize_headers(rows[0]) - data_rows = rows[1:] - - sheet_id = self._extract_sheet_id(campaign.source_id) - - queued_runs = [] - for idx, row_values in enumerate(data_rows, 1): - # Pad row to match headers length - padded_row = row_values + [""] * (len(headers) - len(row_values)) - - # Create context variables dict - context_vars = dict(zip(headers, padded_row)) - - # Skip if no phone number - if not context_vars.get("phone_number"): - logger.debug(f"Skipping row {idx}: no phone_number") - continue - - # Generate unique source UUID - source_uuid = f"sheet_{sheet_id}_row_{idx}" - - queued_runs.append( - { - "campaign_id": campaign_id, - "source_uuid": source_uuid, - "context_variables": context_vars, - "state": "queued", - } - ) - - # Bulk insert - if queued_runs: - await db_client.bulk_create_queued_runs(queued_runs) - logger.info( - f"Created {len(queued_runs)} queued runs for campaign {campaign_id}" - ) - - # Update campaign total_rows - await db_client.update_campaign( - campaign_id=campaign_id, - total_rows=len(queued_runs), - source_sync_status="completed", - ) - - return len(queued_runs) - - async def _fetch_sheet_data( - self, sheet_id: str, range: str, access_token: str - ) -> List[List[str]]: - """Fetch data from Google Sheets API""" - url = f"{self.sheets_api_base}/{sheet_id}/values/{range}" - headers = {"Authorization": f"Bearer {access_token}"} - - async with httpx.AsyncClient() as client: - response = await client.get(url, headers=headers) - response.raise_for_status() - - data = response.json() - return data.get("values", []) - - async def _get_sheet_metadata( - self, sheet_id: str, access_token: str - ) -> Dict[str, Any]: - """Get sheet metadata including sheet names""" - url = f"{self.sheets_api_base}/{sheet_id}" - headers = {"Authorization": f"Bearer {access_token}"} - - logger.debug(f"Fetching sheet metadata from URL: {url}") - logger.debug(f"Using sheet_id: {sheet_id}") - - async with httpx.AsyncClient() as client: - try: - response = await client.get(url, headers=headers) - response.raise_for_status() - return response.json() - except httpx.HTTPStatusError as e: - logger.error(f"HTTP error {e.response.status_code} for URL: {url}") - logger.error(f"Response body: {e.response.text}") - raise - except Exception as e: - logger.error(f"Error fetching sheet metadata: {e}") - raise - - def _extract_sheet_id(self, sheet_url: str) -> str: - """ - Extract sheet ID from various Google Sheets URL formats: - - https://docs.google.com/spreadsheets/d/{id}/edit - - https://docs.google.com/spreadsheets/d/{id}/edit#gid=0 - """ - pattern = r"/spreadsheets/d/([a-zA-Z0-9-_]+)" - match = re.search(pattern, sheet_url) - if match: - return match.group(1) - raise ValueError(f"Invalid Google Sheets URL: {sheet_url}") diff --git a/api/services/configuration/masking.py b/api/services/configuration/masking.py index 7676bfb..3aee31c 100644 --- a/api/services/configuration/masking.py +++ b/api/services/configuration/masking.py @@ -13,6 +13,7 @@ from typing import Any, Dict, Optional from api.schemas.user_configuration import UserConfiguration from api.services.configuration.registry import ServiceConfig +from api.services.integrations import get_node_secret_fields VISIBLE_CHARS = 4 # number of trailing characters to reveal MASK_CHAR = "*" @@ -129,14 +130,22 @@ def mask_user_config(config: UserConfiguration) -> Dict[str, Any]: # --------------------------------------------------------------------------- -# Workflow definition helpers – mask / merge QA-node API keys +# Workflow definition helpers – mask / merge node API keys # --------------------------------------------------------------------------- -_QA_API_KEY_FIELD = "qa_api_key" +_NODE_SECRET_FIELDS: dict[str, tuple[str, ...]] = { + "qa": ("qa_api_key",), +} + + +def _secret_fields_for_node_type(node_type: str | None) -> tuple[str, ...]: + if not node_type: + return () + return _NODE_SECRET_FIELDS.get(node_type, ()) or get_node_secret_fields(node_type) def mask_workflow_definition(workflow_definition: Optional[Dict]) -> Optional[Dict]: - """Return a *shallow copy* of *workflow_definition* with QA-node API keys masked.""" + """Return a copy of *workflow_definition* with node secret fields masked.""" if not workflow_definition: return workflow_definition @@ -144,47 +153,46 @@ def mask_workflow_definition(workflow_definition: Optional[Dict]) -> Optional[Di masked = copy.deepcopy(workflow_definition) for node in masked.get("nodes", []): - if node.get("type") != "qa": + secret_fields = _secret_fields_for_node_type(node.get("type")) + if not secret_fields: continue data = node.get("data", {}) - raw_key = data.get(_QA_API_KEY_FIELD) - if raw_key: - data[_QA_API_KEY_FIELD] = mask_key(raw_key) + for field in secret_fields: + raw_key = data.get(field) + if raw_key: + data[field] = mask_key(raw_key) return masked def merge_workflow_api_keys( incoming_definition: Optional[Dict], existing_definition: Optional[Dict] ) -> Optional[Dict]: - """Preserve real QA-node API keys when the incoming value is a masked placeholder. - - For each QA node in *incoming_definition*, if its ``qa_api_key`` equals - the masked form of the corresponding node in *existing_definition*, the - real key is restored so it is never lost. - """ + """Preserve real node secret fields when the incoming value is masked.""" if not incoming_definition or not existing_definition: return incoming_definition - # Build lookup: node-id → data for existing QA nodes - existing_qa: Dict[str, Dict] = {} + existing_nodes: Dict[str, Dict] = {} for node in existing_definition.get("nodes", []): - if node.get("type") == "qa": - existing_qa[node["id"]] = node.get("data", {}) + if _secret_fields_for_node_type(node.get("type")): + existing_nodes[node["id"]] = node.get("data", {}) for node in incoming_definition.get("nodes", []): - if node.get("type") != "qa": + secret_fields = _secret_fields_for_node_type(node.get("type")) + if not secret_fields: continue data = node.get("data", {}) - incoming_key = data.get(_QA_API_KEY_FIELD) - if not incoming_key: - continue - old_data = existing_qa.get(node["id"]) + old_data = existing_nodes.get(node["id"]) if not old_data: continue - old_key = old_data.get(_QA_API_KEY_FIELD, "") - if old_key and is_mask_of(incoming_key, old_key): - data[_QA_API_KEY_FIELD] = old_key + for field in secret_fields: + incoming_key = data.get(field) + if not incoming_key: + continue + + old_key = old_data.get(field, "") + if old_key and is_mask_of(incoming_key, old_key): + data[field] = old_key return incoming_definition diff --git a/api/services/configuration/registry.py b/api/services/configuration/registry.py index 3875fc7..05ff6a3 100644 --- a/api/services/configuration/registry.py +++ b/api/services/configuration/registry.py @@ -975,29 +975,67 @@ class SarvamSTTConfiguration(BaseSTTConfiguration): # Speechmatics STT Service SPEECHMATICS_STT_LANGUAGES = [ - "en", - "es", - "fr", - "de", - "it", - "pt", + "ar", + "ar_en", + "ba", + "eu", + "be", + "bn", + "bg", + "yue", + "ca", + "hr", + "cs", + "da", "nl", + "en", + "eo", + "et", + "fi", + "fr", + "gl", + "de", + "el", + "he", + "hi", + "hu", + "id", + "ia", + "ga", + "it", "ja", "ko", - "zh", - "ru", - "ar", - "hi", - "pl", - "tr", - "vi", - "th", - "id", + "lv", + "lt", "ms", - "sv", - "da", + "en_ms", + "mt", + "cmn", + "cmn_en", + "cmn_en_ms_ta", + "mr", + "mn", "no", - "fi", + "fa", + "pl", + "pt", + "ro", + "ru", + "sk", + "sl", + "es", + "sw", + "sv", + "tl", + "ta", + "en_ta", + "th", + "tr", + "uk", + "ur", + "ug", + "vi", + "cy", ] diff --git a/api/services/integrations/AGENTS.md b/api/services/integrations/AGENTS.md new file mode 100644 index 0000000..44ba9b9 --- /dev/null +++ b/api/services/integrations/AGENTS.md @@ -0,0 +1,239 @@ +# Integrations - Plugin Contract + +`api/services/integrations/` is the extension seam for third-party integrations. +New integrations should be self-contained here. Do not bleed integration-specific +logic into `workflow/dto.py`, `workflow/node_specs/`, `run_pipeline.py`, +`event_handlers.py`, or `run_integrations.py` unless you are changing the generic +framework itself. + +## Golden Path + +Create a package: + +```text +api/services/integrations// +├── __init__.py +├── node.py +├── runtime.py # optional +├── completion.py # optional +├── routes.py # optional +└── client.py # optional +``` + +The package self-registers on import via `register_package(...)`. Discovery is +automatic: `api/services/integrations/loader.py` imports every submodule under +`api.services.integrations` except the reserved internal names `base`, `loader`, +and `registry`. + +## Registration Pattern + +`__init__.py` should register one `IntegrationPackageSpec`, following the +existing integration packages in this directory. + +Use: + +```python +PACKAGE = register_package( + IntegrationPackageSpec( + name="", + nodes=(NODE,), + create_runtime_sessions=create_runtime_sessions, # optional + run_completion=run_completion, # optional + routers=(router,), # optional + ) +) +``` + +The package name is the registry key. The node `type_name` is the workflow node +type string and must stay stable once exposed. + +## Node Model + Spec + +For integration nodes, the Pydantic model is the source of truth. The serialized +`NodeSpec` is derived from it. + +Refer to an existing integration node for the overall structure: + +- Define one Pydantic model per node, inheriting + `api/services/workflow/node_data.py:BaseNodeData`. +- Annotate it with `@node_spec(...)`. +- Define fields with `spec_field(...)`. +- Generate the external spec with `SPEC = build_spec(ModelClass)`. +- Register the node with `IntegrationNodeRegistration(...)`. + +Important rules: + +- Put runtime validation in the model, not in the generated spec. + Example: conditional requiredness belongs in `@model_validator(mode="after")`. +- Keep `@node_spec(name=...)` and `IntegrationNodeRegistration.type_name` + identical. They are the same workflow node type string. +- Put wire constraints in the field itself where possible. + Example: `gt=0`, `min_length=1`, `pattern=...`. +- Put UI/export-only differences in `field_overrides`. + Use this for `display_name`, `description`, `required`, `spec_default`, + `display_options`, or property ordering. +- Use `spec_exclude=True` for internal fields that must exist in persisted data + but must not show up in `/api/v1/node-types`. +- Set `property_order=(...)` in `@node_spec(...)` when the editor field order + must remain stable. + +Typical workflow graph constraints for configuration-only integration nodes: + +```python +GraphConstraints(min_incoming=0, max_incoming=0, min_outgoing=0, max_outgoing=0) +``` + +These constraints control how the node can be connected in the workflow graph. +Use them for configuration nodes that are not conversational graph steps. + +## Secret Fields + +If the node stores secrets, register them in +`IntegrationNodeRegistration.sensitive_fields`. + +That is enough for generic masking / masked round-trip preservation via +`api/services/configuration/masking.py`. Do not add new integration-specific +masking branches unless you are changing the shared masking framework. + +## No Central DTO Edits + +Do not add integration node classes to `api/services/workflow/dto.py`. + +Integration nodes are resolved dynamically through: + +- `get_node_data_model()` in `workflow/dto.py` +- `get_node_spec()` / `all_node_specs()` in `services/integrations/registry.py` + +`RFNodeDTO` validates integration nodes by `type` through the registry. That is +the intended extension path. + +## Live Call Path + +If the integration needs live call data, implement `create_runtime_sessions(...)` +in `runtime.py` and return `IntegrationRuntimeSession` objects. + +The generic wiring is already in `api/services/pipecat/run_pipeline.py`: + +- `create_runtime_sessions(IntegrationRuntimeContext(...))` is called before the + pipeline task starts. +- Each returned session gets `session.attach(task)` called. + +Use this only for lightweight live collection: + +- attach task observers +- read context messages +- capture timing / turn / tool events +- build an in-memory snapshot + +Do not do outbound network I/O in the live path unless there is a very strong +reason. Prefer the standard pattern: collect live, deliver after the call. + +`IntegrationRuntimeContext` gives you: + +- `workflow_run_id` +- `workflow_run` +- `workflow_graph` +- `run_definition` +- `user_config` +- `is_realtime` +- `context_messages_provider` + +Typical runtime pattern: + +- scan `context.workflow_graph.nodes.values()` for enabled nodes of your type +- if none are enabled, return `[]` +- build one collector/session per workflow run, not per node, unless the + integration truly needs multiple independent collectors + +## Call-Finish Snapshot Path + +`api/services/pipecat/event_handlers.py` finalizes runtime sessions before the +engine is cleaned up. + +The generic flow: + +1. `on_pipeline_finished` builds `gathered_context` +2. each runtime session gets `await session.on_call_finished(...)` +3. returned dicts are merged into `integration_logs` +4. those logs are persisted into `workflow_run.logs` + +Use `on_call_finished(...)` to emit a compact, serializable snapshot that the +post-call completion handler can consume later. Return `None` if there is nothing +to persist. + +This is the handoff between the live call path and the post-call task path. + +## Post-Call Completion Path + +If the integration needs durable artifacts, public URLs, retries, or external +delivery, implement `run_completion(nodes, context)` in `completion.py`. + +The generic orchestration is already in `api/tasks/run_integrations.py`: + +1. load the pinned workflow definition from the workflow run +2. create a public token if post-call work exists +3. run QA nodes first +4. run registered integration completion handlers +5. run webhook nodes last + +Your handler receives: + +- `nodes`: raw workflow node dicts for your node types only +- `IntegrationCompletionContext`: + - `workflow_run_id` + - `workflow_run` + - `workflow_definition` + - `definition_id` + - `organization_id` + - `public_token` + +Expected completion handler pattern: + +- validate each node with `YourNodeData.model_validate(node.get("data", {}))` +- skip disabled nodes +- read any runtime snapshot from `context.workflow_run.logs` +- build durable URLs using `public_token` when appropriate +- perform external delivery +- return a result dict keyed per node, usually with `node_id` embedded + +Returned data is merged into `workflow_run.annotations`. + +Do not assume completion runs inside the live pipeline process. Treat it as a +separate post-call worker step. + +## Optional Routes + +If an integration exposes HTTP routes, put them in `routes.py` and include the +router in `IntegrationPackageSpec.routers`. + +Routers are mounted automatically by `api/routes/main.py` through `all_routers()`. +Do not edit `routes/main.py` for per-integration route wiring. + +## Import Discipline + +Keep package import side effects light. + +The integration loader runs during: + +- node-type/spec enumeration +- tests +- route startup +- registry access + +So avoid top-level imports that require environment variables, network access, +or heavyweight initialization when possible. Prefer lazy imports inside +`run_completion()` / `create_runtime_sessions()` if the dependency is optional or +environment-sensitive. + +## Testing Expectations + +At minimum, new integrations should add coverage for: + +- node model validation +- generated spec/example validity +- secret masking + masked round-trip preservation if secrets exist +- runtime snapshot creation if live collectors exist +- completion handler happy path and disabled-node skip path + +If you change shared integration machinery, test the framework in the generic +code path, not only the concrete integration. diff --git a/api/services/integrations/__init__.py b/api/services/integrations/__init__.py index e69de29..f1483d6 100644 --- a/api/services/integrations/__init__.py +++ b/api/services/integrations/__init__.py @@ -0,0 +1,39 @@ +from api.services.integrations.base import ( + IntegrationCompletionContext, + IntegrationNodeRegistration, + IntegrationPackageSpec, + IntegrationRuntimeContext, + IntegrationRuntimeSession, +) +from api.services.integrations.registry import ( + all_node_specs, + all_packages, + all_routers, + create_runtime_sessions, + get_node_data_model, + get_node_registration, + get_node_secret_fields, + get_node_spec, + has_completion_handlers, + register_package, + run_completion_handlers, +) + +__all__ = [ + "IntegrationCompletionContext", + "IntegrationNodeRegistration", + "IntegrationPackageSpec", + "IntegrationRuntimeContext", + "IntegrationRuntimeSession", + "all_node_specs", + "all_packages", + "all_routers", + "create_runtime_sessions", + "get_node_data_model", + "get_node_registration", + "get_node_secret_fields", + "get_node_spec", + "has_completion_handlers", + "register_package", + "run_completion_handlers", +] diff --git a/api/services/integrations/base.py b/api/services/integrations/base.py new file mode 100644 index 0000000..b591474 --- /dev/null +++ b/api/services/integrations/base.py @@ -0,0 +1,69 @@ +from __future__ import annotations + +from dataclasses import dataclass +from typing import Any, Awaitable, Callable, Protocol + +from fastapi import APIRouter + +from api.services.workflow.node_data import BaseNodeData +from api.services.workflow.node_specs._base import NodeSpec + + +class IntegrationRuntimeSession(Protocol): + name: str + + def attach(self, task: Any) -> None: ... + + async def on_call_finished( + self, + *, + gathered_context: dict[str, Any], + ) -> dict[str, Any] | None: ... + + +@dataclass(frozen=True) +class IntegrationRuntimeContext: + workflow_run_id: int + workflow_run: Any + workflow_graph: Any + run_definition: Any + user_config: Any + is_realtime: bool + context_messages_provider: Callable[[], list[dict[str, Any]]] + + +@dataclass(frozen=True) +class IntegrationCompletionContext: + workflow_run_id: int + workflow_run: Any + workflow_definition: dict[str, Any] + definition_id: int | None + organization_id: int + public_token: str | None + + +RuntimeFactory = Callable[ + [IntegrationRuntimeContext], + list[IntegrationRuntimeSession], +] +CompletionHandler = Callable[ + [list[dict[str, Any]], IntegrationCompletionContext], + Awaitable[dict[str, Any]], +] + + +@dataclass(frozen=True) +class IntegrationNodeRegistration: + type_name: str + data_model: type[BaseNodeData] + node_spec: NodeSpec + sensitive_fields: tuple[str, ...] = () + + +@dataclass(frozen=True) +class IntegrationPackageSpec: + name: str + nodes: tuple[IntegrationNodeRegistration, ...] = () + routers: tuple[APIRouter, ...] = () + create_runtime_sessions: RuntimeFactory | None = None + run_completion: CompletionHandler | None = None diff --git a/api/services/integrations/loader.py b/api/services/integrations/loader.py new file mode 100644 index 0000000..c5dca70 --- /dev/null +++ b/api/services/integrations/loader.py @@ -0,0 +1,21 @@ +from __future__ import annotations + +import importlib +import pkgutil + +_INTERNAL_MODULES = {"base", "loader", "registry"} +_loaded = False + + +def ensure_integrations_loaded() -> None: + global _loaded + if _loaded: + return + + package = importlib.import_module("api.services.integrations") + for module_info in pkgutil.iter_modules(package.__path__): + if module_info.name in _INTERNAL_MODULES: + continue + importlib.import_module(f"{package.__name__}.{module_info.name}") + + _loaded = True diff --git a/api/services/integrations/nango.py b/api/services/integrations/nango.py deleted file mode 100644 index ce96861..0000000 --- a/api/services/integrations/nango.py +++ /dev/null @@ -1,253 +0,0 @@ -import hashlib -import json -import os -from typing import Any, Dict - -import httpx -from fastapi import HTTPException -from loguru import logger -from pydantic import BaseModel - -from api.db import db_client - -NANGO_ALLOWED_INTEGRATIONS = [ - i.strip() for i in os.environ.get("NANGO_ALLOWED_INTEGRATIONS", "slack").split(",") -] - - -class NangoWebhookRequest(BaseModel): - type: str - connectionId: str - providerConfigKey: str - authMode: str - provider: str - environment: str - operation: str - endUser: dict # Contains endUserId and organizationId - success: bool - - -class NangoService: - def __init__(self): - self.base_url = "https://api.nango.dev" - self.secret_key = os.getenv("NANGO_API_KEY") - - def _verify_webhook_signature( - self, request_body: str, signature: str = None - ) -> bool: - """ - Verify the webhook signature using SHA256 hash. - - Args: - request_body: The raw request body as string - signature: The signature from request headers (optional for now) - - Returns: - True if signature is valid - """ - expected_signature = self.secret_key + request_body - expected_hash = hashlib.sha256(expected_signature.encode("utf-8")).hexdigest() - return expected_hash == signature - - async def create_session( - self, user_id: str, organization_id: int - ) -> Dict[str, Any]: - """ - Create a Nango session for the given user and organization. - - Args: - user_id: The end user ID - organization_id: The organization ID - - Returns: - Response from Nango API - """ - if not self.secret_key: - raise ValueError("NANGO_SECRET_KEY environment variable is not set") - - headers = { - "Authorization": f"Bearer {self.secret_key}", - "Content-Type": "application/json", - } - - payload = { - "end_user": {"id": user_id}, - "organization": {"id": str(organization_id)}, - "allowed_integrations": NANGO_ALLOWED_INTEGRATIONS, - } - - async with httpx.AsyncClient() as client: - response = await client.post( - f"{self.base_url}/connect/sessions", headers=headers, json=payload - ) - - if response.status_code != 201: - raise httpx.HTTPStatusError( - f"Nango API error: {response.status_code}", - request=response.request, - response=response, - ) - - return response.json() - - async def process_webhook( - self, raw_body: bytes, signature: str = None - ) -> Dict[str, str]: - """ - Process incoming Nango webhook request. - - Args: - raw_body: The raw request body as bytes - signature: Optional signature from request headers - - Returns: - Dict with status and message - """ - # Decode and parse the request body - try: - body_text = raw_body.decode("utf-8") - webhook_json = json.loads(body_text) if body_text else {} - logger.debug(f"received webhook from nango: {webhook_json}") - except json.JSONDecodeError as e: - logger.error(f"JSON decode error: {e} body_text: {body_text}") - raise HTTPException(status_code=400, detail=f"Invalid JSON: {str(e)}") - - # Verify webhook signature - if not self._verify_webhook_signature(body_text, signature): - raise HTTPException(status_code=401, detail="Invalid webhook signature") - - # Parse webhook data - try: - webhook_data = NangoWebhookRequest(**webhook_json) - except Exception as e: - logger.error(f"Failed to parse webhook data: {e}") - raise HTTPException( - status_code=400, detail=f"Invalid webhook format: {str(e)}" - ) - - # Extract user and organization IDs from the webhook payload - end_user = webhook_data.endUser - if ( - not end_user - or "endUserId" not in end_user - or "organizationId" not in end_user - ): - raise HTTPException( - status_code=400, detail="Missing endUser information in webhook payload" - ) - - user_id = int(end_user["endUserId"]) - organization_id = int(end_user["organizationId"]) - - # Use the connectionId as the integration_id since it's unique per integration - integration_id = webhook_data.connectionId - - # Initialize connection_details - connection_details = {} - - # Fetch connection details if type is auth and provider is slack - if webhook_data.type == "auth": - connection_details = await self._fetch_connection_details( - integration_id, webhook_data.provider - ) - - # Create the integration in the database - integration = await db_client.create_integration( - integration_id=integration_id, - organisation_id=organization_id, - provider=webhook_data.provider, - created_by=user_id, - is_active=True, - connection_details=connection_details, - ) - - return { - "status": "success", - "message": f"Integration created successfully with ID: {integration.id}", - } - - async def _fetch_connection_details( - self, connection_id: str, provider_key: str - ) -> Dict[str, Any]: - """ - Fetch connection details from Nango API for a given connection ID. - - Args: - connection_id: The connection ID from the webhook - - Returns: - Connection details as a dictionary - """ - - headers = { - "Authorization": f"Bearer {self.secret_key}", - "Content-Type": "application/json", - } - - url = f"{self.base_url}/connection/{connection_id}/?provider_config_key={provider_key}" - - async with httpx.AsyncClient() as client: - try: - response = await client.get(url, headers=headers) - - if response.status_code != 200: - logger.error( - f"Failed to fetch connection details: {response.status_code} - {response.text}" - ) - raise httpx.HTTPStatusError( - f"Nango API error while fetching connection: {response.status_code}", - request=response.request, - response=response, - ) - - connection_details = response.json() - return connection_details - - except httpx.HTTPError as e: - logger.error(f"HTTP error while fetching connection details: {e}") - # Return empty dict if API call fails, but log the error - return {} - - async def get_access_token( - self, connection_id: str, provider_config_key: str - ) -> Dict[str, Any]: - """ - Get the latest access token for a connection from Nango. - - Args: - connection_id: The connection ID - provider_config_key: The provider config key (e.g., 'google-sheet') - - Returns: - Dict containing access token and other connection details - """ - headers = { - "Authorization": f"Bearer {self.secret_key}", - "Content-Type": "application/json", - } - - url = f"{self.base_url}/connection/{connection_id}?provider_config_key={provider_config_key}" - - async with httpx.AsyncClient() as client: - try: - response = await client.get(url, headers=headers) - - if response.status_code != 200: - logger.error( - f"Failed to get access token: {response.status_code} - {response.text}" - ) - raise httpx.HTTPStatusError( - f"Nango API error: {response.status_code}", - request=response.request, - response=response, - ) - - return response.json() - - except httpx.HTTPError as e: - logger.error(f"HTTP error while getting access token: {e}") - raise - - -# Create a singleton instance -nango_service = NangoService() diff --git a/api/services/integrations/registry.py b/api/services/integrations/registry.py new file mode 100644 index 0000000..e85b6c9 --- /dev/null +++ b/api/services/integrations/registry.py @@ -0,0 +1,128 @@ +from __future__ import annotations + +from typing import Any + +from api.services.integrations.base import ( + IntegrationCompletionContext, + IntegrationNodeRegistration, + IntegrationPackageSpec, + IntegrationRuntimeContext, +) +from api.services.workflow.node_data import BaseNodeData + +_PACKAGE_REGISTRY: dict[str, IntegrationPackageSpec] = {} + + +def register_package(spec: IntegrationPackageSpec) -> IntegrationPackageSpec: + existing = _PACKAGE_REGISTRY.get(spec.name) + if existing is not None and existing is not spec: + raise ValueError( + f"Duplicate integration package registration for {spec.name!r}" + ) + _PACKAGE_REGISTRY[spec.name] = spec + return spec + + +def _ensure_loaded() -> None: + from api.services.integrations.loader import ensure_integrations_loaded + + ensure_integrations_loaded() + + +def all_packages() -> list[IntegrationPackageSpec]: + _ensure_loaded() + return [_PACKAGE_REGISTRY[name] for name in sorted(_PACKAGE_REGISTRY)] + + +def get_package(name: str) -> IntegrationPackageSpec | None: + _ensure_loaded() + return _PACKAGE_REGISTRY.get(name) + + +def get_node_registration(type_name: str) -> IntegrationNodeRegistration | None: + _ensure_loaded() + for package in _PACKAGE_REGISTRY.values(): + for node in package.nodes: + if node.type_name == type_name: + return node + return None + + +def get_node_data_model(type_name: str) -> type[BaseNodeData] | None: + registration = get_node_registration(type_name) + return registration.data_model if registration else None + + +def get_node_spec(type_name: str): + registration = get_node_registration(type_name) + return registration.node_spec if registration else None + + +def get_node_secret_fields(type_name: str) -> tuple[str, ...]: + registration = get_node_registration(type_name) + return registration.sensitive_fields if registration else () + + +def all_node_specs(): + _ensure_loaded() + specs = [] + for package in all_packages(): + specs.extend(node.node_spec for node in package.nodes) + return specs + + +def all_routers(): + _ensure_loaded() + routers = [] + for package in all_packages(): + routers.extend(package.routers) + return routers + + +def create_runtime_sessions( + context: IntegrationRuntimeContext, +): + _ensure_loaded() + sessions = [] + for package in all_packages(): + if package.create_runtime_sessions is None: + continue + sessions.extend(package.create_runtime_sessions(context)) + return sessions + + +def iter_completion_packages( + workflow_definition: dict[str, Any], +): + _ensure_loaded() + nodes = workflow_definition.get("nodes", []) if workflow_definition else [] + for package in all_packages(): + node_types = {node.type_name for node in package.nodes} + package_nodes = [ + node + for node in nodes + if isinstance(node, dict) and node.get("type") in node_types + ] + if package_nodes: + yield package, package_nodes + + +def has_completion_handlers(workflow_definition: dict[str, Any]) -> bool: + return any( + package.run_completion is not None + for package, _nodes in iter_completion_packages(workflow_definition) + ) + + +async def run_completion_handlers( + *, + context: IntegrationCompletionContext, +) -> dict[str, Any]: + results: dict[str, Any] = {} + for package, nodes in iter_completion_packages(context.workflow_definition): + if package.run_completion is None: + continue + package_result = await package.run_completion(nodes, context) + if package_result: + results.update(package_result) + return results diff --git a/api/services/integrations/tuner/__init__.py b/api/services/integrations/tuner/__init__.py new file mode 100644 index 0000000..a37288c --- /dev/null +++ b/api/services/integrations/tuner/__init__.py @@ -0,0 +1,19 @@ +from __future__ import annotations + +from api.services.integrations.base import IntegrationPackageSpec +from api.services.integrations.registry import register_package + +from .completion import run_completion +from .node import NODE +from .runtime import create_runtime_sessions + +PACKAGE = register_package( + IntegrationPackageSpec( + name="tuner", + nodes=(NODE,), + create_runtime_sessions=create_runtime_sessions, + run_completion=run_completion, + ) +) + +__all__ = ["PACKAGE"] diff --git a/api/services/integrations/tuner/client.py b/api/services/integrations/tuner/client.py new file mode 100644 index 0000000..18e16cb --- /dev/null +++ b/api/services/integrations/tuner/client.py @@ -0,0 +1,71 @@ +from __future__ import annotations + +from typing import Any + +import httpx +from loguru import logger +from pydantic import BaseModel, field_validator + + +class TunerDeliveryConfig(BaseModel): + base_url: str + api_key: str + workspace_id: int + agent_id: str + + @field_validator("api_key", "agent_id") + @classmethod + def _must_not_be_empty(cls, value: str) -> str: + if not value or not value.strip(): + raise ValueError("must not be empty") + return value + + @field_validator("workspace_id") + @classmethod + def _workspace_must_be_positive(cls, value: int) -> int: + if value <= 0: + raise ValueError("must be a positive integer") + return value + + +async def post_call( + config: TunerDeliveryConfig, + payload: dict[str, Any], +) -> dict[str, Any]: + url = ( + f"{config.base_url}/api/v1/public/call" + f"?workspace_id={config.workspace_id}" + f"&agent_remote_identifier={config.agent_id}" + ) + headers = {"Authorization": f"Bearer {config.api_key}"} + + logger.info( + "[tuner] posting completed call {} to workspace {} / agent {}", + payload.get("call_id"), + config.workspace_id, + config.agent_id, + ) + + async with httpx.AsyncClient(timeout=10) as client: + response = await client.post(url, json=payload, headers=headers) + + if response.status_code == 409: + logger.info("[tuner] call {} already exists in tuner", payload.get("call_id")) + return {"status": "duplicate", "status_code": response.status_code} + + if response.status_code >= 400: + logger.error( + "[tuner] POST failed for call {} with status {}: {}", + payload.get("call_id"), + response.status_code, + response.text[:200], + ) + + response.raise_for_status() + + logger.info( + "[tuner] POST succeeded for call {} with status {}", + payload.get("call_id"), + response.status_code, + ) + return {"status": "delivered", "status_code": response.status_code} diff --git a/api/services/integrations/tuner/collector.py b/api/services/integrations/tuner/collector.py new file mode 100644 index 0000000..73dd410 --- /dev/null +++ b/api/services/integrations/tuner/collector.py @@ -0,0 +1,191 @@ +from __future__ import annotations + +import time +from collections import deque +from dataclasses import dataclass +from typing import Any, Callable + +from loguru import logger +from pipecat.frames.frames import ( + BotStartedSpeakingFrame, + BotStoppedSpeakingFrame, + CancelFrame, + EndFrame, + FunctionCallInProgressFrame, + FunctionCallResultFrame, + MetricsFrame, + StartFrame, + UserStartedSpeakingFrame, + UserStoppedSpeakingFrame, + VADUserStoppedSpeakingFrame, +) +from pipecat.observers.base_observer import BaseObserver, FramePushed +from pipecat.observers.turn_tracking_observer import TurnTrackingObserver +from pipecat.observers.user_bot_latency_observer import UserBotLatencyObserver +from pipecat.processors.frame_processor import FrameDirection +from pipecat.utils.context.message_sanitization import strip_thought_ids_from_messages +from tuner_pipecat_sdk.accumulator import CallAccumulator +from tuner_pipecat_sdk.payload_builder import build_payload + +from api.enums import WorkflowRunMode + +TUNER_RECORDING_PLACEHOLDER = "pipecat://no-recording" + + +@dataclass(frozen=True) +class _PayloadConfig: + call_id: str + call_type: str + recording_url: str + asr_model: str + llm_model: str + tts_model: str + sip_call_id: str | None = None + sip_headers: dict[str, str] | None = None + agent_version: int | None = None + + +def mode_to_tuner_call_type(mode: str | None) -> str: + if mode in { + WorkflowRunMode.WEBRTC.value, + WorkflowRunMode.SMALLWEBRTC.value, + }: + return "web_call" + return "phone_call" + + +class TunerCollector(BaseObserver): + """Collect runtime call metadata and build a deferred Tuner payload.""" + + def __init__( + self, + *, + workflow_run_id: int, + call_type: str, + asr_model: str = "", + llm_model: str = "", + tts_model: str = "", + agent_version: int | None = None, + max_frames: int = 500, + ) -> None: + super().__init__() + self._call_id = str(workflow_run_id) + self._call_type = call_type + self._asr_model = asr_model + self._llm_model = llm_model + self._tts_model = tts_model + self._agent_version = agent_version + self._acc = CallAccumulator() + self._acc.call_start_abs_ns = time.time_ns() + self._pipeline_start_rel_ns: int | None = None + self._context_provider: Callable[[], list[dict[str, Any]]] | None = None + self._processed_frames: set[int] = set() + self._frame_history: deque[int] = deque(maxlen=max_frames) + + def attach_context(self, provider: Callable[[], list[dict[str, Any]]]) -> None: + self._context_provider = provider + + def set_disconnection_reason(self, reason: str | None) -> None: + if reason: + self._acc.set_disconnection_reason(reason) + + def attach_turn_tracking_observer( + self, turn_tracker: TurnTrackingObserver | None + ) -> None: + if turn_tracker is None: + return + + @turn_tracker.event_handler("on_turn_started") + async def _on_turn_started(_tracker: Any, turn_number: int) -> None: + self._acc.on_turn_started(turn_number, time.time_ns()) + + @turn_tracker.event_handler("on_turn_ended") + async def _on_turn_ended( + _tracker: Any, turn_number: int, _duration: float, was_interrupted: bool + ) -> None: + self._acc.on_turn_ended(turn_number, was_interrupted) + + def attach_latency_observer( + self, latency_observer: UserBotLatencyObserver | None + ) -> None: + if latency_observer is None: + return + + @latency_observer.event_handler("on_latency_measured") + async def _on_latency_measured(_observer: Any, latency: float) -> None: + self._acc.on_latency_measured(latency) + + @latency_observer.event_handler("on_latency_breakdown") + async def _on_latency_breakdown(_observer: Any, breakdown: Any) -> None: + self._acc.on_latency_breakdown(breakdown) + + async def on_push_frame(self, data: FramePushed): + if data.direction != FrameDirection.DOWNSTREAM: + return + + if data.frame.id in self._processed_frames: + return + + self._processed_frames.add(data.frame.id) + self._frame_history.append(data.frame.id) + if len(self._processed_frames) > len(self._frame_history): + self._processed_frames = set(self._frame_history) + + frame = data.frame + + # data.timestamp is a pipeline-relative clock (ns since pipeline start). + # Convert to absolute ns so the accumulator's _rel_ms() works correctly. + if self._pipeline_start_rel_ns is None: + self._pipeline_start_rel_ns = data.timestamp + timestamp_ns = self._acc.call_start_abs_ns + ( + data.timestamp - self._pipeline_start_rel_ns + ) + + if isinstance(frame, StartFrame): + self._acc.on_start(timestamp_ns) + elif isinstance(frame, FunctionCallInProgressFrame): + self._acc.on_function_call_in_progress(frame, timestamp_ns) + elif isinstance(frame, FunctionCallResultFrame): + self._acc.on_function_call_result(frame.tool_call_id, timestamp_ns) + elif isinstance(frame, MetricsFrame): + self._acc.on_metrics_frame(frame) + elif isinstance(frame, UserStartedSpeakingFrame): + self._acc.on_user_started_speaking(timestamp_ns) + elif isinstance(frame, UserStoppedSpeakingFrame): + self._acc.on_user_stopped_speaking(timestamp_ns) + self._acc.on_user_turn_stopped(timestamp_ns) + elif isinstance(frame, BotStartedSpeakingFrame): + self._acc.on_bot_started_speaking(timestamp_ns) + elif isinstance(frame, BotStoppedSpeakingFrame): + self._acc.on_bot_stopped(timestamp_ns) + elif isinstance(frame, VADUserStoppedSpeakingFrame): + self._acc.on_vad_stopped(timestamp_ns) + elif isinstance(frame, (CancelFrame, EndFrame)): + self._acc.on_call_end(timestamp_ns) + + def build_payload_snapshot( + self, + *, + recording_url: str = TUNER_RECORDING_PLACEHOLDER, + ) -> dict[str, Any] | None: + if self._context_provider is None: + logger.warning( + "[tuner] no context provider attached; skipping payload snapshot" + ) + return None + + transcript = strip_thought_ids_from_messages(list(self._context_provider())) + payload = build_payload( + self._acc, + _PayloadConfig( + call_id=self._call_id, + call_type=self._call_type, + recording_url=recording_url, + asr_model=self._asr_model, + llm_model=self._llm_model, + tts_model=self._tts_model, + agent_version=self._agent_version, + ), + transcript, + ) + return payload.to_dict() diff --git a/api/services/integrations/tuner/completion.py b/api/services/integrations/tuner/completion.py new file mode 100644 index 0000000..f32c738 --- /dev/null +++ b/api/services/integrations/tuner/completion.py @@ -0,0 +1,76 @@ +from __future__ import annotations + +import copy +from datetime import UTC, datetime +from typing import Any + +from loguru import logger + +from api.constants import BACKEND_API_ENDPOINT, TUNER_BASE_URL +from api.services.integrations.base import IntegrationCompletionContext + +from .client import TunerDeliveryConfig, post_call +from .collector import TUNER_RECORDING_PLACEHOLDER +from .node import TunerNodeData + + +def _build_recording_url( + context: IntegrationCompletionContext, +) -> str | None: + workflow_run = context.workflow_run + if context.public_token: + base_url = f"{BACKEND_API_ENDPOINT}/api/v1/public/download/workflow/{context.public_token}" + return f"{base_url}/recording" if workflow_run.recording_url else None + return workflow_run.recording_url + + +async def run_completion( + nodes: list[dict[str, Any]], + context: IntegrationCompletionContext, +) -> dict[str, Any]: + results: dict[str, Any] = {} + payload_snapshot = (context.workflow_run.logs or {}).get("tuner_payload") + recording_url = _build_recording_url(context) or TUNER_RECORDING_PLACEHOLDER + + for node in nodes: + node_id = node.get("id", "unknown") + try: + tuner_data = TunerNodeData.model_validate(node.get("data", {})) + except Exception as exc: + logger.warning(f"Tuner node #{node_id} failed validation, skipping: {exc}") + results[f"tuner_{node_id}"] = {"error": "validation_failed"} + continue + + if not tuner_data.tuner_enabled: + logger.debug(f"Tuner node '{tuner_data.name}' is disabled, skipping") + continue + + if not payload_snapshot: + logger.warning( + f"Tuner payload snapshot missing for node '{tuner_data.name}' (#{node_id})" + ) + results[f"tuner_{node_id}"] = {"error": "missing_payload_snapshot"} + continue + + payload = copy.deepcopy(payload_snapshot) + payload["recording_url"] = recording_url + + try: + config = TunerDeliveryConfig( + base_url=TUNER_BASE_URL, + api_key=tuner_data.tuner_api_key or "", + workspace_id=tuner_data.tuner_workspace_id or 0, + agent_id=tuner_data.tuner_agent_id or "", + ) + delivery = await post_call(config, payload) + results[f"tuner_{node_id}"] = { + **delivery, + "workspace_id": tuner_data.tuner_workspace_id, + "agent_id": tuner_data.tuner_agent_id, + "exported_at": datetime.now(UTC).isoformat(), + } + except Exception as exc: + logger.error(f"Tuner export failed for node '{tuner_data.name}': {exc}") + results[f"tuner_{node_id}"] = {"error": str(exc)} + + return results diff --git a/api/services/integrations/tuner/node.py b/api/services/integrations/tuner/node.py new file mode 100644 index 0000000..d603730 --- /dev/null +++ b/api/services/integrations/tuner/node.py @@ -0,0 +1,139 @@ +from __future__ import annotations + +from pydantic import model_validator + +from api.services.integrations.base import IntegrationNodeRegistration +from api.services.workflow.node_data import BaseNodeData +from api.services.workflow.node_specs._base import ( + GraphConstraints, + NodeCategory, + NodeExample, + PropertyType, +) +from api.services.workflow.node_specs.model_spec import ( + build_spec, + node_spec, + spec_field, +) + + +@node_spec( + name="tuner", + display_name="Tuner", + description="Export the completed call to Tuner for Agent Observability", + llm_hint=( + "Tuner is a post-call observability export. It does not participate in the " + "conversation graph and should not be connected to other nodes." + ), + category=NodeCategory.integration, + icon="Activity", + examples=[ + NodeExample( + name="tuner_export", + data={ + "name": "Primary Tuner Export", + "tuner_enabled": True, + "tuner_agent_id": "sales-bot-prod", + "tuner_workspace_id": 42, + "tuner_api_key": "tuner_live_xxxxxxxx", + }, + ) + ], + graph_constraints=GraphConstraints( + min_incoming=0, + max_incoming=0, + min_outgoing=0, + max_outgoing=0, + ), + property_order=( + "name", + "tuner_enabled", + "tuner_agent_id", + "tuner_workspace_id", + "tuner_api_key", + ), + field_overrides={ + "name": { + "spec_default": "Tuner", + "description": "Short identifier for this Tuner export configuration.", + }, + "tuner_enabled": { + "display_name": "Enabled", + "description": "When false, Dograh skips exporting this call to Tuner.", + }, + "tuner_agent_id": { + "display_name": "Tuner Agent ID", + "description": "The agent identifier registered in your Tuner workspace.", + "required": True, + }, + "tuner_workspace_id": { + "display_name": "Tuner Workspace ID", + "description": "Your numeric Tuner workspace ID.", + "required": True, + "min_value": 1, + }, + "tuner_api_key": { + "display_name": "Tuner API Key", + "description": "Bearer token used when posting completed calls to Tuner.", + "required": True, + }, + }, +) +class TunerNodeData(BaseNodeData): + tuner_enabled: bool = spec_field( + default=True, + ui_type=PropertyType.boolean, + display_name="Enabled", + description="When false, Dograh skips exporting this call to Tuner.", + ) + tuner_agent_id: str | None = spec_field( + default=None, + ui_type=PropertyType.string, + display_name="Tuner Agent ID", + description="The agent identifier registered in your Tuner workspace.", + ) + tuner_workspace_id: int | None = spec_field( + default=None, + gt=0, + ui_type=PropertyType.number, + display_name="Tuner Workspace ID", + description="Your numeric Tuner workspace ID.", + ) + tuner_api_key: str | None = spec_field( + default=None, + ui_type=PropertyType.string, + display_name="Tuner API Key", + description="Bearer token used when posting completed calls to Tuner.", + ) + + @model_validator(mode="after") + def _validate_enabled_config(self): + if not self.tuner_enabled: + return self + + missing: list[str] = [] + if not self.tuner_agent_id or not self.tuner_agent_id.strip(): + missing.append("tuner_agent_id") + if self.tuner_workspace_id is None: + missing.append("tuner_workspace_id") + if not self.tuner_api_key or not self.tuner_api_key.strip(): + missing.append("tuner_api_key") + + if missing: + fields = ", ".join(missing) + raise ValueError( + f"Tuner node is enabled but missing required fields: {fields}" + ) + + return self + + +SPEC = build_spec(TunerNodeData) + + +NODE = IntegrationNodeRegistration( + type_name="tuner", + data_model=TunerNodeData, + node_spec=SPEC, + sensitive_fields=("tuner_api_key",), +) diff --git a/api/services/integrations/tuner/runtime.py b/api/services/integrations/tuner/runtime.py new file mode 100644 index 0000000..9c8ae08 --- /dev/null +++ b/api/services/integrations/tuner/runtime.py @@ -0,0 +1,101 @@ +from __future__ import annotations + +from typing import Any + +from api.services.configuration.registry import ServiceProviders +from api.services.integrations.base import ( + IntegrationRuntimeContext, + IntegrationRuntimeSession, +) + +from .collector import TunerCollector, mode_to_tuner_call_type + + +def _format_model_label(provider: str | None, model: str | None) -> str: + if provider and model: + return f"{provider}/{model}" + if model: + return model + return provider or "" + + +def _resolve_model_labels(context: IntegrationRuntimeContext) -> tuple[str, str, str]: + user_config = context.user_config + + if context.is_realtime and user_config.realtime: + realtime_provider = user_config.realtime.provider + realtime_model = user_config.realtime.model + llm_model = _format_model_label(realtime_provider, realtime_model) + if realtime_provider in { + ServiceProviders.GOOGLE_REALTIME.value, + ServiceProviders.GOOGLE_VERTEX_REALTIME.value, + ServiceProviders.OPENAI_REALTIME.value, + }: + return "", llm_model, "" + return "", llm_model, "" + + return ( + _format_model_label( + getattr(user_config.stt, "provider", None), + getattr(user_config.stt, "model", None), + ), + _format_model_label( + getattr(user_config.llm, "provider", None), + getattr(user_config.llm, "model", None), + ), + _format_model_label( + getattr(user_config.tts, "provider", None), + getattr(user_config.tts, "model", None), + ), + ) + + +class TunerRuntimeSession(IntegrationRuntimeSession): + name = "tuner" + + def __init__(self, collector: TunerCollector) -> None: + self._collector = collector + + def attach(self, task: Any) -> None: + self._collector.attach_turn_tracking_observer(task.turn_tracking_observer) + self._collector.attach_latency_observer(task.user_bot_latency_observer) + task.add_observer(self._collector) + + async def on_call_finished( + self, + *, + gathered_context: dict[str, Any], + ) -> dict[str, Any] | None: + self._collector.set_disconnection_reason( + gathered_context.get("call_disposition") + ) + payload = self._collector.build_payload_snapshot() + if payload is None: + return None + return {"tuner_payload": payload} + + +def create_runtime_sessions( + context: IntegrationRuntimeContext, +) -> list[IntegrationRuntimeSession]: + tuner_nodes = [ + node + for node in context.workflow_graph.nodes.values() + if node.node_type == "tuner" and getattr(node.data, "tuner_enabled", True) + ] + if not tuner_nodes: + return [] + + asr_model, llm_model, tts_model = _resolve_model_labels(context) + + collector = TunerCollector( + workflow_run_id=context.workflow_run_id, + call_type=mode_to_tuner_call_type(context.workflow_run.mode), + asr_model=asr_model, + llm_model=llm_model, + tts_model=tts_model, + agent_version=getattr(context.run_definition, "version_number", None), + ) + collector.attach_context(context.context_messages_provider) + + return [TunerRuntimeSession(collector)] diff --git a/api/services/pipecat/event_handlers.py b/api/services/pipecat/event_handlers.py index 5cde7b9..390f6cc 100644 --- a/api/services/pipecat/event_handlers.py +++ b/api/services/pipecat/event_handlers.py @@ -5,6 +5,7 @@ from loguru import logger from api.db import db_client from api.enums import PostHogEvent, WorkflowRunState from api.services.campaign.circuit_breaker import circuit_breaker +from api.services.integrations import IntegrationRuntimeSession from api.services.pipecat.audio_config import AudioConfig from api.services.pipecat.audio_playback import play_audio_loop from api.services.pipecat.in_memory_buffers import ( @@ -67,6 +68,7 @@ def register_event_handlers( audio_config=AudioConfig, pre_call_fetch_task: asyncio.Task | None = None, user_provider_id: str | None = None, + integration_runtime_sessions: list[IntegrationRuntimeSession] | None = None, ): """Register all event handlers for transport and task events. @@ -272,6 +274,20 @@ def register_event_handlers( ) # Clean up engine resources (including voicemail detector) + integration_logs: dict[str, object] = {} + for runtime_session in integration_runtime_sessions or []: + try: + session_logs = await runtime_session.on_call_finished( + gathered_context=gathered_context + ) + if session_logs: + integration_logs.update(session_logs) + except Exception as e: + logger.error( + f"Error finalizing integration runtime session '{runtime_session.name}': {e}", + exc_info=True, + ) + await engine.cleanup() # ------------------------------------------------------------------ @@ -321,14 +337,11 @@ def register_event_handlers( ) ) - # Save real-time feedback logs to workflow run + logs_update: dict[str, object] = {} if not in_memory_logs_buffer.is_empty: try: feedback_events = in_memory_logs_buffer.get_events() - await db_client.update_workflow_run( - run_id=workflow_run_id, - logs={"realtime_feedback_events": feedback_events}, - ) + logs_update["realtime_feedback_events"] = feedback_events logger.debug( f"Saved {len(feedback_events)} feedback events to workflow run logs" ) @@ -337,6 +350,17 @@ def register_event_handlers( else: logger.debug("Logs buffer is empty, skipping save") + logs_update.update(integration_logs) + + if logs_update: + try: + await db_client.update_workflow_run( + run_id=workflow_run_id, + logs=logs_update, + ) + except Exception as e: + logger.error(f"Error saving workflow run logs: {e}", exc_info=True) + # Write buffers to temp files and enqueue combined processing task audio_temp_path = None transcript_temp_path = None diff --git a/api/services/pipecat/run_pipeline.py b/api/services/pipecat/run_pipeline.py index 116e6ea..37584b0 100644 --- a/api/services/pipecat/run_pipeline.py +++ b/api/services/pipecat/run_pipeline.py @@ -7,6 +7,10 @@ from loguru import logger from api.db import db_client from api.enums import WorkflowRunMode from api.services.configuration.registry import ServiceProviders +from api.services.integrations import ( + IntegrationRuntimeContext, + create_runtime_sessions, +) from api.services.pipecat.audio_config import AudioConfig, create_audio_config from api.services.pipecat.event_handlers import ( register_audio_data_handler, @@ -525,6 +529,18 @@ async def _run_pipeline( # Create pipeline components audio_buffer, context = create_pipeline_components(audio_config) + integration_runtime_sessions = create_runtime_sessions( + IntegrationRuntimeContext( + workflow_run_id=workflow_run_id, + workflow_run=workflow_run, + workflow_graph=workflow_graph, + run_definition=run_definition, + user_config=user_config, + is_realtime=is_realtime, + context_messages_provider=lambda: context.messages, + ) + ) + # Set the context, audio_config, and audio_buffer after creation engine.set_context(context) engine.set_audio_config(audio_config) @@ -717,6 +733,14 @@ async def _run_pipeline( # Create pipeline task with audio configuration task = create_pipeline_task(pipeline, workflow_run_id, audio_config) + for runtime_session in integration_runtime_sessions: + runtime_session.attach(task) + logger.info( + "[integrations] attached runtime session '{}' for workflow run {}", + runtime_session.name, + workflow_run_id, + ) + # Now set the task and transport output on the engine engine.set_task(task) engine.set_transport_output(transport.output()) @@ -780,6 +804,7 @@ async def _run_pipeline( audio_config=audio_config, pre_call_fetch_task=pre_call_fetch_task, user_provider_id=user_provider_id, + integration_runtime_sessions=integration_runtime_sessions, ) register_audio_data_handler(audio_buffer, workflow_run_id, in_memory_audio_buffer) diff --git a/api/services/telephony/AGENTS.md b/api/services/telephony/AGENTS.md new file mode 100644 index 0000000..873ac8f --- /dev/null +++ b/api/services/telephony/AGENTS.md @@ -0,0 +1,10 @@ +# Telephony + +Shared telephony code lives here. Provider-specific code lives in `providers/`; +read `providers/AGENTS.md` before changing a provider package. + +- Keep cross-provider contracts, registry/factory wiring, shared status/transfer handling, and org-scoped config resolution in this folder. +- Keep provider-specific transports, serializers, config models, and webhook handlers in `providers/`. +- Resolve providers through the shared telephony helpers in this folder; do not instantiate provider classes directly from routes, tasks, or unrelated services. +- Keep telephony config lookups tenant-safe and respect any run-scoped telephony configuration carried on a workflow run. +- Keep provider-specific HTTP routes in provider packages; shared route glue belongs in `api/routes/`. diff --git a/api/services/telephony/providers/AGENTS.md b/api/services/telephony/providers/AGENTS.md new file mode 100644 index 0000000..546b4af --- /dev/null +++ b/api/services/telephony/providers/AGENTS.md @@ -0,0 +1,123 @@ +# Telephony Providers + +Each subdirectory here is a self-registering telephony provider. Adding a new one should touch this folder plus **exactly two lines** outside it. If a change you're making requires editing `factory.py`, `audio_config.py`, `run_pipeline.py`, `routes/telephony.py`, or any frontend file, stop — that's a smell. Push the variation through the registry instead. + +## Anatomy of a provider package + +``` +providers// +├── __init__.py # Required. Builds + register()s ProviderSpec +├── config.py # Required. Pydantic Request + Response, both with `provider: Literal[""]` +├── provider.py # Required. TelephonyProvider subclass +├── transport.py # Required. async create_transport(...) -> FastAPIWebsocketTransport +├── serializers.py # Optional but conventional. Re-export from pipecat +├── routes.py # Optional. APIRouter mounted lazily under /api/v1/telephony +└── strategies.py # Optional. Transfer/Hangup strategies for the frame serializer +``` + +Every file is provider-local. Nothing here imports another provider package. + +## The two edits outside this folder + +After creating `providers//`: + +1. `providers/__init__.py` — add `` to the import-for-side-effects list. Registration runs at import time. +2. `api/schemas/telephony_config.py` — import `ConfigurationRequest`/`Response` and add the request to the `TelephonyConfigRequest` `Union[...]` and the response as an optional field on `TelephonyConfigurationResponse`. + +If you find yourself editing anything else, re-read the registry plumbing first: + +| Want to change... | Source of truth | +| ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| Outbound provider lookup | `factory.get_default_telephony_provider`, `get_telephony_provider_by_id`, and `get_telephony_provider_for_run` read `registry.get(name).provider_cls` | +| Stored credentials → constructor dict | `ProviderSpec.config_loader` | +| Audio sample rate / VAD rate | `ProviderSpec.transport_sample_rate` (full `AudioConfig` is built in `pipecat/audio_config.py::create_audio_config`) | +| Which transport runs in `run_pipeline_telephony` | `ProviderSpec.transport_factory` | +| Save-request validation + masked response shape | `ProviderSpec.config_request_cls` / `config_response_cls` | +| Form rendered by the telephony-config UI | `ProviderSpec.ui_metadata` (`ProviderUIField` list) | +| Which credential masks on read | `ui_metadata.fields[*].sensitive=True` (no separate list) | +| Inbound webhook → config row matching | `ProviderSpec.account_id_credential_field` | +| HTTP routes (answer URL, status callbacks) | `providers//routes.py` (auto-mounted via `importlib`) | + +## ProviderSpec — minimum viable shape + +```python +SPEC = ProviderSpec( + name="", # registry key, WorkflowRunMode value, stored discriminator + provider_cls=YourProvider, + config_loader=_config_loader, # raw dict from DB → constructor dict + transport_factory=create_transport, + transport_sample_rate=8000, # wire-format rate; pipecat derives the full AudioConfig + config_request_cls=YourProviderConfigurationRequest, + config_response_cls=YourProviderConfigurationResponse, + ui_metadata=ProviderUIMetadata(...), # drives the form UI + account_id_credential_field="api_key", # "" if provider has no account-id concept +) +register(SPEC) +``` + +`ProviderSpec` is frozen — immutable post-registration. Re-registration with the same instance is a no-op; re-registration with a different instance raises. + +## Registration is import-driven, not config-driven + +`api/services/telephony/__init__.py` imports `providers/` for side effects. Don't add a registration call elsewhere — by the time `factory`, `audio_config`, or `run_pipeline_telephony` look the spec up, the package init has already executed. + +The package init **does not import `routes.py`** — `api/routes/telephony.py::_mount_provider_routers()` walks `registry.all_specs()` and uses `importlib.import_module(f"...providers.{spec.name}.routes")`, treating `ModuleNotFoundError` as "no routes for this provider." This is what keeps `from api.services.telephony.base import TelephonyProvider` from fanning out to every route handler in the app. Don't undo it by importing `.routes` from `__init__.py`. + +## Conventions + +### `provider: Literal[""]` on both Request and Response + +Pydantic's discriminated union dispatches on this field. Forgetting `Literal` makes the union accept any provider's payload as yours. Default it to the literal so save calls don't have to send it explicitly. + +### Transports load credentials lazily + +Always: + +```python +from api.services.telephony.factory import load_credentials_for_transport + +config = await load_credentials_for_transport( + organization_id, telephony_configuration_id, expected_provider="", +) +``` + +Never read the org's default config from `transport.py`. The workflow run carries `telephony_configuration_id` in `initial_context` for multi-config orgs; `load_credentials_for_transport` resolves the right row and validates the provider matches. + +### `_config_loader` is a pure dict reshape + +It runs over `TelephonyConfigurationModel.credentials` (the JSONB column). Don't do I/O in it. Don't pull `from_numbers` from credentials — the factory attaches active phone numbers from `telephony_phone_numbers` after the loader runs, by joining and normalizing addresses. + +### Sensitive fields + +Mark every credential field `sensitive=True` in `ProviderUIMetadata`. The org routes derive masking from `ui_metadata`, not from a separate hardcoded list. If you re-submit a masked value, `preserve_masked_fields` restores the original — relying on this means you should never write `sensitive=False` on a real secret to "make the form simpler." + +### Inbound webhook routing + +When multiple configs of the same provider live in one org (e.g. two Twilio sub-accounts), the inbound dispatcher matches the webhook to a config by `credentials[]`. Set this to whatever your provider stamps on inbound payloads (`account_sid` for Twilio, `auth_id` for Plivo, etc.). Set `""` only when the provider truly has no account-id concept (e.g. ARI — there's at most one config per org). + +### `configure_inbound` defaults to no-op + +Override only when the provider supports programmatic webhook binding (Plivo `application_id`, Telnyx app config). Markup-response providers that learn the webhook URL from console-side configuration leave the default. Returning `ProviderSyncResult(ok=False, message="...")` surfaces a non-fatal warning to the user without aborting the DB write. + +## Reference implementations + +Pick the closest shape and copy from it. + +| Provider | Pick when... | +| ------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `twilio/` | Markup-response (TwiML), HMAC-signed webhooks, conference-style transfers, status callbacks. The most full-featured reference. | +| `plivo/` | Markup-response with multi-callback signature schemes, programmatic answer-URL sync via Application API. | +| `vonage/` | JWT auth, 16 kHz Linear PCM wire format, NCCO JSON responses. | +| `cloudonix/` | SIP-trunk-style with custom transfer/hangup strategies. | +| `telnyx/` | Call-control style — REST calls to answer/stream rather than markup response. | +| `vobiz/` | Body-signed webhooks (signature covers raw bytes). | +| `ari/` | Smallest viable: no `routes.py`, no `verify_inbound_signature`, WebSocket-only, no account-id. | + +## What NOT to do + +- **Don't import another provider's `provider.py` or `transport.py`.** Cross-provider behavior belongs in `services/telephony/` (e.g. `status_processor`, `ari_manager`, `call_transfer_manager`), not in another provider's package. +- **Don't add a hardcoded provider list anywhere.** If you need to iterate, use `registry.all_specs()` / `registry.names()`. +- **Don't add a route under `routes/telephony.py` for a single provider.** Provider-specific handlers go in `providers//routes.py`. Cross-provider handlers (`/inbound/run`, `/twiml`) stay in `routes/telephony.py`. +- **Don't import `.routes` from a provider's `__init__.py`.** That's the cycle we deliberately broke — see "Registration is import-driven." +- **Don't write a frontend form for a new provider.** The UI consumes `GET /api/v1/organizations/telephony-providers/metadata` and renders generically from `ProviderUIField`. If a `field.type` you need doesn't exist (`text`/`password`/`textarea`/`string-array`/`number`), extend the shared telephony UI under `ui/src/components/telephony/` once — not per provider. +- **Don't run a database migration to add a provider.** The discriminator lives in JSONB credentials and a `VARCHAR(64)` `mode` column; nothing in the DB schema knows the set of provider names. diff --git a/api/services/telephony/providers/CLAUDE.md b/api/services/telephony/providers/CLAUDE.md index df634eb..43c994c 100644 --- a/api/services/telephony/providers/CLAUDE.md +++ b/api/services/telephony/providers/CLAUDE.md @@ -1,123 +1 @@ -# Telephony Providers - -Each subdirectory here is a self-registering telephony provider. Adding a new one should touch this folder plus **exactly two lines** outside it. If a change you're making requires editing `factory.py`, `audio_config.py`, `run_pipeline.py`, `routes/telephony.py`, or any frontend file, stop — that's a smell. Push the variation through the registry instead. - -## Anatomy of a provider package - -``` -providers// -├── __init__.py # Required. Builds + register()s ProviderSpec -├── config.py # Required. Pydantic Request + Response, both with `provider: Literal[""]` -├── provider.py # Required. TelephonyProvider subclass -├── transport.py # Required. async create_transport(...) -> FastAPIWebsocketTransport -├── serializers.py # Optional but conventional. Re-export from pipecat -├── routes.py # Optional. APIRouter mounted lazily under /api/v1/telephony -└── strategies.py # Optional. Transfer/Hangup strategies for the frame serializer -``` - -Every file is provider-local. Nothing here imports another provider package. - -## The two edits outside this folder - -After creating `providers//`: - -1. `providers/__init__.py` — add `` to the import-for-side-effects list. Registration runs at import time. -2. `api/schemas/telephony_config.py` — import `ConfigurationRequest`/`Response` and add the request to the `TelephonyConfigRequest` `Union[...]` and the response as an optional field on `TelephonyConfigurationResponse`. - -If you find yourself editing anything else, re-read the registry plumbing first: - -| Want to change... | Source of truth | -| --- | --- | -| Outbound provider lookup | `factory.get_default_telephony_provider`, `get_telephony_provider_by_id`, and `get_telephony_provider_for_run` read `registry.get(name).provider_cls` | -| Stored credentials → constructor dict | `ProviderSpec.config_loader` | -| Audio sample rate / VAD rate | `ProviderSpec.transport_sample_rate` (full `AudioConfig` is built in `pipecat/audio_config.py::create_audio_config`) | -| Which transport runs in `run_pipeline_telephony` | `ProviderSpec.transport_factory` | -| Save-request validation + masked response shape | `ProviderSpec.config_request_cls` / `config_response_cls` | -| Form rendered by the telephony-config UI | `ProviderSpec.ui_metadata` (`ProviderUIField` list) | -| Which credential masks on read | `ui_metadata.fields[*].sensitive=True` (no separate list) | -| Inbound webhook → config row matching | `ProviderSpec.account_id_credential_field` | -| HTTP routes (answer URL, status callbacks) | `providers//routes.py` (auto-mounted via `importlib`) | - -## ProviderSpec — minimum viable shape - -```python -SPEC = ProviderSpec( - name="", # registry key, WorkflowRunMode value, stored discriminator - provider_cls=YourProvider, - config_loader=_config_loader, # raw dict from DB → constructor dict - transport_factory=create_transport, - transport_sample_rate=8000, # wire-format rate; pipecat derives the full AudioConfig - config_request_cls=YourProviderConfigurationRequest, - config_response_cls=YourProviderConfigurationResponse, - ui_metadata=ProviderUIMetadata(...), # drives the form UI - account_id_credential_field="api_key", # "" if provider has no account-id concept -) -register(SPEC) -``` - -`ProviderSpec` is frozen — immutable post-registration. Re-registration with the same instance is a no-op; re-registration with a different instance raises. - -## Registration is import-driven, not config-driven - -`api/services/telephony/__init__.py` imports `providers/` for side effects. Don't add a registration call elsewhere — by the time `factory`, `audio_config`, or `run_pipeline_telephony` look the spec up, the package init has already executed. - -The package init **does not import `routes.py`** — `api/routes/telephony.py::_mount_provider_routers()` walks `registry.all_specs()` and uses `importlib.import_module(f"...providers.{spec.name}.routes")`, treating `ModuleNotFoundError` as "no routes for this provider." This is what keeps `from api.services.telephony.base import TelephonyProvider` from fanning out to every route handler in the app. Don't undo it by importing `.routes` from `__init__.py`. - -## Conventions - -### `provider: Literal[""]` on both Request and Response - -Pydantic's discriminated union dispatches on this field. Forgetting `Literal` makes the union accept any provider's payload as yours. Default it to the literal so save calls don't have to send it explicitly. - -### Transports load credentials lazily - -Always: - -```python -from api.services.telephony.factory import load_credentials_for_transport - -config = await load_credentials_for_transport( - organization_id, telephony_configuration_id, expected_provider="", -) -``` - -Never read the org's default config from `transport.py`. The workflow run carries `telephony_configuration_id` in `initial_context` for multi-config orgs; `load_credentials_for_transport` resolves the right row and validates the provider matches. - -### `_config_loader` is a pure dict reshape - -It runs over `TelephonyConfigurationModel.credentials` (the JSONB column). Don't do I/O in it. Don't pull `from_numbers` from credentials — the factory attaches active phone numbers from `telephony_phone_numbers` after the loader runs, by joining and normalizing addresses. - -### Sensitive fields - -Mark every credential field `sensitive=True` in `ProviderUIMetadata`. The org routes derive masking from `ui_metadata`, not from a separate hardcoded list. If you re-submit a masked value, `preserve_masked_fields` restores the original — relying on this means you should never write `sensitive=False` on a real secret to "make the form simpler." - -### Inbound webhook routing - -When multiple configs of the same provider live in one org (e.g. two Twilio sub-accounts), the inbound dispatcher matches the webhook to a config by `credentials[]`. Set this to whatever your provider stamps on inbound payloads (`account_sid` for Twilio, `auth_id` for Plivo, etc.). Set `""` only when the provider truly has no account-id concept (e.g. ARI — there's at most one config per org). - -### `configure_inbound` defaults to no-op - -Override only when the provider supports programmatic webhook binding (Plivo `application_id`, Telnyx app config). Markup-response providers that learn the webhook URL from console-side configuration leave the default. Returning `ProviderSyncResult(ok=False, message="...")` surfaces a non-fatal warning to the user without aborting the DB write. - -## Reference implementations - -Pick the closest shape and copy from it. - -| Provider | Pick when... | -| --- | --- | -| `twilio/` | Markup-response (TwiML), HMAC-signed webhooks, conference-style transfers, status callbacks. The most full-featured reference. | -| `plivo/` | Markup-response with multi-callback signature schemes, programmatic answer-URL sync via Application API. | -| `vonage/` | JWT auth, 16 kHz Linear PCM wire format, NCCO JSON responses. | -| `cloudonix/` | SIP-trunk-style with custom transfer/hangup strategies. | -| `telnyx/` | Call-control style — REST calls to answer/stream rather than markup response. | -| `vobiz/` | Body-signed webhooks (signature covers raw bytes). | -| `ari/` | Smallest viable: no `routes.py`, no `verify_inbound_signature`, WebSocket-only, no account-id. | - -## What NOT to do - -- **Don't import another provider's `provider.py` or `transport.py`.** Cross-provider behavior belongs in `services/telephony/` (e.g. `status_processor`, `ari_manager`, `call_transfer_manager`), not in another provider's package. -- **Don't add a hardcoded provider list anywhere.** If you need to iterate, use `registry.all_specs()` / `registry.names()`. -- **Don't add a route under `routes/telephony.py` for a single provider.** Provider-specific handlers go in `providers//routes.py`. Cross-provider handlers (`/inbound/run`, `/twiml`) stay in `routes/telephony.py`. -- **Don't import `.routes` from a provider's `__init__.py`.** That's the cycle we deliberately broke — see "Registration is import-driven." -- **Don't write a frontend form for a new provider.** The UI consumes `GET /api/v1/organizations/telephony-providers/metadata` and renders generically from `ProviderUIField`. If a `field.type` you need doesn't exist (`text`/`password`/`textarea`/`string-array`/`number`), extend the renderer in `ui/src/app/(authenticated)/telephony-configurations/` once — not per provider. -- **Don't run a database migration to add a provider.** The discriminator lives in JSONB credentials and a `VARCHAR(64)` `mode` column; nothing in the DB schema knows the set of provider names. +@AGENTS.md diff --git a/api/services/telephony/providers/telnyx/provider.py b/api/services/telephony/providers/telnyx/provider.py index e78914b..f14e0f1 100644 --- a/api/services/telephony/providers/telnyx/provider.py +++ b/api/services/telephony/providers/telnyx/provider.py @@ -25,7 +25,6 @@ TELNYX_TIMESTAMP_TOLERANCE_SECONDS = 300 TELNYX_PUBLIC_KEY_BYTES = 32 TELNYX_SIGNATURE_BYTES = 64 -from api.constants import TELNYX_WEBHOOK_VERIFICATION_OPTIONAL from api.enums import WorkflowRunMode from api.services.telephony.base import ( CallInitiationResult, @@ -211,12 +210,6 @@ class TelnyxProvider(TelephonyProvider): return False if not self.webhook_public_key: - # REMOVE-AFTER 2026-05-15: transition window. Allow webhooks - # through for configs that haven't added the key yet. Remove this - # branch along with TELNYX_WEBHOOK_VERIFICATION_OPTIONAL after - # the cutoff. - if TELNYX_WEBHOOK_VERIFICATION_OPTIONAL: - return True logger.error("Missing Telnyx webhook_public_key configuration") return False diff --git a/api/services/workflow/audit.py b/api/services/workflow/audit.py index 6a7dade..8e70384 100644 --- a/api/services/workflow/audit.py +++ b/api/services/workflow/audit.py @@ -7,7 +7,7 @@ script in `api/services/admin_utils/local_exec.py` is the production consumer. """ -from api.services.workflow.node_specs import REGISTRY +from api.services.workflow.node_specs import all_specs def _build_type_rules() -> tuple[set[str], set[str]]: @@ -16,14 +16,14 @@ def _build_type_rules() -> tuple[set[str], set[str]]: (max_incoming == 0).""" src_forbidden: set[str] = set() tgt_forbidden: set[str] = set() - for name, spec in REGISTRY.items(): + for spec in all_specs(): gc = spec.graph_constraints if gc is None: continue if gc.max_outgoing == 0: - src_forbidden.add(name) + src_forbidden.add(spec.name) if gc.max_incoming == 0: - tgt_forbidden.add(name) + tgt_forbidden.add(spec.name) return src_forbidden, tgt_forbidden diff --git a/api/services/workflow/dto.py b/api/services/workflow/dto.py index dc26843..47fe9d7 100644 --- a/api/services/workflow/dto.py +++ b/api/services/workflow/dto.py @@ -1,7 +1,25 @@ from enum import Enum -from typing import Annotated, List, Literal, Optional, Union +from typing import Any, Dict, List, Literal, Optional, Union -from pydantic import BaseModel, Field, ValidationError, model_validator +from pydantic import BaseModel, Field, ValidationError, field_validator, model_validator + +from api.services.integrations import ( + all_packages, +) +from api.services.integrations import ( + get_node_data_model as get_integration_node_data_model, +) +from api.services.workflow.node_data import BaseNodeData +from api.services.workflow.node_specs._base import ( + DisplayOptions, + GraphConstraints, + NodeCategory, + NodeExample, + PropertyOption, + PropertyType, +) +from api.services.workflow.node_specs.constants import DEFAULT_QA_SYSTEM_PROMPT +from api.services.workflow.node_specs.model_spec import node_spec, spec_field class NodeType(str, Enum): @@ -26,73 +44,381 @@ class VariableType(str, Enum): class ExtractionVariableDTO(BaseModel): - name: str = Field(..., min_length=1) - type: VariableType - prompt: Optional[str] = None + name: str = spec_field( + ..., + min_length=1, + ui_type=PropertyType.string, + display_name="Variable Name", + description="snake_case identifier used downstream.", + required=True, + ) + type: VariableType = spec_field( + ..., + display_name="Type", + description="Data type of the extracted value.", + required=True, + options=[ + PropertyOption(value="string", label="String"), + PropertyOption(value="number", label="Number"), + PropertyOption(value="boolean", label="Boolean"), + ], + spec_default="string", + ) + prompt: Optional[str] = spec_field( + default=None, + ui_type=PropertyType.string, + display_name="Extraction Hint", + description="Per-variable hint describing what to look for.", + editor="textarea", + ) class CustomHeaderDTO(BaseModel): - key: str - value: str + key: str = spec_field( + ..., + ui_type=PropertyType.string, + display_name="Header Name", + description="HTTP header name (e.g., 'X-Source').", + required=True, + ) + value: str = spec_field( + ..., + ui_type=PropertyType.string, + display_name="Header Value", + description="Header value (supports {{template_variables}}).", + required=True, + ) # ───────────────────────────────────────────────────────────────────────── # Per-type node data classes. # -# Shared fields are factored out as Pydantic mixins; per-type classes -# inherit only the mixins they need so mistyped fields raise at validation -# time and downstream consumers get accurate types. `is_start` / `is_end` -# live on every variant so the WorkflowGraph can identify boundary nodes -# without dispatching on type. +# Shared fields live on `BaseNodeData` in a neutral module so both core and +# integration nodes can inherit the same workflow contract. Per-type classes +# then add only the mixins they need so mistyped fields raise at validation +# time and downstream consumers get accurate types. # ───────────────────────────────────────────────────────────────────────── -class _NodeDataBase(BaseModel): - name: str = Field(..., min_length=1) - is_start: bool = False - is_end: bool = False - - class _PromptedNodeDataMixin(BaseModel): - prompt: Optional[str] = Field(default=None) - is_static: bool = False - allow_interrupt: bool = False - add_global_prompt: bool = True + prompt: Optional[str] = spec_field( + default=None, + ui_type=PropertyType.mention_textarea, + display_name="Prompt", + description="System prompt for this node. Supports {{template_variables}}.", + required=True, + min_length=1, + ) + allow_interrupt: bool = spec_field( + default=False, + ui_type=PropertyType.boolean, + display_name="Allow Interruption", + description="When true, the user can interrupt the agent mid-utterance.", + ) + add_global_prompt: bool = spec_field( + default=True, + ui_type=PropertyType.boolean, + display_name="Add Global Prompt", + description=( + "When true and a Global node exists, prepends the global prompt to this " + "node's prompt at runtime." + ), + ) class _ExtractionNodeDataMixin(BaseModel): - extraction_enabled: bool = False - extraction_prompt: Optional[str] = None - extraction_variables: Optional[list[ExtractionVariableDTO]] = None + extraction_enabled: bool = spec_field( + default=False, + ui_type=PropertyType.boolean, + display_name="Enable Variable Extraction", + description="When true, runs an LLM extraction pass for this node.", + ) + extraction_prompt: Optional[str] = spec_field( + default=None, + ui_type=PropertyType.string, + display_name="Extraction Prompt", + description="Overall instructions guiding variable extraction.", + display_options=DisplayOptions(show={"extraction_enabled": [True]}), + editor="textarea", + ) + extraction_variables: Optional[list[ExtractionVariableDTO]] = spec_field( + default=None, + display_name="Variables to Extract", + description=( + "Each entry declares one variable to capture, with its name, data " + "type, and extraction hint." + ), + display_options=DisplayOptions(show={"extraction_enabled": [True]}), + ) class _ToolDocumentRefsMixin(BaseModel): - tool_uuids: Optional[List[str]] = None - document_uuids: Optional[List[str]] = None + tool_uuids: Optional[List[str]] = spec_field( + default=None, + ui_type=PropertyType.tool_refs, + display_name="Tools", + description="Tools this node can invoke.", + llm_hint="List of tool UUIDs from `list_tools`.", + ) + document_uuids: Optional[List[str]] = spec_field( + default=None, + ui_type=PropertyType.document_refs, + display_name="Knowledge Base Documents", + description="Documents this node can reference.", + llm_hint="List of document UUIDs from `list_documents`.", + ) + mcp_tool_filters: Optional[Dict[str, List[str]]] = spec_field( + default=None, + spec_exclude=True, + ) +@node_spec( + name="startCall", + display_name="Start Call", + description="Entry point of the workflow — plays a greeting and opens the conversation.", + llm_hint=( + "The entry point of every workflow (exactly one required). Plays an " + "optional greeting, can fetch context from an external API before the " + "call begins, and executes the first conversational turn." + ), + category=NodeCategory.call_node, + icon="Play", + examples=[ + NodeExample( + name="warm_greeting", + data={ + "name": "Greeting", + "prompt": "Greet warmly and ask the caller's reason for calling.", + "greeting_type": "text", + "greeting": "Hi {{first_name}}, this is Sarah from Acme.", + "allow_interrupt": True, + }, + ) + ], + graph_constraints=GraphConstraints(min_incoming=0, max_incoming=0), + property_order=( + "name", + "greeting_type", + "greeting", + "greeting_recording_id", + "prompt", + "allow_interrupt", + "add_global_prompt", + "delayed_start", + "delayed_start_duration", + "extraction_enabled", + "extraction_prompt", + "extraction_variables", + "tool_uuids", + "document_uuids", + "pre_call_fetch_enabled", + "pre_call_fetch_url", + "pre_call_fetch_credential_uuid", + ), + field_overrides={ + "name": { + "spec_default": "Start Call", + "description": "Short identifier shown in the canvas and call logs.", + }, + "prompt": { + "description": ( + "Agent system prompt for the opening turn. Supports " + "{{template_variables}} from pre-call fetch and the initial context." + ), + "placeholder": "Greet the caller warmly and ask how you can help today.", + }, + "greeting_type": { + "display_name": "Greeting Type", + "description": ( + "Whether the optional greeting is spoken via TTS from text or " + "played from a pre-recorded audio file." + ), + "options": [ + PropertyOption(value="text", label="Text (TTS)"), + PropertyOption(value="audio", label="Pre-recorded Audio"), + ], + "spec_default": "text", + }, + "greeting": { + "display_name": "Greeting Text", + "description": ( + "Text spoken via TTS at the start of the call. Supports " + "{{template_variables}}. Leave empty to skip the greeting." + ), + "display_options": DisplayOptions(show={"greeting_type": ["text"]}), + "placeholder": "Hi {{first_name}}, this is Sarah from Acme.", + "editor": "textarea", + }, + "greeting_recording_id": { + "display_name": "Greeting Recording", + "description": "Pre-recorded audio file played at the start of the call.", + "ui_type": PropertyType.recording_ref, + "llm_hint": ( + "Value is the `recording_id` string. Use the `list_recordings` " + "MCP tool to discover available recordings." + ), + "display_options": DisplayOptions(show={"greeting_type": ["audio"]}), + }, + "allow_interrupt": { + "description": "When true, the user can interrupt the agent mid-utterance.", + }, + "tool_uuids": { + "description": "Tools the agent can invoke during the opening turn.", + }, + "document_uuids": { + "description": "Documents the agent can reference.", + }, + "delayed_start": { + "display_name": "Delayed Start", + "description": ( + "When true, the agent waits before speaking after pickup. Useful " + "for outbound calls where the called party needs a moment to settle." + ), + }, + "delayed_start_duration": { + "display_name": "Delay Duration (seconds)", + "description": "Seconds to wait before the agent speaks. 0.1–10.", + "spec_default": 2.0, + "min_value": 0.1, + "max_value": 10.0, + "display_options": DisplayOptions(show={"delayed_start": [True]}), + }, + "pre_call_fetch_enabled": { + "display_name": "Pre-Call Data Fetch", + "description": ( + "When true, makes a POST request to an external API before the " + "call starts and merges the JSON response into the call context " + "as template variables." + ), + }, + "pre_call_fetch_url": { + "display_name": "Endpoint URL", + "description": ( + "URL the pre-call POST request is sent to. The request body " + "includes caller and called numbers." + ), + "ui_type": PropertyType.url, + "display_options": DisplayOptions(show={"pre_call_fetch_enabled": [True]}), + "placeholder": "https://api.example.com/customer-lookup", + }, + "pre_call_fetch_credential_uuid": { + "display_name": "Authentication", + "description": "Optional credential attached to the pre-call request.", + "ui_type": PropertyType.credential_ref, + "llm_hint": "Credential UUID from `list_credentials`.", + "display_options": DisplayOptions(show={"pre_call_fetch_enabled": [True]}), + }, + }, +) class StartCallNodeData( - _NodeDataBase, + BaseNodeData, _PromptedNodeDataMixin, _ExtractionNodeDataMixin, _ToolDocumentRefsMixin, ): - is_start: bool = True - greeting: Optional[str] = None - greeting_type: Optional[str] = None # 'text' or 'audio' - greeting_recording_id: Optional[str] = None - wait_for_user_response: bool = False - wait_for_user_response_timeout: Optional[float] = None - detect_voicemail: bool = False - delayed_start: bool = False - delayed_start_duration: Optional[float] = None - pre_call_fetch_enabled: bool = False - pre_call_fetch_url: Optional[str] = None - pre_call_fetch_credential_uuid: Optional[str] = None + is_start: bool = spec_field(default=True, spec_exclude=True) + greeting: Optional[str] = spec_field(default=None, ui_type=PropertyType.string) + greeting_type: Optional[str] = spec_field( + default=None, ui_type=PropertyType.options + ) + greeting_recording_id: Optional[str] = spec_field( + default=None, ui_type=PropertyType.recording_ref + ) + delayed_start: bool = spec_field(default=False, ui_type=PropertyType.boolean) + delayed_start_duration: Optional[float] = spec_field( + default=None, ui_type=PropertyType.number + ) + pre_call_fetch_enabled: bool = spec_field( + default=False, ui_type=PropertyType.boolean + ) + pre_call_fetch_url: Optional[str] = spec_field( + default=None, ui_type=PropertyType.url + ) + pre_call_fetch_credential_uuid: Optional[str] = spec_field( + default=None, ui_type=PropertyType.credential_ref + ) +@node_spec( + name="agentNode", + display_name="Agent Node", + description="Conversational step — the LLM runs one focused exchange.", + llm_hint=( + "Mid-call step executed by the LLM. Most workflows are a chain of agent " + "nodes connected by edges that describe transition conditions. Each agent " + "node can invoke tools and reference documents." + ), + category=NodeCategory.call_node, + icon="Headset", + examples=[ + NodeExample( + name="qualify_lead", + data={ + "name": "Qualify Budget", + "prompt": "Ask about budget and timeline. Capture both before transitioning.", + "allow_interrupt": True, + "extraction_enabled": True, + "extraction_prompt": "Extract budget amount and rough timeline.", + "extraction_variables": [ + { + "name": "budget_usd", + "type": "number", + "prompt": "Stated budget in USD", + }, + { + "name": "timeline", + "type": "string", + "prompt": "When they want to start", + }, + ], + }, + ) + ], + graph_constraints=GraphConstraints(min_incoming=1), + property_order=( + "name", + "prompt", + "allow_interrupt", + "add_global_prompt", + "extraction_enabled", + "extraction_prompt", + "extraction_variables", + "tool_uuids", + "document_uuids", + ), + field_overrides={ + "name": { + "spec_default": "Agent", + "description": ( + "Short identifier for this step (e.g., 'Qualify Budget'). Appears " + "in call logs and edge transition tools." + ), + }, + "prompt": { + "description": ( + "Agent system prompt for this step. Supports {{template_variables}} " + "from extraction or pre-call fetch." + ), + "placeholder": "Ask the caller about their budget and timeline.", + }, + "allow_interrupt": { + "description": ( + "When true, the user can interrupt the agent mid-utterance. Set " + "false for non-interruptible disclosures." + ), + "spec_default": True, + }, + "tool_uuids": { + "description": "Tools the agent can invoke during this step.", + }, + "document_uuids": { + "description": "Documents the agent can reference during this step.", + }, + }, +) class AgentNodeData( - _NodeDataBase, + BaseNodeData, _PromptedNodeDataMixin, _ExtractionNodeDataMixin, _ToolDocumentRefsMixin, @@ -100,43 +426,450 @@ class AgentNodeData( pass +@node_spec( + name="endCall", + display_name="End Call", + description="Closes the conversation and hangs up.", + llm_hint=( + "Terminal node that politely closes the conversation. Variable extraction " + "can run before hangup. A workflow can have multiple endCall nodes reached " + "via different edge conditions." + ), + category=NodeCategory.call_node, + icon="OctagonX", + examples=[ + NodeExample( + name="successful_close", + data={ + "name": "Successful Close", + "prompt": "Confirm the appointment time, thank the caller, and end the call.", + "add_global_prompt": False, + }, + ) + ], + graph_constraints=GraphConstraints(min_incoming=1, min_outgoing=0, max_outgoing=0), + property_order=( + "name", + "prompt", + "add_global_prompt", + "extraction_enabled", + "extraction_prompt", + "extraction_variables", + ), + field_overrides={ + "name": { + "spec_default": "End Call", + "description": ( + "Short identifier shown in call logs. Should describe the ending " + "context (e.g., 'Successful close', 'Polite decline')." + ), + }, + "prompt": { + "description": ( + "Agent system prompt for the closing exchange. Supports " + "{{template_variables}} from extraction or pre-call fetch." + ), + "placeholder": "Thank the caller and confirm next steps before ending the call.", + }, + "allow_interrupt": {"spec_exclude": True}, + "add_global_prompt": { + "description": ( + "When true and a Global node exists, prepends the global prompt " + "to this node's prompt at runtime." + ), + "spec_default": False, + }, + "extraction_enabled": { + "description": ( + "When true, runs an LLM extraction pass before hangup to capture " + "variables from the conversation." + ) + }, + "extraction_prompt": { + "description": ( + "Overall instructions guiding how variables should be extracted " + "from the conversation." + ) + }, + "extraction_variables": { + "description": ( + "Each entry declares one variable to capture from the conversation, " + "with its name, data type, and a per-variable extraction hint." + ) + }, + }, +) class EndCallNodeData( - _NodeDataBase, + BaseNodeData, _PromptedNodeDataMixin, _ExtractionNodeDataMixin, ): - is_end: bool = True + is_end: bool = spec_field(default=True, spec_exclude=True) -class GlobalNodeData(_NodeDataBase, _PromptedNodeDataMixin): +@node_spec( + name="globalNode", + display_name="Global Node", + description="Persona/tone appended to every agent node's prompt.", + llm_hint=( + "System-level prompt appended to every prompted node whose " + "`add_global_prompt` is true. Use it for persona, tone, and shared " + "rules that apply across the entire conversation. At most one global " + "node per workflow." + ), + category=NodeCategory.global_node, + icon="Globe", + examples=[ + NodeExample( + name="basic_persona", + description="Establishes a consistent persona across the call.", + data={ + "name": "Persona", + "prompt": ( + "You are Sarah, a polite and warm representative from Acme Corp. " + "Always thank the caller for their time and speak in short " + "conversational sentences." + ), + }, + ) + ], + graph_constraints=GraphConstraints( + min_incoming=0, + max_incoming=0, + min_outgoing=0, + max_outgoing=0, + ), + property_order=("name", "prompt"), + field_overrides={ + "name": { + "spec_default": "Global Node", + "description": ( + "Short identifier shown in the canvas and call logs. Has no " + "runtime effect." + ), + }, + "prompt": { + "display_name": "Global Prompt", + "description": ( + "Text appended to every prompted node's system prompt when that " + "node has `add_global_prompt=true`. Supports {{template_variables}}." + ), + "placeholder": ( + "You are a friendly assistant calling on behalf of {{company_name}}." + ), + "spec_default": ( + "You are a helpful assistant whose mode of interaction with the " + "user is voice. So don't use any special characters which can not " + "be pronounced. Use short sentences and simple language." + ), + }, + "allow_interrupt": {"spec_exclude": True}, + "add_global_prompt": {"spec_exclude": True}, + }, +) +class GlobalNodeData(BaseNodeData, _PromptedNodeDataMixin): pass -class TriggerNodeData(_NodeDataBase): - trigger_path: Optional[str] = None - enabled: bool = True +@node_spec( + name="trigger", + display_name="API Trigger", + description="Public HTTP endpoints that launch the workflow.", + llm_hint=( + "Exposes two public HTTP POST endpoints derived from the auto-generated " + "`trigger_path`:\n" + " • Production: `/api/v1/public/agent/` — runs " + "the published agent. Use this from production systems.\n" + " • Test: `/api/v1/public/agent/test/` — runs " + "the latest draft, useful for verifying changes before publishing. Falls " + "back to the published agent when no draft exists.\n" + "Both require an API key in the `X-API-Key` header.\n" + "Request body fields:\n" + " • `phone_number` (string, required) — destination to dial.\n" + " • `initial_context` (object, optional) — merged into the run's initial context.\n" + " • `telephony_configuration_id` (int, optional) — pick a specific telephony " + "configuration for the call. Must belong to the same organization as the " + "trigger. When omitted, the org's default outbound configuration is used." + ), + category=NodeCategory.trigger, + icon="Webhook", + examples=[ + NodeExample(name="default", data={"name": "Inbound Trigger", "enabled": True}) + ], + graph_constraints=GraphConstraints(min_incoming=0, max_incoming=0), + property_order=("name", "enabled", "trigger_path"), + field_overrides={ + "name": { + "spec_default": "API Trigger", + "description": "Short identifier shown in the canvas. No runtime effect.", + }, + "enabled": { + "display_name": "Enabled", + "description": "When false, the trigger URL returns 404.", + }, + "trigger_path": { + "display_name": "Trigger Path", + "description": ( + "Auto-generated UUID-style path segment that uniquely identifies " + "this trigger. Used in both URLs:\n" + " • Production: `/api/v1/public/agent/` — executes " + "the published agent.\n" + " • Test: `/api/v1/public/agent/test/` — executes " + "the latest draft.\n" + "Do not edit manually." + ), + }, + }, +) +class TriggerNodeData(BaseNodeData): + trigger_path: Optional[str] = spec_field(default=None, ui_type=PropertyType.string) + enabled: bool = spec_field(default=True, ui_type=PropertyType.boolean) -class WebhookNodeData(_NodeDataBase): - enabled: bool = True - http_method: Optional[str] = None - endpoint_url: Optional[str] = None - credential_uuid: Optional[str] = None - custom_headers: Optional[list[CustomHeaderDTO]] = None - payload_template: Optional[dict] = None +@node_spec( + name="webhook", + display_name="Webhook", + description="Send HTTP request after the workflow completes.", + llm_hint=( + "Sends an HTTP request to an external system after the workflow completes. " + "The payload is a Jinja-templated JSON body with access to " + "`workflow_run_id`, `initial_context`, `gathered_context`, `annotations`, " + "and call metadata." + ), + category=NodeCategory.integration, + icon="Link2", + examples=[ + NodeExample( + name="post_to_crm", + data={ + "name": "Notify CRM", + "enabled": True, + "http_method": "POST", + "endpoint_url": "https://crm.example.com/calls", + "payload_template": { + "run_id": "{{workflow_run_id}}", + "outcome": "{{gathered_context.call_disposition}}", + }, + }, + ) + ], + graph_constraints=GraphConstraints( + min_incoming=0, max_incoming=0, min_outgoing=0, max_outgoing=0 + ), + property_order=( + "name", + "enabled", + "http_method", + "endpoint_url", + "credential_uuid", + "custom_headers", + "payload_template", + ), + field_overrides={ + "name": { + "spec_default": "Webhook", + "description": "Short identifier shown in the canvas and run logs.", + }, + "enabled": { + "display_name": "Enabled", + "description": "When false, the webhook is skipped at run time.", + }, + "http_method": { + "display_name": "HTTP Method", + "description": "HTTP verb used for the outbound request.", + "options": [ + PropertyOption(value="GET", label="GET"), + PropertyOption(value="POST", label="POST"), + PropertyOption(value="PUT", label="PUT"), + PropertyOption(value="PATCH", label="PATCH"), + PropertyOption(value="DELETE", label="DELETE"), + ], + "spec_default": "POST", + }, + "endpoint_url": { + "display_name": "Endpoint URL", + "description": "URL the request is sent to.", + "ui_type": PropertyType.url, + "placeholder": "https://api.example.com/webhook", + }, + "credential_uuid": { + "display_name": "Authentication", + "description": "Optional credential applied as the Authorization header.", + "ui_type": PropertyType.credential_ref, + "llm_hint": "Credential UUID from `list_credentials`.", + }, + "custom_headers": { + "display_name": "Custom Headers", + "description": "Additional HTTP headers to include with the request.", + }, + "payload_template": { + "display_name": "Payload Template", + "description": ( + "JSON body of the request. Values are Jinja-rendered against the " + "run context — `{{workflow_run_id}}`, `{{gathered_context.foo}}`, " + "`{{annotations.qa_xxx}}`, etc." + ), + "ui_type": PropertyType.json, + "spec_default": { + "call_id": "{{workflow_run_id}}", + "first_name": "{{initial_context.first_name}}", + "rsvp": "{{gathered_context.rsvp}}", + "duration": "{{cost_info.call_duration_seconds}}", + "recording_url": "{{recording_url}}", + "transcript_url": "{{transcript_url}}", + }, + }, + }, +) +class WebhookNodeData(BaseNodeData): + enabled: bool = spec_field(default=True, ui_type=PropertyType.boolean) + http_method: Optional[str] = spec_field(default=None, ui_type=PropertyType.options) + endpoint_url: Optional[str] = spec_field(default=None, ui_type=PropertyType.url) + credential_uuid: Optional[str] = spec_field( + default=None, ui_type=PropertyType.credential_ref + ) + custom_headers: Optional[list[CustomHeaderDTO]] = spec_field(default=None) + payload_template: Optional[dict] = spec_field( + default=None, ui_type=PropertyType.json + ) -class QANodeData(_NodeDataBase): - qa_enabled: bool = True - qa_use_workflow_llm: bool = True - qa_provider: Optional[str] = None - qa_model: Optional[str] = None - qa_api_key: Optional[str] = None - qa_endpoint: Optional[str] = None - qa_system_prompt: Optional[str] = None - qa_min_call_duration: int = 15 - qa_voicemail_calls: bool = False - qa_sample_rate: int = 100 +@node_spec( + name="qa", + display_name="QA Analysis", + description="Run LLM quality analysis on the call transcript.", + llm_hint=( + "Runs an LLM quality review on the call transcript after completion. " + "Per-node analysis splits the conversation by node and evaluates each " + "segment against the configured system prompt. Sampling, minimum " + "duration, and voicemail filters are supported." + ), + category=NodeCategory.integration, + icon="ClipboardCheck", + examples=[ + NodeExample( + name="basic_qa", + data={ + "name": "Compliance Check", + "qa_enabled": True, + "qa_system_prompt": ( + "You are a compliance reviewer. Review the transcript and " + "produce a JSON object with `tags`, `summary`, " + "`call_quality_score`, and `overall_sentiment`." + ), + "qa_min_call_duration": 30, + "qa_sample_rate": 100, + }, + ) + ], + graph_constraints=GraphConstraints( + min_incoming=0, max_incoming=0, min_outgoing=0, max_outgoing=0 + ), + property_order=( + "name", + "qa_enabled", + "qa_system_prompt", + "qa_min_call_duration", + "qa_voicemail_calls", + "qa_sample_rate", + "qa_use_workflow_llm", + "qa_provider", + "qa_model", + "qa_api_key", + "qa_endpoint", + ), + field_overrides={ + "name": { + "spec_default": "QA Analysis", + "description": "Short identifier for this QA configuration.", + }, + "qa_enabled": { + "display_name": "Enabled", + "description": "When false, the QA run is skipped.", + }, + "qa_system_prompt": { + "display_name": "System Prompt", + "description": ( + "Instructions to the QA reviewer LLM. Supports placeholders: " + "`{node_summary}`, `{previous_conversation_summary}`, " + "`{transcript}`, `{metrics}`." + ), + "spec_default": DEFAULT_QA_SYSTEM_PROMPT, + "editor": "textarea", + }, + "qa_min_call_duration": { + "display_name": "Minimum Call Duration (seconds)", + "description": "Calls shorter than this are skipped.", + "min_value": 0, + }, + "qa_voicemail_calls": { + "display_name": "Include Voicemail Calls", + "description": "When false, calls flagged as voicemail are skipped.", + }, + "qa_sample_rate": { + "display_name": "Sample Rate (%)", + "description": ( + "Percent of eligible calls QA'd. 100 means every call; lower " + "values use random sampling." + ), + "min_value": 1, + "max_value": 100, + }, + "qa_use_workflow_llm": { + "display_name": "Use Workflow's LLM", + "description": ( + "When true, the QA pass uses the same LLM the workflow runs with. " + "Set false to specify a separate provider/model." + ), + }, + "qa_provider": { + "display_name": "QA LLM Provider", + "description": "LLM provider used for the QA pass.", + "options": [ + PropertyOption(value="openai", label="OpenAI"), + PropertyOption(value="azure", label="Azure OpenAI"), + PropertyOption(value="openrouter", label="OpenRouter"), + PropertyOption(value="anthropic", label="Anthropic"), + ], + "display_options": DisplayOptions(show={"qa_use_workflow_llm": [False]}), + }, + "qa_model": { + "display_name": "QA Model", + "description": ( + "Model identifier (e.g., 'gpt-4o', 'claude-sonnet-4-6'). " + "Provider-specific." + ), + "spec_default": "default", + "display_options": DisplayOptions(show={"qa_use_workflow_llm": [False]}), + }, + "qa_api_key": { + "display_name": "API Key", + "description": "API key for the chosen provider.", + "display_options": DisplayOptions(show={"qa_use_workflow_llm": [False]}), + }, + "qa_endpoint": { + "display_name": "Azure Endpoint", + "description": "Required for the Azure provider.", + "ui_type": PropertyType.url, + "display_options": DisplayOptions( + show={"qa_use_workflow_llm": [False], "qa_provider": ["azure"]} + ), + }, + }, +) +class QANodeData(BaseNodeData): + qa_enabled: bool = spec_field(default=True, ui_type=PropertyType.boolean) + qa_use_workflow_llm: bool = spec_field(default=True, ui_type=PropertyType.boolean) + qa_provider: Optional[str] = spec_field(default=None, ui_type=PropertyType.options) + qa_model: Optional[str] = spec_field(default=None, ui_type=PropertyType.string) + qa_api_key: Optional[str] = spec_field(default=None, ui_type=PropertyType.string) + qa_endpoint: Optional[str] = spec_field(default=None, ui_type=PropertyType.url) + qa_system_prompt: Optional[str] = spec_field( + default=None, ui_type=PropertyType.string + ) + qa_min_call_duration: int = spec_field(default=15, ui_type=PropertyType.number) + qa_voicemail_calls: bool = spec_field(default=False, ui_type=PropertyType.boolean) + qa_sample_rate: int = spec_field(default=100, ui_type=PropertyType.number) # Union of every per-type data class — useful as a type annotation on @@ -156,9 +889,9 @@ NodeDataDTO = Union[ # ───────────────────────────────────────────────────────────────────────── # Per-type RF nodes. # -# RFNodeDTO is a discriminated Union over `type`. Pydantic dispatches to -# the right variant when validating wire JSON. Direct instantiation must -# use the concrete per-type class (StartCallRFNode, AgentRFNode, ...). +# Core node variants keep concrete helper classes for tests and type-aware +# consumers. The persisted workflow DTO itself validates `type` dynamically +# against the core registry plus any integration packages. # ───────────────────────────────────────────────────────────────────────── @@ -228,18 +961,38 @@ class QARFNode(_RFNodeBase): data: QANodeData -RFNodeDTO = Annotated[ - Union[ - StartCallRFNode, - AgentRFNode, - EndCallRFNode, - GlobalRFNode, - TriggerRFNode, - WebhookRFNode, - QARFNode, - ], - Field(discriminator="type"), -] +_PROMPT_REQUIRED_NODE_TYPES: dict[str, str] = { + NodeType.startNode.value: "start", + NodeType.agentNode.value: "agent", + NodeType.endNode.value: "end", + NodeType.globalNode.value: "global", +} + + +class RFNodeDTO(_RFNodeBase): + type: str = Field(..., min_length=1) + data: Any + + @field_validator("type") + @classmethod + def _validate_type(cls, value: str) -> str: + if get_node_data_model(value) is None: + raise ValueError(f"Unknown node type: {value!r}") + return value + + @model_validator(mode="after") + def _validate(self): + data_model = get_node_data_model(self.type) + if data_model is None: + raise ValueError(f"Unknown node type: {self.type!r}") + + self.data = data_model.model_validate(self.data) + + prompt_label = _PROMPT_REQUIRED_NODE_TYPES.get(self.type) + if prompt_label: + _require_prompt(self.data, prompt_label) + + return self # ───────────────────────────────────────────────────────────────────────── @@ -293,9 +1046,7 @@ class ReactFlowDTO(BaseModel): return self -# Node type → per-type data class. Keeps sanitize_workflow_definition in -# step with RFNodeDTO's discriminated union. -_NODE_DATA_CLASSES: dict[str, type[BaseModel]] = { +_CORE_NODE_DATA_CLASSES: dict[str, type[BaseNodeData]] = { NodeType.startNode.value: StartCallNodeData, NodeType.agentNode.value: AgentNodeData, NodeType.endNode.value: EndCallNodeData, @@ -306,6 +1057,18 @@ _NODE_DATA_CLASSES: dict[str, type[BaseModel]] = { } +def get_node_data_model(type_name: str) -> type[BaseNodeData] | None: + return _CORE_NODE_DATA_CLASSES.get(type_name) or get_integration_node_data_model( + type_name + ) + + +def all_node_type_names() -> set[str]: + return set(_CORE_NODE_DATA_CLASSES) | { + node.type_name for package in all_packages() for node in package.nodes + } + + def sanitize_workflow_definition(definition: dict | None) -> dict | None: """Strip unknown fields from each node.data and edge.data so UI-only runtime state (`invalid`, `validationMessage`, etc.) doesn't leak into @@ -332,7 +1095,7 @@ def sanitize_workflow_definition(definition: dict | None) -> dict | None: def _sanitize_node(node): if not isinstance(node, dict): return node - data_cls = _NODE_DATA_CLASSES.get(node.get("type")) + data_cls = get_node_data_model(node.get("type")) raw_data = node.get("data") if not data_cls or not isinstance(raw_data, dict): return node diff --git a/api/services/workflow/mcp_tool_session.py b/api/services/workflow/mcp_tool_session.py new file mode 100644 index 0000000..0caa1b7 --- /dev/null +++ b/api/services/workflow/mcp_tool_session.py @@ -0,0 +1,254 @@ +"""Single unit that knows the MCP protocol + credentials. + +Wraps the vendored Pipecat ``MCPClient`` for connection/session, builds +streamable-HTTP params from a Dograh credential, exposes namespaced +``FunctionSchema``s, and proxies tool calls. Connection failures degrade +(``available = False``) instead of raising — the call must survive a +dead MCP server. +""" + +from __future__ import annotations + +import asyncio +from datetime import timedelta +from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set + +from loguru import logger +from mcp.client.session_group import StreamableHttpParameters +from pipecat.adapters.schemas.function_schema import FunctionSchema +from pipecat.services.mcp_service import MCPClient + +from api.services.workflow.tools.mcp_tool import namespace_function_name +from api.utils.credential_auth import build_auth_header + +if TYPE_CHECKING: + from api.db.models import ExternalCredentialModel + + +def build_streamable_http_params( + *, + url: str, + credential: Optional["ExternalCredentialModel"], + timeout_secs: int, + sse_read_timeout_secs: int, +) -> StreamableHttpParameters: + """Build Pipecat/MCP streamable-HTTP params, injecting the auth header + from an ExternalCredentialModel (reuses the http_api credential path).""" + headers: Optional[Dict[str, str]] = None + if credential is not None: + auth = build_auth_header(credential) + headers = auth or None + return StreamableHttpParameters( + url=url, + headers=headers, + timeout=timedelta(seconds=timeout_secs), + sse_read_timeout=timedelta(seconds=sse_read_timeout_secs), + ) + + +class McpToolSession: + """One live MCP server connection for the duration of a call.""" + + def __init__( + self, + *, + tool_uuid: str, + tool_name: str, + url: str, + credential: Optional["ExternalCredentialModel"], + tools_filter: List[str], + timeout_secs: int, + sse_read_timeout_secs: int, + ) -> None: + self._tool_uuid = tool_uuid + self._tool_name = tool_name + self._url = url + self._credential = credential + # An empty list is intentionally treated as "no filter (expose all + # tools)" — Pipecat's MCPClient applies a filter only when this is a + # non-empty list, so [] and None are equivalent ("all tools"). + self._tools_filter = tools_filter or None + self._timeout_secs = timeout_secs + self._sse_read_timeout_secs = sse_read_timeout_secs + + self._client: Optional[MCPClient] = None + self._session: Any = None # mcp.ClientSession (read once after start) + self._schemas: List[FunctionSchema] = [] + # namespaced LLM name -> original MCP tool name + self._name_map: Dict[str, str] = {} + self.available: bool = False + + async def start(self) -> None: + """Connect, initialize, and cache the tool list. Never raises — + on any failure the session is marked unavailable.""" + try: + params = build_streamable_http_params( + url=self._url, + credential=self._credential, + timeout_secs=self._timeout_secs, + sse_read_timeout_secs=self._sse_read_timeout_secs, + ) + self._client = MCPClient(params, tools_filter=self._tools_filter) + await self._client.start() + # Single, isolated touch of Pipecat internals (vendored submodule). + self._session = self._client._active_session + tools_schema = await self._client.get_tools_schema() + + fallback = self._tool_uuid[:8] if self._tool_uuid else "server" + for fs in tools_schema.standard_tools: + ns_name = namespace_function_name( + self._tool_name, fs.name, fallback=fallback + ) + self._name_map[ns_name] = fs.name + self._schemas.append( + FunctionSchema( + name=ns_name, + description=fs.description, + properties=fs.properties, + required=fs.required, + ) + ) + self.available = True + logger.info( + f"MCP session ready for tool '{self._tool_name}' " + f"({self._tool_uuid}): {sorted(self._name_map)}" + ) + except (KeyboardInterrupt, SystemExit): + raise + except asyncio.CancelledError as e: + # Empirically, a dead/unreachable MCP server does NOT surface as a + # plain Exception here. The real failure is httpx.ConnectError, but + # anyio's streamablehttp_client task group, while tearing down that + # ConnectError, re-surfaces it to our frame as an *internal* + # cancel-scope CancelledError carrying the signature message + # "Cancelled via cancel scope ". A genuine *external* + # cancellation (call teardown / shutdown) is a bare CancelledError + # (empty args) or one with an application-chosen message. Type, MRO, + # context chain, and asyncio task.cancelling() are all identical + # between the two, so the anyio scope-signature message is the only + # reliable discriminator. Re-raise genuine external cancellation to + # preserve structured concurrency; degrade only on the anyio + # connect-teardown artifact. + msg = "" if not e.args else str(e.args[0] or "") + if not msg.startswith("Cancelled via cancel scope"): + raise + await self._degrade(e) + except Exception as e: # noqa: BLE001 — see _degrade docstring + # Defensive: if a future Pipecat/httpx version surfaces the connect + # failure directly (e.g. httpx.ConnectError) instead of via the + # anyio cancel-scope artifact above, still degrade gracefully. + await self._degrade(e) + + async def _degrade(self, e: BaseException) -> None: + """Mark this session unavailable and tear down any dangling client so + start() leaves self._client either fully usable or None. The contract + requires graceful degradation on any *connect* failure (never raising + for a dead MCP server) while genuine external cancellation / + KeyboardInterrupt / SystemExit are re-raised by the caller.""" + self.available = False + self._schemas = [] + self._name_map = {} + # Self-contained cleanup: _client.start() may have succeeded before a + # later step (e.g. get_tools_schema()) failed, leaving an open client. + if self._client is not None: + try: + await self._client.close() + except Exception: + pass + finally: + self._client = None + self._session = None + logger.warning( + f"MCP session unavailable for tool '{self._tool_name}' " + f"({self._tool_uuid}) at {self._url}: {e!r}. " + f"Call proceeds without these tools." + ) + + @property + def call_timeout_secs(self) -> float: + """Pipecat function-call timeout for this server's tools. Slightly + longer than the transport read timeout so a slow MCP call surfaces + as a structured tool error (handled in the handler) rather than a + hard pipeline timeout.""" + return float(self._sse_read_timeout_secs) + 5.0 + + def function_schemas( + self, allowed_raw_names: Optional[Set[str]] = None + ) -> List[FunctionSchema]: + """Return cached FunctionSchemas, optionally filtered by raw MCP tool name. + + ``allowed_raw_names=None`` returns all schemas. An empty set returns none. + Raw names are the pre-namespace MCP tool names (e.g. ``echo``, not + ``mcp__slug__echo``). + """ + if allowed_raw_names is None: + return list(self._schemas) + return [ + s for s in self._schemas if self._name_map.get(s.name) in allowed_raw_names + ] + + def discovered_tools(self) -> List[Dict[str, str]]: + """Raw MCP tool catalog for UI/cache: ``[{name, description}]`` + using the *raw* server names (not the namespaced LLM names). + Empty if the session is unavailable.""" + out: List[Dict[str, str]] = [] + for s in self._schemas: + raw = self._name_map.get(s.name) + if raw is None: + continue + out.append({"name": raw, "description": s.description or ""}) + return out + + async def call(self, namespaced_name: str, arguments: Dict[str, Any]) -> str: + """Invoke an MCP tool by its namespaced LLM name. Returns a string + (flattened text content). Raises if the session is unavailable so + the caller can map it to a structured error for the LLM.""" + if not self.available or self._session is None: + raise RuntimeError(f"MCP session unavailable for {namespaced_name}") + original = self._name_map.get(namespaced_name) + if original is None: + raise RuntimeError(f"Unknown MCP function {namespaced_name}") + result = await self._session.call_tool(original, arguments=arguments) + text = "" + for content in getattr(result, "content", []) or []: + if getattr(content, "text", None): + text += content.text + return text or "Sorry, the MCP tool returned no content." + + async def close(self) -> None: + if self._client is not None: + try: + await self._client.close() + except Exception as e: + logger.warning(f"Error closing MCP session {self._tool_uuid}: {e}") + finally: + self._client = None + self._session = None + + +async def discover_mcp_tools( + *, + url: str, + credential: Optional["ExternalCredentialModel"], + timeout_secs: int, + sse_read_timeout_secs: int, +) -> List[Dict[str, str]]: + """Open an ephemeral MCP session, list its tools, close it. Returns + ``[{name, description}]`` (raw names). Never raises — on any connect + failure returns ``[]``.""" + session = McpToolSession( + tool_uuid="discover", + tool_name="discover", + url=url, + credential=credential, + tools_filter=[], + timeout_secs=timeout_secs, + sse_read_timeout_secs=sse_read_timeout_secs, + ) + await session.start() + try: + if not session.available: + return [] + return session.discovered_tools() + finally: + await session.close() diff --git a/api/services/workflow/node_data.py b/api/services/workflow/node_data.py new file mode 100644 index 0000000..deb9638 --- /dev/null +++ b/api/services/workflow/node_data.py @@ -0,0 +1,19 @@ +from __future__ import annotations + +from pydantic import BaseModel + +from api.services.workflow.node_specs._base import PropertyType +from api.services.workflow.node_specs.model_spec import spec_field + + +class BaseNodeData(BaseModel): + name: str = spec_field( + ..., + min_length=1, + ui_type=PropertyType.string, + display_name="Name", + description="Short identifier shown in the canvas and call logs.", + required=True, + ) + is_start: bool = spec_field(default=False, spec_exclude=True) + is_end: bool = spec_field(default=False, spec_exclude=True) diff --git a/api/services/workflow/node_specs/__init__.py b/api/services/workflow/node_specs/__init__.py index 93f6ab0..620fb49 100644 --- a/api/services/workflow/node_specs/__init__.py +++ b/api/services/workflow/node_specs/__init__.py @@ -1,10 +1,8 @@ """Node specification registry. -Adding a new node type: -1. Create a new module under this package, define a `SPEC: NodeSpec`. -2. Add it to the imports + REGISTRY below. -3. The Pydantic discriminated-union variant in dto.py must use the same - `name` value as `SPEC.name`. +Core node specs are generated from the workflow DTO models. Third-party +integration node specs live under `api.services.integrations//` and +register through the integration registry so they don't need edits here. """ from __future__ import annotations @@ -21,8 +19,10 @@ from api.services.workflow.node_specs._base import ( PropertyType, evaluate_display_options, ) +from api.services.workflow.node_specs.model_spec import build_spec REGISTRY: dict[str, NodeSpec] = {} +_CORE_SPECS_LOADED = False def register(spec: NodeSpec) -> NodeSpec: @@ -38,12 +38,23 @@ def register(spec: NodeSpec) -> NodeSpec: def get_spec(name: str) -> NodeSpec | None: - return REGISTRY.get(name) + _ensure_core_registered() + if name in REGISTRY: + return REGISTRY[name] + + from api.services.integrations import get_node_spec + + return get_node_spec(name) def all_specs() -> list[NodeSpec]: """All registered specs, sorted by name for stable output.""" - return [REGISTRY[name] for name in sorted(REGISTRY)] + _ensure_core_registered() + from api.services.integrations import all_node_specs + + specs = {spec.name: spec for spec in REGISTRY.values()} + specs.update({spec.name: spec for spec in all_node_specs()}) + return [specs[name] for name in sorted(specs)] __all__ = [ @@ -64,19 +75,15 @@ __all__ = [ ] -# Side-effect imports — each module's `register(SPEC)` call populates REGISTRY. -# Keep at module bottom so the registry helpers are defined first. -from api.services.workflow.node_specs import ( # noqa: E402, F401 - agent, - end_call, - global_node, - qa, - start_call, - trigger, - webhook, -) +def _ensure_core_registered() -> None: + global _CORE_SPECS_LOADED + if _CORE_SPECS_LOADED: + return -# Wire up registrations from the SPEC constants in each module. -for _module in (start_call, agent, end_call, global_node, trigger, webhook, qa): - register(_module.SPEC) -del _module + from api.services.workflow.dto import _CORE_NODE_DATA_CLASSES + + for model_cls in _CORE_NODE_DATA_CLASSES.values(): + if model_cls.__node_spec_metadata__.name in REGISTRY: + continue + register(build_spec(model_cls)) + _CORE_SPECS_LOADED = True diff --git a/api/services/workflow/node_specs/_base.py b/api/services/workflow/node_specs/_base.py index cbf044f..b8324c1 100644 --- a/api/services/workflow/node_specs/_base.py +++ b/api/services/workflow/node_specs/_base.py @@ -1,9 +1,9 @@ """Spec schema for node definitions. -A `NodeSpec` is the single source of truth for a node type. It drives: -- Pydantic validation (the per-type DTOs in dto.py mirror these property types) -- The generic UI renderer (frontend reads specs via /api/v1/node-types) -- The LLM SDK (constructors and JSON-Schema derived from these specs) +`NodeSpec` is the serialized contract exposed to the frontend, MCP tools, and +SDKs. Core workflow node specs are generated from the DTO models plus +model-attached metadata; integration packages may generate them the same way or +register a prebuilt spec object. Every property's `description` is LLM-readable copy — treat it as production documentation, not internal notes. Spec lint enforces non-empty descriptions @@ -122,6 +122,16 @@ class PropertyOption(BaseModel): model_config = ConfigDict(extra="forbid") + def to_mcp_dict(self) -> dict[str, Any]: + """Lean projection for `get_node_type`: the `value` an LLM writes in + code, plus a `description` when one carries real meaning. The UI + `label` is dropped — it's the option's display string, never used + when authoring.""" + out: dict[str, Any] = {"value": self.value} + if self.description: + out["description"] = self.description + return out + class PropertySpec(BaseModel): """Single field on a node. @@ -175,6 +185,43 @@ class PropertySpec(BaseModel): model_config = ConfigDict(extra="forbid") + def to_mcp_dict(self) -> dict[str, Any]: + """Lean projection of this property for the `get_node_type` MCP tool. + + Keeps only what an LLM needs to author a valid value: name, type, + description, llm_hint, requiredness, default, enum options, nested + row properties, and validation bounds. UI-rendering concerns + (`display_name`, `placeholder`, `display_options`, `editor`, + `extra`) and null/empty fields are omitted — they're noise in the + model's context and never appear in authored SDK code. + """ + out: dict[str, Any] = { + "name": self.name, + "type": self.type.value, + "description": self.description, + } + if self.llm_hint: + out["llm_hint"] = self.llm_hint + if self.required: + out["required"] = True + if self.default is not None: + out["default"] = self.default + if self.options: + out["options"] = [opt.to_mcp_dict() for opt in self.options] + if self.properties: + out["properties"] = [prop.to_mcp_dict() for prop in self.properties] + for constraint in ( + "min_value", + "max_value", + "min_length", + "max_length", + "pattern", + ): + value = getattr(self, constraint) + if value is not None: + out[constraint] = value + return out + PropertySpec.model_rebuild() @@ -222,3 +269,33 @@ class NodeSpec(BaseModel): graph_constraints: Optional[GraphConstraints] = None model_config = ConfigDict(extra="forbid") + + def to_mcp_dict(self) -> dict[str, Any]: + """Lean projection of this spec for the `get_node_type` MCP tool. + + Drops node-level UI metadata (`display_name`, `category`, `icon`, + `version`) and the per-property rendering concerns trimmed by + `PropertySpec.to_mcp_dict`, leaving just the authoring-relevant + schema the LLM consumes when composing a workflow. The full spec is + still served verbatim to the frontend renderer (REST `node-types` + route) and the SDK codegen / TS validator (`ts_bridge`), which need + the dropped fields. + """ + out: dict[str, Any] = { + "name": self.name, + "description": self.description, + } + if self.llm_hint: + out["llm_hint"] = self.llm_hint + out["properties"] = [prop.to_mcp_dict() for prop in self.properties] + if self.examples: + out["examples"] = [ + ex.model_dump(mode="json", exclude_none=True) for ex in self.examples + ] + if self.graph_constraints: + constraints = self.graph_constraints.model_dump( + mode="json", exclude_none=True + ) + if constraints: + out["graph_constraints"] = constraints + return out diff --git a/api/services/workflow/node_specs/agent.py b/api/services/workflow/node_specs/agent.py deleted file mode 100644 index 218fd9f..0000000 --- a/api/services/workflow/node_specs/agent.py +++ /dev/null @@ -1,168 +0,0 @@ -"""Spec for the Agent node — the workhorse mid-call node where the LLM -executes a focused conversational step with optional tools and documents.""" - -from api.services.workflow.node_specs._base import ( - DisplayOptions, - GraphConstraints, - NodeCategory, - NodeExample, - NodeSpec, - PropertyOption, - PropertySpec, - PropertyType, -) - -SPEC = NodeSpec( - name="agentNode", - display_name="Agent Node", - description="Conversational step — the LLM runs one focused exchange.", - llm_hint=( - "Mid-call step executed by the LLM. Most workflows are a chain of " - "agent nodes connected by edges that describe transition conditions. " - "Each agent node can invoke tools and reference documents." - ), - category=NodeCategory.call_node, - icon="Headset", - properties=[ - PropertySpec( - name="name", - type=PropertyType.string, - display_name="Name", - description=( - "Short identifier for this step (e.g., 'Qualify Budget'). " - "Appears in call logs and edge transition tools." - ), - required=True, - min_length=1, - default="Agent", - ), - PropertySpec( - name="prompt", - type=PropertyType.mention_textarea, - display_name="Prompt", - description=( - "Agent system prompt for this step. Supports " - "{{template_variables}} from extraction or pre-call fetch." - ), - required=True, - min_length=1, - placeholder="Ask the caller about their budget and timeline.", - ), - PropertySpec( - name="allow_interrupt", - type=PropertyType.boolean, - display_name="Allow Interruption", - description=( - "When true, the user can interrupt the agent mid-utterance. " - "Set false for non-interruptible disclosures." - ), - default=True, - ), - PropertySpec( - name="add_global_prompt", - type=PropertyType.boolean, - display_name="Add Global Prompt", - description=( - "When true and a Global node exists, prepends the global " - "prompt to this node's prompt at runtime." - ), - default=True, - ), - PropertySpec( - name="extraction_enabled", - type=PropertyType.boolean, - display_name="Enable Variable Extraction", - description=( - "When true, runs an LLM extraction pass on transition out of " - "this node to capture variables from the conversation." - ), - default=False, - ), - PropertySpec( - name="extraction_prompt", - type=PropertyType.string, - display_name="Extraction Prompt", - description="Overall instructions guiding variable extraction.", - display_options=DisplayOptions(show={"extraction_enabled": [True]}), - editor="textarea", - ), - PropertySpec( - name="extraction_variables", - type=PropertyType.fixed_collection, - display_name="Variables to Extract", - description=( - "Each entry declares one variable to capture from the " - "conversation, with its name, type, and per-variable hint." - ), - display_options=DisplayOptions(show={"extraction_enabled": [True]}), - properties=[ - PropertySpec( - name="name", - type=PropertyType.string, - display_name="Variable Name", - description="snake_case identifier used downstream.", - required=True, - ), - PropertySpec( - name="type", - type=PropertyType.options, - display_name="Type", - description="Data type of the extracted value.", - required=True, - default="string", - options=[ - PropertyOption(value="string", label="String"), - PropertyOption(value="number", label="Number"), - PropertyOption(value="boolean", label="Boolean"), - ], - ), - PropertySpec( - name="prompt", - type=PropertyType.string, - display_name="Extraction Hint", - description="Per-variable hint describing what to look for.", - editor="textarea", - ), - ], - ), - PropertySpec( - name="tool_uuids", - type=PropertyType.tool_refs, - display_name="Tools", - description="Tools the agent can invoke during this step.", - llm_hint="List of tool UUIDs from `list_tools`.", - ), - PropertySpec( - name="document_uuids", - type=PropertyType.document_refs, - display_name="Knowledge Base Documents", - description="Documents the agent can reference during this step.", - llm_hint="List of document UUIDs from `list_documents`.", - ), - ], - examples=[ - NodeExample( - name="qualify_lead", - data={ - "name": "Qualify Budget", - "prompt": "Ask about budget and timeline. Capture both before transitioning.", - "allow_interrupt": True, - "extraction_enabled": True, - "extraction_prompt": "Extract budget amount and rough timeline.", - "extraction_variables": [ - { - "name": "budget_usd", - "type": "number", - "prompt": "Stated budget in USD", - }, - { - "name": "timeline", - "type": "string", - "prompt": "When they want to start", - }, - ], - }, - ), - ], - graph_constraints=GraphConstraints(min_incoming=1), -) diff --git a/api/services/workflow/node_specs/constants.py b/api/services/workflow/node_specs/constants.py new file mode 100644 index 0000000..c5b7544 --- /dev/null +++ b/api/services/workflow/node_specs/constants.py @@ -0,0 +1,44 @@ +DEFAULT_QA_SYSTEM_PROMPT = """You are a QA analyst evaluating a specific segment of a voice AI conversation. + +## Node Purpose +{{node_summary}} + +## Previous Conversation Context (For start of conversation, previous conversation summary can be empty.) +{{previous_conversation_summary}} + +## Tags to evaluate + +Examine the conversation carefully and identify which of the following tags apply: + +- UNCLEAR_CONVERSATION - The conversation is not coherent or clear, messages don't connect logically +- ASSISTANT_IN_LOOP - The assistant asks the same question multiple times or gets stuck repeating itself +- ASSISTANT_REPLY_IMPROPER - The assistant did not reply properly to the user's question/query or seems confused by what the user said +- USER_FRUSTRATED - The user seems angry, frustrated, or is complaining about something in the call +- USER_NOT_UNDERSTANDING - The user explicitly says they don't understand or repeatedly asks for clarification +- HEARING_ISSUES - Either party can't hear the other ("hello?", "are you there?", "can you hear me?") +- DEAD_AIR - Unusually long silences in the conversation (use the timestamps to judge) +- USER_REQUESTING_FEATURE - The user asks for something the assistant can't fulfill +- ASSISTANT_LACKS_EMPATHY - The assistant ignores the user's personal situation or emotional state and continues pitching or pushing the agenda. +- USER_DETECTS_AI - The user suspects or identifies that they are talking to an AI/robot/bot rather than a real human. + +## Call metrics (pre-computed) + +Use these alongside the transcript for your analysis: +{{metrics}} + +## Output format + +Return ONLY a valid JSON object (no markdown): +{ + "tags": [ + { + "tag": "TAG_NAME", + "reason": "Short reason with evidence from the transcript" + } + ], + "overall_sentiment": "positive|neutral|negative", + "call_quality_score": <1-10>, + "summary": "1-2 sentence summary of this segment" +} + +If no tags apply, return an empty tags list. Always provide sentiment, score, and summary.""" diff --git a/api/services/workflow/node_specs/end_call.py b/api/services/workflow/node_specs/end_call.py deleted file mode 100644 index 33129ed..0000000 --- a/api/services/workflow/node_specs/end_call.py +++ /dev/null @@ -1,141 +0,0 @@ -"""Spec for the End Call node — terminal node that wraps up a conversation -and optionally extracts variables before hangup.""" - -from api.services.workflow.node_specs._base import ( - DisplayOptions, - GraphConstraints, - NodeCategory, - NodeExample, - NodeSpec, - PropertyOption, - PropertySpec, - PropertyType, -) - -SPEC = NodeSpec( - name="endCall", - display_name="End Call", - description="Closes the conversation and hangs up.", - llm_hint=( - "Terminal node that politely closes the conversation. Variable " - "extraction can run before hangup. A workflow can have multiple " - "endCall nodes reached via different edge conditions." - ), - category=NodeCategory.call_node, - icon="OctagonX", - properties=[ - PropertySpec( - name="name", - type=PropertyType.string, - display_name="Name", - description=( - "Short identifier shown in call logs. Should describe the " - "ending context (e.g., 'Successful close', 'Polite decline')." - ), - required=True, - min_length=1, - default="End Call", - ), - PropertySpec( - name="prompt", - type=PropertyType.mention_textarea, - display_name="Prompt", - description=( - "Agent system prompt for the closing exchange. Supports " - "{{template_variables}} from extraction or pre-call fetch." - ), - required=True, - min_length=1, - placeholder="Thank the caller and confirm next steps before ending the call.", - ), - PropertySpec( - name="add_global_prompt", - type=PropertyType.boolean, - display_name="Add Global Prompt", - description=( - "When true and a Global node exists, prepends the global " - "prompt to this node's prompt at runtime." - ), - default=False, - ), - PropertySpec( - name="extraction_enabled", - type=PropertyType.boolean, - display_name="Enable Variable Extraction", - description=( - "When true, runs an LLM extraction pass before hangup to " - "capture variables from the conversation." - ), - default=False, - ), - PropertySpec( - name="extraction_prompt", - type=PropertyType.string, - display_name="Extraction Prompt", - description=( - "Overall instructions guiding how variables should be " - "extracted from the conversation." - ), - display_options=DisplayOptions(show={"extraction_enabled": [True]}), - editor="textarea", - ), - PropertySpec( - name="extraction_variables", - type=PropertyType.fixed_collection, - display_name="Variables to Extract", - description=( - "Each entry declares one variable to capture from the " - "conversation, with its name, data type, and a per-variable " - "extraction hint." - ), - display_options=DisplayOptions(show={"extraction_enabled": [True]}), - properties=[ - PropertySpec( - name="name", - type=PropertyType.string, - display_name="Variable Name", - description="snake_case identifier used downstream.", - required=True, - ), - PropertySpec( - name="type", - type=PropertyType.options, - display_name="Type", - description="The data type of the extracted value.", - required=True, - default="string", - options=[ - PropertyOption(value="string", label="String"), - PropertyOption(value="number", label="Number"), - PropertyOption(value="boolean", label="Boolean"), - ], - ), - PropertySpec( - name="prompt", - type=PropertyType.string, - display_name="Extraction Hint", - description=( - "Per-variable hint describing what to look for in " - "the conversation." - ), - editor="textarea", - ), - ], - ), - ], - examples=[ - NodeExample( - name="successful_close", - data={ - "name": "Successful Close", - "prompt": "Confirm the appointment time, thank the caller, and end the call.", - "add_global_prompt": False, - }, - ), - ], - graph_constraints=GraphConstraints( - min_incoming=1, - min_outgoing=0, - max_outgoing=0, - ), -) diff --git a/api/services/workflow/node_specs/global_node.py b/api/services/workflow/node_specs/global_node.py deleted file mode 100644 index bd983d7..0000000 --- a/api/services/workflow/node_specs/global_node.py +++ /dev/null @@ -1,77 +0,0 @@ -"""Spec for the Global node — system-level instructions appended to every -agent node that opts in via `add_global_prompt`.""" - -from api.services.workflow.node_specs._base import ( - GraphConstraints, - NodeCategory, - NodeExample, - NodeSpec, - PropertySpec, - PropertyType, -) - -SPEC = NodeSpec( - name="globalNode", - display_name="Global Node", - description="Persona/tone appended to every agent node's prompt.", - llm_hint=( - "System-level prompt appended to every prompted node whose " - "`add_global_prompt` is true. Use it for persona, tone, and shared " - "rules that apply across the entire conversation. At most one " - "global node per workflow." - ), - category=NodeCategory.global_node, - icon="Globe", - properties=[ - PropertySpec( - name="name", - type=PropertyType.string, - display_name="Name", - description=( - "Short identifier shown in the canvas and call logs. Has no " - "runtime effect." - ), - required=True, - min_length=1, - default="Global Node", - ), - PropertySpec( - name="prompt", - type=PropertyType.mention_textarea, - display_name="Global Prompt", - description=( - "Text appended to every prompted node's system prompt when " - "that node has `add_global_prompt=true`. Supports " - "{{template_variables}}." - ), - required=True, - min_length=1, - placeholder="You are a friendly assistant calling on behalf of {{company_name}}.", - default=( - "You are a helpful assistant whose mode of interaction with " - "the user is voice. So don't use any special characters which " - "can not be pronounced. Use short sentences and simple language." - ), - ), - ], - examples=[ - NodeExample( - name="basic_persona", - description="Establishes a consistent persona across the call.", - data={ - "name": "Persona", - "prompt": ( - "You are Sarah, a polite and warm representative from " - "Acme Corp. Always thank the caller for their time and " - "speak in short conversational sentences." - ), - }, - ), - ], - graph_constraints=GraphConstraints( - min_incoming=0, - max_incoming=0, - min_outgoing=0, - max_outgoing=0, - ), -) diff --git a/api/services/workflow/node_specs/model_spec.py b/api/services/workflow/node_specs/model_spec.py new file mode 100644 index 0000000..1379ee1 --- /dev/null +++ b/api/services/workflow/node_specs/model_spec.py @@ -0,0 +1,404 @@ +from __future__ import annotations + +from dataclasses import dataclass +from dataclasses import field as dataclass_field +from enum import Enum +from types import NoneType +from typing import Any, Callable, Literal, get_args, get_origin + +from pydantic import BaseModel, Field +from pydantic.fields import FieldInfo, PydanticUndefined + +from api.services.workflow.node_specs._base import ( + DisplayOptions, + GraphConstraints, + NodeCategory, + NodeExample, + NodeSpec, + PropertyOption, + PropertySpec, + PropertyType, +) + +_SPEC_FIELD_META_KEY = "__dograh_spec_field__" +_UNSET = object() + + +@dataclass(frozen=True) +class NodeSpecMetadata: + name: str + display_name: str + description: str + category: NodeCategory + icon: str + llm_hint: str | None = None + version: str = "1.0.0" + examples: tuple[NodeExample, ...] = () + graph_constraints: GraphConstraints | None = None + property_order: tuple[str, ...] = () + field_overrides: dict[str, dict[str, Any]] = dataclass_field(default_factory=dict) + + +def spec_field( + *field_args: Any, + ui_type: PropertyType | str | None = None, + display_name: str | None = None, + llm_hint: str | None = None, + required: bool | None = None, + spec_default: Any = _UNSET, + placeholder: str | None = None, + display_options: DisplayOptions | None = None, + options: list[PropertyOption] | None = None, + editor: str | None = None, + extra: dict[str, Any] | None = None, + spec_exclude: bool = False, + min_value: float | None = None, + max_value: float | None = None, + min_length: int | None = None, + max_length: int | None = None, + pattern: str | None = None, + **field_kwargs: Any, +): + json_schema_extra = dict(field_kwargs.pop("json_schema_extra", {}) or {}) + json_schema_extra[_SPEC_FIELD_META_KEY] = { + "ui_type": ui_type.value if isinstance(ui_type, PropertyType) else ui_type, + "display_name": display_name, + "llm_hint": llm_hint, + "required": required, + "placeholder": placeholder, + "display_options": display_options, + "options": options, + "editor": editor, + "extra": extra or {}, + "spec_exclude": spec_exclude, + "min_value": min_value, + "max_value": max_value, + "min_length": min_length, + "max_length": max_length, + "pattern": pattern, + } + if spec_default is not _UNSET: + json_schema_extra[_SPEC_FIELD_META_KEY]["spec_default"] = spec_default + return Field(*field_args, json_schema_extra=json_schema_extra, **field_kwargs) + + +def node_spec( + *, + name: str, + display_name: str, + description: str, + category: NodeCategory, + icon: str, + llm_hint: str | None = None, + version: str = "1.0.0", + examples: list[NodeExample] | tuple[NodeExample, ...] = (), + graph_constraints: GraphConstraints | None = None, + property_order: list[str] | tuple[str, ...] = (), + field_overrides: dict[str, dict[str, Any]] | None = None, +) -> Callable[[type[BaseModel]], type[BaseModel]]: + metadata = NodeSpecMetadata( + name=name, + display_name=display_name, + description=description, + category=category, + icon=icon, + llm_hint=llm_hint, + version=version, + examples=tuple(examples), + graph_constraints=graph_constraints, + property_order=tuple(property_order), + field_overrides=field_overrides or {}, + ) + + def decorator(model_cls: type[BaseModel]) -> type[BaseModel]: + setattr(model_cls, "__node_spec_metadata__", metadata) + return model_cls + + return decorator + + +def build_spec(model_cls: type[BaseModel]) -> NodeSpec: + metadata: NodeSpecMetadata | None = getattr( + model_cls, "__node_spec_metadata__", None + ) + if metadata is None: + raise ValueError(f"{model_cls.__name__} is missing __node_spec_metadata__") + + properties: list[PropertySpec] = [] + for name, field in model_cls.model_fields.items(): + prop = _build_property_spec(model_cls, name, field) + if prop is not None: + properties.append(prop) + properties = _sort_properties(metadata.name, properties, metadata.property_order) + + return NodeSpec( + name=metadata.name, + display_name=metadata.display_name, + description=metadata.description, + llm_hint=metadata.llm_hint, + category=metadata.category, + icon=metadata.icon, + version=metadata.version, + properties=properties, + examples=list(metadata.examples), + graph_constraints=metadata.graph_constraints, + ) + + +def _sort_properties( + spec_name: str, + properties: list[PropertySpec], + property_order: tuple[str, ...], +) -> list[PropertySpec]: + if not property_order: + return properties + + property_names = {prop.name for prop in properties} + missing = [name for name in property_order if name not in property_names] + if missing: + raise ValueError( + f"{spec_name}: property_order references unknown properties: {missing}" + ) + + order_map = {name: idx for idx, name in enumerate(property_order)} + ordered = sorted( + enumerate(properties), + key=lambda item: (order_map.get(item[1].name, len(order_map)), item[0]), + ) + return [prop for _, prop in ordered] + + +def _build_property_spec( + owner_cls: type[BaseModel], + field_name: str, + field: FieldInfo, +) -> PropertySpec | None: + meta = _merged_field_meta(owner_cls, field_name, field) + if meta.get("spec_exclude"): + return None + + prop_type = _resolve_property_type(field.annotation, meta) + nested_properties = _resolve_nested_properties(field.annotation, prop_type) + options = _resolve_options(field.annotation, meta, prop_type) + min_value, max_value, min_length, max_length, pattern = _resolve_constraints( + field, meta + ) + + description = meta.get("description") or field.description + if not description: + raise ValueError(f"{owner_cls.__name__}.{field_name} is missing a description") + + return PropertySpec( + name=field_name, + type=prop_type, + display_name=meta.get("display_name") or _humanize_identifier(field_name), + description=description, + llm_hint=meta.get("llm_hint"), + default=_resolve_default(field, meta), + required=_resolve_required(field, meta), + placeholder=meta.get("placeholder"), + display_options=meta.get("display_options"), + options=options, + properties=nested_properties, + min_value=min_value, + max_value=max_value, + min_length=min_length, + max_length=max_length, + pattern=pattern, + editor=meta.get("editor"), + extra=meta.get("extra") or {}, + ) + + +def _merged_field_meta( + owner_cls: type[BaseModel], + field_name: str, + field: FieldInfo, +) -> dict[str, Any]: + field_meta = {} + if isinstance(field.json_schema_extra, dict): + field_meta = dict(field.json_schema_extra.get(_SPEC_FIELD_META_KEY, {}) or {}) + metadata: NodeSpecMetadata | None = getattr( + owner_cls, "__node_spec_metadata__", None + ) + override = ( + dict(metadata.field_overrides.get(field_name, {}) or {}) + if metadata is not None + else {} + ) + merged = dict(field_meta) + merged.update(override) + return merged + + +def _resolve_property_type(annotation: Any, meta: dict[str, Any]) -> PropertyType: + ui_type = meta.get("ui_type") + if ui_type: + return PropertyType(ui_type) + + inner = _strip_optional(annotation) + origin = get_origin(inner) + args = get_args(inner) + + if origin is list: + item_type = _strip_optional(args[0]) if args else Any + if isinstance(item_type, type) and issubclass(item_type, BaseModel): + return PropertyType.fixed_collection + raise ValueError( + "List-valued fields must declare an explicit ui_type unless they wrap a " + f"BaseModel row type (field annotation: {annotation!r})." + ) + + if _is_enum(inner) or _is_literal(inner): + return PropertyType.options + + if inner in (str,): + return PropertyType.string + if inner in (int, float): + return PropertyType.number + if inner is bool: + return PropertyType.boolean + if inner in (dict, Any) or origin is dict: + return PropertyType.json + + raise ValueError(f"Unable to derive PropertyType for annotation {annotation!r}") + + +def _resolve_nested_properties( + annotation: Any, + prop_type: PropertyType, +) -> list[PropertySpec] | None: + if prop_type != PropertyType.fixed_collection: + return None + + inner = _strip_optional(annotation) + args = get_args(inner) + if not args: + raise ValueError( + f"fixed_collection field annotation is missing row type: {annotation!r}" + ) + row_type = _strip_optional(args[0]) + if not isinstance(row_type, type) or not issubclass(row_type, BaseModel): + raise ValueError( + f"fixed_collection rows must be BaseModel subclasses: {annotation!r}" + ) + + properties: list[PropertySpec] = [] + for field_name, field in row_type.model_fields.items(): + prop = _build_property_spec(row_type, field_name, field) + if prop is not None: + properties.append(prop) + return properties + + +def _resolve_options( + annotation: Any, + meta: dict[str, Any], + prop_type: PropertyType, +) -> list[PropertyOption] | None: + if prop_type not in (PropertyType.options, PropertyType.multi_options): + return meta.get("options") + + if meta.get("options"): + return meta["options"] + + inner = _strip_optional(annotation) + if prop_type == PropertyType.multi_options: + inner = _strip_optional(get_args(inner)[0]) + + if _is_enum(inner): + return [ + PropertyOption( + value=member.value, label=_humanize_option_label(member.value) + ) + for member in inner + ] + if _is_literal(inner): + return [ + PropertyOption(value=value, label=_humanize_option_label(value)) + for value in get_args(inner) + if value is not None + ] + return None + + +def _resolve_constraints( + field: FieldInfo, + meta: dict[str, Any], +) -> tuple[float | None, float | None, int | None, int | None, str | None]: + min_value = meta.get("min_value") + max_value = meta.get("max_value") + min_length = meta.get("min_length") + max_length = meta.get("max_length") + pattern = meta.get("pattern") + + for item in field.metadata: + if min_value is None: + if hasattr(item, "ge") and item.ge is not None: + min_value = item.ge + elif hasattr(item, "gt") and item.gt is not None: + min_value = item.gt + if max_value is None: + if hasattr(item, "le") and item.le is not None: + max_value = item.le + elif hasattr(item, "lt") and item.lt is not None: + max_value = item.lt + if ( + min_length is None + and hasattr(item, "min_length") + and item.min_length is not None + ): + min_length = item.min_length + if ( + max_length is None + and hasattr(item, "max_length") + and item.max_length is not None + ): + max_length = item.max_length + if pattern is None and hasattr(item, "pattern") and item.pattern is not None: + pattern = item.pattern + + return min_value, max_value, min_length, max_length, pattern + + +def _resolve_default(field: FieldInfo, meta: dict[str, Any]) -> Any: + if "spec_default" in meta: + return meta["spec_default"] + if field.default is not PydanticUndefined: + return field.default + return None + + +def _resolve_required(field: FieldInfo, meta: dict[str, Any]) -> bool: + if meta.get("required") is not None: + return bool(meta["required"]) + return bool(field.is_required()) + + +def _strip_optional(annotation: Any) -> Any: + origin = get_origin(annotation) + if origin is None: + return annotation + + args = [arg for arg in get_args(annotation) if arg is not NoneType] + if len(args) == 1 and len(args) != len(get_args(annotation)): + return args[0] + return annotation + + +def _is_enum(annotation: Any) -> bool: + return isinstance(annotation, type) and issubclass(annotation, Enum) + + +def _is_literal(annotation: Any) -> bool: + return get_origin(annotation) is Literal + + +def _humanize_identifier(name: str) -> str: + return name.replace("_", " ").strip().title() + + +def _humanize_option_label(value: Any) -> str: + if isinstance(value, str): + return value.replace("_", " ").replace("-", " ").strip().title() + return str(value) diff --git a/api/services/workflow/node_specs/qa.py b/api/services/workflow/node_specs/qa.py deleted file mode 100644 index f140297..0000000 --- a/api/services/workflow/node_specs/qa.py +++ /dev/null @@ -1,203 +0,0 @@ -"""Spec for the QA Analysis node — runs an LLM quality review on the call -transcript after completion.""" - -from api.services.workflow.node_specs._base import ( - DisplayOptions, - GraphConstraints, - NodeCategory, - NodeExample, - NodeSpec, - PropertyOption, - PropertySpec, - PropertyType, -) - -DEFAULT_QA_SYSTEM_PROMPT = """You are a QA analyst evaluating a specific segment of a voice AI conversation. - -## Node Purpose -{{node_summary}} - -## Previous Conversation Context (For start of conversation, previous conversation summary can be empty.) -{{previous_conversation_summary}} - -## Tags to evaluate - -Examine the conversation carefully and identify which of the following tags apply: - -- UNCLEAR_CONVERSATION - The conversation is not coherent or clear, messages don't connect logically -- ASSISTANT_IN_LOOP - The assistant asks the same question multiple times or gets stuck repeating itself -- ASSISTANT_REPLY_IMPROPER - The assistant did not reply properly to the user's question/query or seems confused by what the user said -- USER_FRUSTRATED - The user seems angry, frustrated, or is complaining about something in the call -- USER_NOT_UNDERSTANDING - The user explicitly says they don't understand or repeatedly asks for clarification -- HEARING_ISSUES - Either party can't hear the other ("hello?", "are you there?", "can you hear me?") -- DEAD_AIR - Unusually long silences in the conversation (use the timestamps to judge) -- USER_REQUESTING_FEATURE - The user asks for something the assistant can't fulfill -- ASSISTANT_LACKS_EMPATHY - The assistant ignores the user's personal situation or emotional state and continues pitching or pushing the agenda. -- USER_DETECTS_AI - The user suspects or identifies that they are talking to an AI/robot/bot rather than a real human. - -## Call metrics (pre-computed) - -Use these alongside the transcript for your analysis: -{{metrics}} - -## Output format - -Return ONLY a valid JSON object (no markdown): -{ - "tags": [ - { - "tag": "TAG_NAME", - "reason": "Short reason with evidence from the transcript" - } - ], - "overall_sentiment": "positive|neutral|negative", - "call_quality_score": <1-10>, - "summary": "1-2 sentence summary of this segment" -} - -If no tags apply, return an empty tags list. Always provide sentiment, score, and summary.""" - - -SPEC = NodeSpec( - name="qa", - display_name="QA Analysis", - description="Run LLM quality analysis on the call transcript.", - llm_hint=( - "Runs an LLM quality review on the call transcript after completion. " - "Per-node analysis splits the conversation by node and evaluates each " - "segment against the configured system prompt. Sampling, minimum " - "duration, and voicemail filters are supported." - ), - category=NodeCategory.integration, - icon="ClipboardCheck", - properties=[ - PropertySpec( - name="name", - type=PropertyType.string, - display_name="Name", - description="Short identifier for this QA configuration.", - required=True, - min_length=1, - default="QA Analysis", - ), - PropertySpec( - name="qa_enabled", - type=PropertyType.boolean, - display_name="Enabled", - description="When false, the QA run is skipped.", - default=True, - ), - PropertySpec( - name="qa_system_prompt", - type=PropertyType.string, - display_name="System Prompt", - description=( - "Instructions to the QA reviewer LLM. Supports placeholders: " - "`{node_summary}`, `{previous_conversation_summary}`, " - "`{transcript}`, `{metrics}`." - ), - editor="textarea", - default=DEFAULT_QA_SYSTEM_PROMPT, - ), - PropertySpec( - name="qa_min_call_duration", - type=PropertyType.number, - display_name="Minimum Call Duration (seconds)", - description="Calls shorter than this are skipped.", - default=15, - min_value=0, - ), - PropertySpec( - name="qa_voicemail_calls", - type=PropertyType.boolean, - display_name="Include Voicemail Calls", - description="When false, calls flagged as voicemail are skipped.", - default=False, - ), - PropertySpec( - name="qa_sample_rate", - type=PropertyType.number, - display_name="Sample Rate (%)", - description=( - "Percent of eligible calls QA'd. 100 means every call; lower " - "values use random sampling." - ), - default=100, - min_value=1, - max_value=100, - ), - # ---- LLM configuration ---- - PropertySpec( - name="qa_use_workflow_llm", - type=PropertyType.boolean, - display_name="Use Workflow's LLM", - description=( - "When true, the QA pass uses the same LLM the workflow runs " - "with. Set false to specify a separate provider/model." - ), - default=True, - ), - PropertySpec( - name="qa_provider", - type=PropertyType.options, - display_name="QA LLM Provider", - description="LLM provider used for the QA pass.", - display_options=DisplayOptions(show={"qa_use_workflow_llm": [False]}), - options=[ - PropertyOption(value="openai", label="OpenAI"), - PropertyOption(value="azure", label="Azure OpenAI"), - PropertyOption(value="openrouter", label="OpenRouter"), - PropertyOption(value="anthropic", label="Anthropic"), - ], - ), - PropertySpec( - name="qa_model", - type=PropertyType.string, - display_name="QA Model", - description=( - "Model identifier (e.g., 'gpt-4o', 'claude-sonnet-4-6'). " - "Provider-specific." - ), - display_options=DisplayOptions(show={"qa_use_workflow_llm": [False]}), - default="default", - ), - PropertySpec( - name="qa_api_key", - type=PropertyType.string, - display_name="API Key", - description="API key for the chosen provider.", - display_options=DisplayOptions(show={"qa_use_workflow_llm": [False]}), - ), - PropertySpec( - name="qa_endpoint", - type=PropertyType.url, - display_name="Azure Endpoint", - description="Required for the Azure provider.", - display_options=DisplayOptions( - show={"qa_use_workflow_llm": [False], "qa_provider": ["azure"]} - ), - ), - ], - examples=[ - NodeExample( - name="basic_qa", - data={ - "name": "Compliance Check", - "qa_enabled": True, - "qa_system_prompt": ( - "You are a compliance reviewer. Review the transcript and " - "produce a JSON object with `tags`, `summary`, " - "`call_quality_score`, and `overall_sentiment`." - ), - "qa_min_call_duration": 30, - "qa_sample_rate": 100, - }, - ), - ], - # QA runs post-call against the saved transcript (run_integrations - # scans by type), never as a graph step. Reject any edge into or out - # of a QA node. - graph_constraints=GraphConstraints( - min_incoming=0, max_incoming=0, min_outgoing=0, max_outgoing=0 - ), -) diff --git a/api/services/workflow/node_specs/start_call.py b/api/services/workflow/node_specs/start_call.py deleted file mode 100644 index 07cd870..0000000 --- a/api/services/workflow/node_specs/start_call.py +++ /dev/null @@ -1,250 +0,0 @@ -"""Spec for the Start Call node — the single entry point of every workflow. -Carries greeting, pre-call data fetch, and the same prompt/extraction/tools -fields as agent nodes.""" - -from api.services.workflow.node_specs._base import ( - DisplayOptions, - GraphConstraints, - NodeCategory, - NodeExample, - NodeSpec, - PropertyOption, - PropertySpec, - PropertyType, -) - -SPEC = NodeSpec( - name="startCall", - display_name="Start Call", - description="Entry point of the workflow — plays a greeting and opens the conversation.", - llm_hint=( - "The entry point of every workflow (exactly one required). Plays an " - "optional greeting, can fetch context from an external API before " - "the call begins, and executes the first conversational turn." - ), - category=NodeCategory.call_node, - icon="Play", - properties=[ - PropertySpec( - name="name", - type=PropertyType.string, - display_name="Name", - description="Short identifier shown in the canvas and call logs.", - required=True, - min_length=1, - default="Start Call", - ), - # ---- Greeting (variant via greeting_type) ---- - PropertySpec( - name="greeting_type", - type=PropertyType.options, - display_name="Greeting Type", - description=( - "Whether the optional greeting is spoken via TTS from text " - "or played from a pre-recorded audio file." - ), - default="text", - options=[ - PropertyOption(value="text", label="Text (TTS)"), - PropertyOption(value="audio", label="Pre-recorded Audio"), - ], - ), - PropertySpec( - name="greeting", - type=PropertyType.string, - display_name="Greeting Text", - description=( - "Text spoken via TTS at the start of the call. Supports " - "{{template_variables}}. Leave empty to skip the greeting." - ), - display_options=DisplayOptions(show={"greeting_type": ["text"]}), - editor="textarea", - placeholder="Hi {{first_name}}, this is Sarah from Acme.", - ), - PropertySpec( - name="greeting_recording_id", - type=PropertyType.recording_ref, - display_name="Greeting Recording", - description="Pre-recorded audio file played at the start of the call.", - llm_hint=( - "Value is the `recording_id` string. Use the `list_recordings` " - "MCP tool to discover available recordings." - ), - display_options=DisplayOptions(show={"greeting_type": ["audio"]}), - ), - PropertySpec( - name="prompt", - type=PropertyType.mention_textarea, - display_name="Prompt", - description=( - "Agent system prompt for the opening turn. Supports " - "{{template_variables}} from pre-call fetch and the initial context." - ), - required=True, - min_length=1, - placeholder="Greet the caller warmly and ask how you can help today.", - ), - # ---- Behavior toggles ---- - PropertySpec( - name="allow_interrupt", - type=PropertyType.boolean, - display_name="Allow Interruption", - description=("When true, the user can interrupt the agent mid-utterance."), - default=False, - ), - PropertySpec( - name="add_global_prompt", - type=PropertyType.boolean, - display_name="Add Global Prompt", - description=( - "When true and a Global node exists, prepends the global " - "prompt to this node's prompt at runtime." - ), - default=True, - ), - PropertySpec( - name="delayed_start", - type=PropertyType.boolean, - display_name="Delayed Start", - description=( - "When true, the agent waits before speaking after pickup. " - "Useful for outbound calls where the called party needs a " - "moment to settle." - ), - default=False, - ), - PropertySpec( - name="delayed_start_duration", - type=PropertyType.number, - display_name="Delay Duration (seconds)", - description="Seconds to wait before the agent speaks. 0.1–10.", - default=2.0, - min_value=0.1, - max_value=10.0, - display_options=DisplayOptions(show={"delayed_start": [True]}), - ), - # ---- Variable extraction ---- - PropertySpec( - name="extraction_enabled", - type=PropertyType.boolean, - display_name="Enable Variable Extraction", - description=( - "When true, runs an LLM extraction pass on transition out of " - "this node to capture variables from the opening turn." - ), - default=False, - ), - PropertySpec( - name="extraction_prompt", - type=PropertyType.string, - display_name="Extraction Prompt", - description="Overall instructions guiding variable extraction.", - display_options=DisplayOptions(show={"extraction_enabled": [True]}), - editor="textarea", - ), - PropertySpec( - name="extraction_variables", - type=PropertyType.fixed_collection, - display_name="Variables to Extract", - description=( - "Each entry declares one variable to capture, with its name, " - "data type, and per-variable extraction hint." - ), - display_options=DisplayOptions(show={"extraction_enabled": [True]}), - properties=[ - PropertySpec( - name="name", - type=PropertyType.string, - display_name="Variable Name", - description="snake_case identifier used downstream.", - required=True, - ), - PropertySpec( - name="type", - type=PropertyType.options, - display_name="Type", - description="Data type of the extracted value.", - required=True, - default="string", - options=[ - PropertyOption(value="string", label="String"), - PropertyOption(value="number", label="Number"), - PropertyOption(value="boolean", label="Boolean"), - ], - ), - PropertySpec( - name="prompt", - type=PropertyType.string, - display_name="Extraction Hint", - description="Per-variable hint describing what to look for.", - editor="textarea", - ), - ], - ), - # ---- Tools / documents ---- - PropertySpec( - name="tool_uuids", - type=PropertyType.tool_refs, - display_name="Tools", - description="Tools the agent can invoke during the opening turn.", - llm_hint="List of tool UUIDs from `list_tools`.", - ), - PropertySpec( - name="document_uuids", - type=PropertyType.document_refs, - display_name="Knowledge Base Documents", - description="Documents the agent can reference.", - llm_hint="List of document UUIDs from `list_documents`.", - ), - # ---- Pre-call data fetch (advanced) ---- - PropertySpec( - name="pre_call_fetch_enabled", - type=PropertyType.boolean, - display_name="Pre-Call Data Fetch", - description=( - "When true, makes a POST request to an external API before " - "the call starts and merges the JSON response into the call " - "context as template variables." - ), - default=False, - ), - PropertySpec( - name="pre_call_fetch_url", - type=PropertyType.url, - display_name="Endpoint URL", - description=( - "URL the pre-call POST request is sent to. The request body " - "includes caller and called numbers." - ), - display_options=DisplayOptions(show={"pre_call_fetch_enabled": [True]}), - placeholder="https://api.example.com/customer-lookup", - ), - PropertySpec( - name="pre_call_fetch_credential_uuid", - type=PropertyType.credential_ref, - display_name="Authentication", - description="Optional credential attached to the pre-call request.", - llm_hint="Credential UUID from `list_credentials`.", - display_options=DisplayOptions(show={"pre_call_fetch_enabled": [True]}), - ), - ], - examples=[ - NodeExample( - name="warm_greeting", - data={ - "name": "Greeting", - "prompt": "Greet warmly and ask the caller's reason for calling.", - "greeting_type": "text", - "greeting": "Hi {{first_name}}, this is Sarah from Acme.", - "allow_interrupt": True, - }, - ), - ], - # `min_outgoing` is intentionally unset: a startCall is allowed to - # sit on the canvas without an outgoing edge (e.g. a workflow with - # just a greeting). Only constraint: nothing flows INTO the start. - graph_constraints=GraphConstraints( - min_incoming=0, - max_incoming=0, - ), -) diff --git a/api/services/workflow/node_specs/trigger.py b/api/services/workflow/node_specs/trigger.py deleted file mode 100644 index 5d9883d..0000000 --- a/api/services/workflow/node_specs/trigger.py +++ /dev/null @@ -1,79 +0,0 @@ -"""Spec for the API Trigger node — exposes a public webhook URL that -external systems can hit to launch the workflow.""" - -from api.services.workflow.node_specs._base import ( - GraphConstraints, - NodeCategory, - NodeExample, - NodeSpec, - PropertySpec, - PropertyType, -) - -SPEC = NodeSpec( - name="trigger", - display_name="API Trigger", - description=("Public HTTP endpoints that launch the workflow."), - llm_hint=( - "Exposes two public HTTP POST endpoints derived from the auto-generated " - "`trigger_path`:\n" - " • Production: `/api/v1/public/agent/` — runs " - "the published agent. Use this from production systems.\n" - " • Test: `/api/v1/public/agent/test/` — runs " - "the latest draft, useful for verifying changes before publishing. " - "Falls back to the published agent when no draft exists.\n" - "Both require an API key in the `X-API-Key` header.\n" - "Request body fields:\n" - " • `phone_number` (string, required) — destination to dial.\n" - " • `initial_context` (object, optional) — merged into the run's " - "initial context.\n" - " • `telephony_configuration_id` (int, optional) — pick a specific " - "telephony configuration for the call. Must belong to the same " - "organization as the trigger. When omitted, the org's default " - "outbound configuration is used." - ), - category=NodeCategory.trigger, - icon="Webhook", - properties=[ - PropertySpec( - name="name", - type=PropertyType.string, - display_name="Name", - description="Short identifier shown in the canvas. No runtime effect.", - required=True, - min_length=1, - default="API Trigger", - ), - PropertySpec( - name="enabled", - type=PropertyType.boolean, - display_name="Enabled", - description="When false, the trigger URL returns 404.", - default=True, - ), - PropertySpec( - name="trigger_path", - type=PropertyType.string, - display_name="Trigger Path", - description=( - "Auto-generated UUID-style path segment that uniquely " - "identifies this trigger. Used in both URLs:\n" - " • Production: `/api/v1/public/agent/` — " - "executes the published agent.\n" - " • Test: `/api/v1/public/agent/test/` — " - "executes the latest draft.\n" - "Do not edit manually." - ), - ), - ], - examples=[ - NodeExample( - name="default", - data={"name": "Inbound Trigger", "enabled": True}, - ), - ], - graph_constraints=GraphConstraints( - min_incoming=0, - max_incoming=0, - ), -) diff --git a/api/services/workflow/node_specs/webhook.py b/api/services/workflow/node_specs/webhook.py deleted file mode 100644 index 37d17f6..0000000 --- a/api/services/workflow/node_specs/webhook.py +++ /dev/null @@ -1,133 +0,0 @@ -"""Spec for the Webhook node — sends an HTTP request to an external system -after the workflow completes.""" - -from api.services.workflow.node_specs._base import ( - GraphConstraints, - NodeCategory, - NodeExample, - NodeSpec, - PropertyOption, - PropertySpec, - PropertyType, -) - -SPEC = NodeSpec( - name="webhook", - display_name="Webhook", - description="Send HTTP request after the workflow completes.", - llm_hint=( - "Sends an HTTP request to an external system after the workflow " - "completes. The payload is a Jinja-templated JSON body with access " - "to `workflow_run_id`, `initial_context`, `gathered_context`, " - "`annotations`, and call metadata." - ), - category=NodeCategory.integration, - icon="Link2", - properties=[ - PropertySpec( - name="name", - type=PropertyType.string, - display_name="Name", - description="Short identifier shown in the canvas and run logs.", - required=True, - min_length=1, - default="Webhook", - ), - PropertySpec( - name="enabled", - type=PropertyType.boolean, - display_name="Enabled", - description="When false, the webhook is skipped at run time.", - default=True, - ), - PropertySpec( - name="http_method", - type=PropertyType.options, - display_name="HTTP Method", - description="HTTP verb used for the outbound request.", - default="POST", - options=[ - PropertyOption(value="GET", label="GET"), - PropertyOption(value="POST", label="POST"), - PropertyOption(value="PUT", label="PUT"), - PropertyOption(value="PATCH", label="PATCH"), - PropertyOption(value="DELETE", label="DELETE"), - ], - ), - PropertySpec( - name="endpoint_url", - type=PropertyType.url, - display_name="Endpoint URL", - description="URL the request is sent to.", - placeholder="https://api.example.com/webhook", - ), - PropertySpec( - name="credential_uuid", - type=PropertyType.credential_ref, - display_name="Authentication", - description="Optional credential applied as the Authorization header.", - llm_hint="Credential UUID from `list_credentials`.", - ), - PropertySpec( - name="custom_headers", - type=PropertyType.fixed_collection, - display_name="Custom Headers", - description="Additional HTTP headers to include with the request.", - properties=[ - PropertySpec( - name="key", - type=PropertyType.string, - display_name="Header Name", - description="HTTP header name (e.g., 'X-Source').", - required=True, - ), - PropertySpec( - name="value", - type=PropertyType.string, - display_name="Header Value", - description="Header value (supports {{template_variables}}).", - required=True, - ), - ], - ), - PropertySpec( - name="payload_template", - type=PropertyType.json, - display_name="Payload Template", - description=( - "JSON body of the request. Values are Jinja-rendered against " - "the run context — `{{workflow_run_id}}`, " - "`{{gathered_context.foo}}`, `{{annotations.qa_xxx}}`, etc." - ), - default={ - "call_id": "{{workflow_run_id}}", - "first_name": "{{initial_context.first_name}}", - "rsvp": "{{gathered_context.rsvp}}", - "duration": "{{cost_info.call_duration_seconds}}", - "recording_url": "{{recording_url}}", - "transcript_url": "{{transcript_url}}", - }, - ), - ], - examples=[ - NodeExample( - name="post_to_crm", - data={ - "name": "Notify CRM", - "enabled": True, - "http_method": "POST", - "endpoint_url": "https://crm.example.com/calls", - "payload_template": { - "run_id": "{{workflow_run_id}}", - "outcome": "{{gathered_context.call_disposition}}", - }, - }, - ), - ], - # Webhooks fire post-call (run_integrations scans nodes by type), - # never as a graph step. Reject any edge into or out of a webhook so - # the editor can't wire one into the conversation flow. - graph_constraints=GraphConstraints( - min_incoming=0, max_incoming=0, min_outgoing=0, max_outgoing=0 - ), -) diff --git a/api/services/workflow/pipecat_engine.py b/api/services/workflow/pipecat_engine.py index eea729d..8a41481 100644 --- a/api/services/workflow/pipecat_engine.py +++ b/api/services/workflow/pipecat_engine.py @@ -1,4 +1,5 @@ from typing import TYPE_CHECKING, Awaitable, Callable, Literal, Optional, Union +from typing import TYPE_CHECKING, Awaitable, Callable, Dict, Optional, Union from pipecat.adapters.schemas.tools_schema import ToolsSchema from pipecat.frames.frames import ( @@ -17,6 +18,7 @@ from pipecat.services.settings import LLMSettings from pipecat.utils.enums import EndTaskReason from api.db import db_client +from api.enums import ToolCategory from api.services.pipecat.audio_playback import play_audio from api.services.workflow.disposition_mapper import apply_disposition_mapping from api.services.workflow.workflow_graph import Node, WorkflowGraph @@ -35,6 +37,7 @@ import asyncio from loguru import logger from api.services.workflow import pipecat_engine_callbacks as engine_callbacks +from api.services.workflow.mcp_tool_session import McpToolSession from api.services.workflow.pipecat_engine_context_composer import ( compose_functions_for_node, compose_system_prompt_for_node, @@ -117,6 +120,9 @@ class PipecatEngine: # Cached organization ID (resolved lazily from workflow run) self._organization_id: Optional[int] = None + # Open MCP tool sessions for this call, keyed by tool_uuid + self._mcp_sessions: Dict[str, McpToolSession] = {} + # Embeddings configuration (passed from run_pipeline.py) self._embeddings_api_key: Optional[str] = embeddings_api_key self._embeddings_model: Optional[str] = embeddings_model @@ -179,6 +185,9 @@ class PipecatEngine: # Helper that encapsulates custom tool management self._custom_tool_manager = CustomToolManager(self) + # Open persistent MCP server sessions for this call (degrades on failure) + await self._open_mcp_sessions() + # Helper that encapsulates context summarization if self._context_compaction_enabled: self._context_summarization_manager = ContextSummarizationManager(self) @@ -504,7 +513,10 @@ class PipecatEngine: # Register custom tool handlers for this node if node.tool_uuids and self._custom_tool_manager: - await self._custom_tool_manager.register_handlers(node.tool_uuids) + await self._custom_tool_manager.register_handlers( + node.tool_uuids, + mcp_tool_filters=getattr(node, "mcp_tool_filters", None), + ) # Register knowledge base retrieval handler if node has documents if node.document_uuids: @@ -530,7 +542,7 @@ class PipecatEngine: node = self.workflow.nodes[node_id] logger.debug( - f"Executing node: name: {node.name} is_static: {node.is_static} allow_interrupt: {node.allow_interrupt} is_end: {node.is_end}" + f"Executing node: name: {node.name} allow_interrupt: {node.allow_interrupt} is_end: {node.is_end}" ) # Track previous node for transition event @@ -585,11 +597,8 @@ class PipecatEngine: ) await asyncio.sleep(delay_duration) - if node.is_static: - raise ValueError("Static nodes are not supported!") - else: - # Setup LLM Context with Prompts and Functions - await self._setup_llm_context(node) + # Setup LLM context with prompts and functions. + await self._setup_llm_context(node) def get_node_greeting(self, node_id: str) -> Optional[tuple[str, Optional[str]]]: """Return the greeting info for a node, or None if not configured. @@ -685,19 +694,13 @@ class PipecatEngine: async def _handle_end_node(self, node: Node) -> None: """Handle end node execution.""" - if node.is_static: - raise ValueError("Static nodes are not supported!") - else: - # Setup LLM Context with Prompts and Functions - await self._setup_llm_context(node) + # Setup LLM context with prompts and functions. + await self._setup_llm_context(node) async def _handle_agent_node(self, node: Node) -> None: """Handle agent node execution.""" - if node.is_static: - raise ValueError("Static nodes are not supported!") - else: - # Setup LLM Context with Prompts and Functions - await self._setup_llm_context(node) + # Setup LLM context with prompts and functions. + await self._setup_llm_context(node) async def end_call_with_reason( self, @@ -884,6 +887,79 @@ class PipecatEngine: """Get the gathered context including extracted variables.""" return self._gathered_context.copy() + async def _open_mcp_sessions(self) -> None: + """Connect every MCP-category tool referenced by any workflow node. + Failures degrade (session marked unavailable); never raises.""" + from api.services.workflow.tools.mcp_tool import ( + McpDefinitionError, + validate_mcp_definition, + ) + + try: + tool_uuids: set[str] = set() + for node in self.workflow.nodes.values(): + for tu in getattr(node, "tool_uuids", None) or []: + tool_uuids.add(tu) + if not tool_uuids: + return + + organization_id = await self._get_organization_id() + if not organization_id: + logger.warning("Cannot open MCP sessions: organization_id missing") + return + + tools = await db_client.get_tools_by_uuids( + list(tool_uuids), organization_id + ) + for tool in tools: + if tool.category != ToolCategory.MCP.value: + continue + try: + cfg = validate_mcp_definition(tool.definition) + except McpDefinitionError as e: + logger.warning( + f"Skipping MCP tool '{tool.name}' ({tool.tool_uuid}): " + f"invalid definition: {e}" + ) + continue + + credential = None + if cfg["credential_uuid"]: + try: + credential = await db_client.get_credential_by_uuid( + cfg["credential_uuid"], organization_id + ) + except Exception as e: + logger.warning( + f"MCP tool '{tool.name}': credential fetch failed: {e}" + ) + continue + + session = McpToolSession( + tool_uuid=tool.tool_uuid, + tool_name=tool.name, + url=cfg["url"], + credential=credential, + tools_filter=cfg["tools_filter"], + timeout_secs=cfg["timeout_secs"], + sse_read_timeout_secs=cfg["sse_read_timeout_secs"], + ) + await session.start() + self._mcp_sessions[tool.tool_uuid] = session + except Exception as e: + logger.warning( + f"Failed to open MCP sessions; call proceeds without MCP tools: {e}", + exc_info=True, + ) + + async def _close_mcp_sessions(self) -> None: + for tool_uuid, session in list(self._mcp_sessions.items()): + try: + await session.close() + except Exception as e: + logger.warning(f"Error closing MCP session {tool_uuid}: {e}") + self._mcp_sessions = {} + async def cleanup(self): """Clean up engine resources on disconnect.""" # Cancel any pending timeout tasks @@ -893,6 +969,12 @@ class PipecatEngine: ): self._user_response_timeout_task.cancel() - # Cancel any in-flight background summarization - if self._context_summarization_manager: - await self._context_summarization_manager.cleanup() + # Cancel any in-flight background summarization. + # MCP sessions are closed in a finally block so they are guaranteed to + # run even if the summarization cleanup raises an exception. + try: + if self._context_summarization_manager: + await self._context_summarization_manager.cleanup() + finally: + # Close any open MCP tool sessions + await self._close_mcp_sessions() diff --git a/api/services/workflow/pipecat_engine_context_composer.py b/api/services/workflow/pipecat_engine_context_composer.py index 03c253a..41b62c0 100644 --- a/api/services/workflow/pipecat_engine_context_composer.py +++ b/api/services/workflow/pipecat_engine_context_composer.py @@ -117,7 +117,8 @@ async def compose_functions_for_node( # Custom tools if node.tool_uuids and custom_tool_manager: custom_tool_schemas = await custom_tool_manager.get_tool_schemas( - node.tool_uuids + node.tool_uuids, + mcp_tool_filters=getattr(node, "mcp_tool_filters", None), ) functions.extend(custom_tool_schemas) diff --git a/api/services/workflow/pipecat_engine_custom_tools.py b/api/services/workflow/pipecat_engine_custom_tools.py index d19f163..3d070b7 100644 --- a/api/services/workflow/pipecat_engine_custom_tools.py +++ b/api/services/workflow/pipecat_engine_custom_tools.py @@ -34,6 +34,7 @@ from api.services.workflow.tools.custom_tool import ( ) if TYPE_CHECKING: + from api.services.workflow.mcp_tool_session import McpToolSession from api.services.workflow.pipecat_engine import PipecatEngine @@ -121,11 +122,18 @@ class CustomToolManager: """Get the organization ID from the engine (shared cache).""" return await self._engine._get_organization_id() - async def get_tool_schemas(self, tool_uuids: list[str]) -> list[FunctionSchema]: + async def get_tool_schemas( + self, + tool_uuids: list[str], + mcp_tool_filters: Optional[dict[str, list[str]]] = None, + ) -> list[FunctionSchema]: """Fetch custom tools and convert them to function schemas. Args: tool_uuids: List of tool UUIDs to fetch + mcp_tool_filters: Optional per-node filter mapping tool_uuid → list of + raw MCP tool names to expose. None (default) exposes all tools. + Empty dict or entry with [] suppresses all tools for that uuid. Returns: List of FunctionSchema objects for LLM @@ -154,6 +162,22 @@ class CustomToolManager: ) continue + if tool.category == ToolCategory.MCP.value: + session = self._engine._mcp_sessions.get(tool.tool_uuid) + if session is None or not session.available: + logger.warning( + f"MCP tool '{tool.name}' ({tool.tool_uuid}) " + f"unavailable; skipping" + ) + continue + allowed = ( + None + if mcp_tool_filters is None + else set(mcp_tool_filters.get(tool.tool_uuid, [])) + ) + schemas.extend(session.function_schemas(allowed)) + continue + raw_schema = tool_to_function_schema(tool) function_name = raw_schema["function"]["name"] @@ -178,11 +202,18 @@ class CustomToolManager: logger.error(f"Failed to fetch custom tools: {e}") return [] - async def register_handlers(self, tool_uuids: list[str]) -> None: + async def register_handlers( + self, + tool_uuids: list[str], + mcp_tool_filters: Optional[dict[str, list[str]]] = None, + ) -> None: """Register custom tool execution handlers with the LLM. Args: tool_uuids: List of tool UUIDs to register handlers for + mcp_tool_filters: Optional per-node filter mapping tool_uuid → list of + raw MCP tool names to expose. None (default) exposes all tools. + Empty dict or entry with [] suppresses all tools for that uuid. """ organization_id = await self.get_organization_id() if not organization_id: @@ -203,6 +234,32 @@ class CustomToolManager: ) continue + if tool.category == ToolCategory.MCP.value: + session = self._engine._mcp_sessions.get(tool.tool_uuid) + if session is None or not session.available: + logger.warning( + f"MCP tool '{tool.name}' ({tool.tool_uuid}) " + f"unavailable; skipping handler registration" + ) + continue + allowed = ( + None + if mcp_tool_filters is None + else set(mcp_tool_filters.get(tool.tool_uuid, [])) + ) + mcp_schemas = session.function_schemas(allowed) + for fs in mcp_schemas: + self._engine.llm.register_function( + fs.name, + self._create_mcp_handler(session, fs.name), + timeout_secs=session.call_timeout_secs, + ) + logger.debug( + f"Registered {len(mcp_schemas)} MCP " + f"handlers for tool '{tool.name}' ({tool.tool_uuid})" + ) + continue + schema = tool_to_function_schema(tool) function_name = schema["function"]["name"] @@ -335,6 +392,29 @@ class CustomToolManager: return http_tool_handler + def _create_mcp_handler(self, session: "McpToolSession", function_name: str): + """Create a handler that proxies an LLM function call to a live MCP + session. Errors are returned to the LLM as structured text so the + agent can recover verbally; the call is never crashed.""" + + async def mcp_tool_handler( + function_call_params: FunctionCallParams, + ) -> None: + logger.info(f"MCP Tool EXECUTED: {function_name}") + logger.info(f"Arguments: {function_call_params.arguments}") + try: + result = await session.call( + function_name, function_call_params.arguments or {} + ) + await function_call_params.result_callback(result) + except Exception as e: + logger.error(f"MCP tool '{function_name}' failed: {e}") + await function_call_params.result_callback( + {"status": "error", "error": str(e)} + ) + + return mcp_tool_handler + def _create_end_call_handler(self, tool: Any, function_name: str): """Create a handler function for an end call tool. diff --git a/api/services/workflow/tools/mcp_tool.py b/api/services/workflow/tools/mcp_tool.py new file mode 100644 index 0000000..26dac2a --- /dev/null +++ b/api/services/workflow/tools/mcp_tool.py @@ -0,0 +1,116 @@ +"""Pure helpers for MCP-category tools: definition validation and +LLM-function-name namespacing. No I/O, no MCP protocol here.""" + +from __future__ import annotations + +import re +from typing import Any, Dict, Literal, Optional + +from pydantic import BaseModel, Field, ValidationError, field_validator + +DEFAULT_TIMEOUT_SECS = 30 +DEFAULT_SSE_READ_TIMEOUT_SECS = 300 + + +class McpDefinitionError(ValueError): + """Raised when an MCP tool definition is structurally invalid.""" + + +class McpToolConfig(BaseModel): + """Configuration for an MCP tool definition.""" + + transport: Literal["streamable_http"] = Field( + default="streamable_http", description="MCP transport protocol" + ) + url: str = Field(description="MCP server URL (must be http:// or https://)") + credential_uuid: Optional[str] = Field( + default=None, description="Reference to ExternalCredentialModel for auth" + ) + tools_filter: list[str] = Field( + default_factory=list, + description="Allowlist of MCP tool names to expose (empty = all tools)", + ) + timeout_secs: int = Field( + default=DEFAULT_TIMEOUT_SECS, description="Connection timeout in seconds" + ) + sse_read_timeout_secs: int = Field( + default=DEFAULT_SSE_READ_TIMEOUT_SECS, + description="SSE read timeout in seconds", + ) + discovered_tools: list[dict[str, Any]] = Field( + default_factory=list, + description=( + "Server-managed cache of the MCP server's tool catalog " + "[{name, description}]. Populated best-effort by the backend." + ), + ) + + @field_validator("url") + @classmethod + def validate_url(cls, v: str) -> str: + if not isinstance(v, str) or not v.startswith(("http://", "https://")): + raise ValueError("config.url must be an http(s) URL") + return v + + @field_validator("tools_filter") + @classmethod + def validate_tools_filter(cls, v: list[str]) -> list[str]: + if not all(isinstance(tool_name, str) for tool_name in v): + raise ValueError("config.tools_filter must be a list of strings") + return v + + +class McpToolDefinition(BaseModel): + """Persisted MCP tool definition.""" + + schema_version: int = Field(default=1, description="Schema version") + type: Literal["mcp"] = Field(description="Tool type") + config: McpToolConfig = Field(description="MCP server configuration") + + +def _format_validation_error(error: ValidationError) -> str: + parts: list[str] = [] + for item in error.errors(): + location = ".".join(str(part) for part in item["loc"]) + parts.append(f"{location}: {item['msg']}") + return "; ".join(parts) + + +def validate_mcp_definition(definition: Dict[str, Any]) -> Dict[str, Any]: + """Validate a ``type: "mcp"`` ToolModel definition and return a + normalized config dict with defaults applied. + + Raises: + McpDefinitionError: if the definition is missing required fields + or uses an unsupported transport. + """ + if not isinstance(definition, dict) or definition.get("type") != "mcp": + raise McpDefinitionError("definition.type must be 'mcp'") + + config = definition.get("config") + if not isinstance(config, dict): + raise McpDefinitionError("definition.config is required and must be an object") + + try: + parsed = McpToolDefinition.model_validate(definition) + except ValidationError as e: + raise McpDefinitionError(_format_validation_error(e)) from e + + return parsed.config.model_dump(exclude={"discovered_tools"}) + + +def _slugify(value: str) -> str: + slug = re.sub(r"[^a-z0-9]+", "_", value.strip().lower()).strip("_") + return slug + + +def namespace_function_name( + tool_name: str, mcp_tool_name: str, *, fallback: str = "server" +) -> str: + """Build a collision-safe LLM function name: ``mcp____``. + + ``slug`` is derived from the Dograh ToolModel name; if it slugifies to + empty, ``fallback`` (e.g. first 8 chars of tool_uuid) is used instead. + """ + slug = _slugify(tool_name) or _slugify(fallback) or "server" + return f"mcp__{slug}__{mcp_tool_name}" diff --git a/api/services/workflow/workflow_graph.py b/api/services/workflow/workflow_graph.py index fc2be79..a626815 100644 --- a/api/services/workflow/workflow_graph.py +++ b/api/services/workflow/workflow_graph.py @@ -4,7 +4,8 @@ from typing import Dict, List, Set from api.services.workflow.dto import EdgeDataDTO, NodeType, ReactFlowDTO from api.services.workflow.errors import ItemKind, WorkflowError -from api.services.workflow.node_specs import REGISTRY +from api.services.workflow.node_data import BaseNodeData +from api.services.workflow.node_specs import get_spec # Regex for matching {{ variable }} template placeholders. # Captures: group(1) = variable path, group(2) = filter name, group(3) = filter value. @@ -62,7 +63,7 @@ class Edge: class Node: - def __init__(self, id: str, node_type: NodeType, data): + def __init__(self, id: str, node_type: str, data: BaseNodeData): self.id, self.node_type, self.data = id, node_type, data self.out: Dict[str, "Node"] = {} # forward nodes self.out_edges: List[Edge] = [] # forward edges with properties @@ -75,7 +76,6 @@ class Node: # Type-specific fields — read with getattr so this works for every # node variant in the discriminated union. self.prompt = getattr(data, "prompt", None) - self.is_static = getattr(data, "is_static", False) self.allow_interrupt = getattr(data, "allow_interrupt", False) self.extraction_enabled = getattr(data, "extraction_enabled", False) self.extraction_prompt = getattr(data, "extraction_prompt", None) @@ -84,11 +84,11 @@ class Node: self.greeting = getattr(data, "greeting", None) self.greeting_type = getattr(data, "greeting_type", None) self.greeting_recording_id = getattr(data, "greeting_recording_id", None) - self.detect_voicemail = getattr(data, "detect_voicemail", False) self.delayed_start = getattr(data, "delayed_start", False) self.delayed_start_duration = getattr(data, "delayed_start_duration", None) self.tool_uuids = getattr(data, "tool_uuids", None) self.document_uuids = getattr(data, "document_uuids", None) + self.mcp_tool_filters = getattr(data, "mcp_tool_filters", None) self.pre_call_fetch_enabled = getattr(data, "pre_call_fetch_enabled", False) self.pre_call_fetch_url = getattr(data, "pre_call_fetch_url", None) self.pre_call_fetch_credential_uuid = getattr( @@ -105,11 +105,11 @@ class WorkflowGraph: """ def __init__(self, dto: ReactFlowDTO): - # build adjacency list. n.type comes off the discriminated-union - # variant as a literal string; coerce to NodeType for downstream - # comparisons. + # Build adjacency list from validated DTO nodes. Core node comparisons + # still use NodeType string enums; integration nodes remain plain + # strings and resolve constraints through node specs. self.nodes: Dict[str, Node] = { - n.id: Node(n.id, NodeType(n.type), n.data) for n in dto.nodes + n.id: Node(n.id, n.type, n.data) for n in dto.nodes } # Store all edges @@ -139,7 +139,7 @@ class WorkflowGraph: # Get a reference to the global node try: self.global_node_id = [ - n.id for n in dto.nodes if n.type == NodeType.globalNode + n.id for n in dto.nodes if n.type == NodeType.globalNode.value ][0] except IndexError: self.global_node_id = None @@ -249,7 +249,7 @@ class WorkflowGraph: def _assert_global_node(self): errors: list[WorkflowError] = [] global_node = [ - n for n in self.nodes.values() if n.node_type == NodeType.globalNode + n for n in self.nodes.values() if n.node_type == NodeType.globalNode.value ] if not len(global_node) <= 1: errors.append( @@ -281,7 +281,7 @@ class WorkflowGraph: in_deg[m.id] += 1 for n in self.nodes.values(): - spec = REGISTRY.get(n.node_type.value) + spec = get_spec(n.node_type) if spec is None or spec.graph_constraints is None: continue gc = spec.graph_constraints diff --git a/api/tasks/campaign_tasks.py b/api/tasks/campaign_tasks.py index 6dc9ee9..286b9de 100644 --- a/api/tasks/campaign_tasks.py +++ b/api/tasks/campaign_tasks.py @@ -20,7 +20,7 @@ async def sync_campaign_source(ctx: Dict, campaign_id: int) -> None: Phase 1: Syncs data from configured source to queued_runs table - Campaign state should already be 'syncing' - Determines source type from campaign configuration - - Fetches data via appropriate sync service (Google Sheets, HubSpot, etc.) + - Fetches data via the appropriate sync service - Creates queued_run entries with unique source_uuid - Updates campaign total_rows - Transitions campaign state to 'running' on success diff --git a/api/tasks/run_integrations.py b/api/tasks/run_integrations.py index f60829c..be11a3c 100644 --- a/api/tasks/run_integrations.py +++ b/api/tasks/run_integrations.py @@ -1,7 +1,6 @@ """Execute integrations (QA analysis, webhooks) after workflow run completion.""" import random -from datetime import UTC, datetime from typing import Any, Dict, Optional import httpx @@ -14,6 +13,11 @@ from api.constants import BACKEND_API_ENDPOINT from api.db import db_client from api.db.models import WorkflowRunModel from api.enums import OrganizationConfigurationKey +from api.services.integrations import ( + IntegrationCompletionContext, + has_completion_handlers, + run_completion_handlers, +) from api.services.pipecat.tracing_config import register_org_langfuse_credentials from api.services.workflow.dto import ( QANodeData, @@ -214,16 +218,20 @@ async def run_integrations_post_workflow_run(_ctx, workflow_run_id: int): nodes = workflow_definition.get("nodes", []) qa_nodes = [n for n in nodes if n.get("type") == "qa"] webhook_nodes = [n for n in nodes if n.get("type") == "webhook"] + has_registered_integrations = has_completion_handlers(workflow_definition) - # Step 4: Generate public access token if webhooks exist or campaign_id is set + # Step 4: Generate a public access token for any run that needs post-call work. has_campaign = workflow_run.campaign_id is not None - if not webhook_nodes and not qa_nodes and not has_campaign: + if ( + not webhook_nodes + and not qa_nodes + and not has_registered_integrations + and not has_campaign + ): logger.debug("No integration nodes and no campaign, skipping") return - public_token = None - if webhook_nodes or has_campaign: - public_token = await db_client.ensure_public_access_token(workflow_run_id) + public_token = await db_client.ensure_public_access_token(workflow_run_id) # Step 5: Run QA analysis before webhooks if qa_nodes: @@ -263,17 +271,37 @@ async def run_integrations_post_workflow_run(_ctx, workflow_run_id: int): workflow_run_id ) - # Step 6: Execute webhooks + # Step 6: Run registered third-party integrations after uploads are complete + integration_results = await run_completion_handlers( + context=IntegrationCompletionContext( + workflow_run_id=workflow_run_id, + workflow_run=workflow_run, + workflow_definition=workflow_definition, + definition_id=definition_id, + organization_id=organization_id, + public_token=public_token, + ) + ) + + if integration_results: + await db_client.update_workflow_run( + workflow_run_id, annotations=integration_results + ) + workflow_run, _ = await db_client.get_workflow_run_with_context( + workflow_run_id + ) + + # Step 7: Execute webhooks if not webhook_nodes: logger.debug("No webhook nodes in workflow") return logger.info(f"Found {len(webhook_nodes)} webhook nodes to execute") - # Step 7: Build render context (includes annotations from QA) + # Step 8: Build render context (includes annotations from QA and integrations) render_context = _build_render_context(workflow_run, public_token) - # Step 8: Execute each webhook node + # Step 9: Execute each webhook node for node in webhook_nodes: node_id = node.get("id", "unknown") try: diff --git a/api/tests/conftest.py b/api/tests/conftest.py index 2c03283..a8beed7 100644 --- a/api/tests/conftest.py +++ b/api/tests/conftest.py @@ -15,16 +15,14 @@ import pytest from api.services.workflow.dto import ( AgentNodeData, - AgentRFNode, EdgeDataDTO, EndCallNodeData, - EndCallRFNode, ExtractionVariableDTO, Position, ReactFlowDTO, RFEdgeDTO, + RFNodeDTO, StartCallNodeData, - StartCallRFNode, VariableType, ) from api.services.workflow.workflow_graph import WorkflowGraph @@ -270,8 +268,9 @@ def simple_workflow() -> WorkflowGraph: """ dto = ReactFlowDTO( nodes=[ - StartCallRFNode( + RFNodeDTO( id="start", + type="startCall", position=Position(x=0, y=0), data=StartCallNodeData( name="Start Call", @@ -290,8 +289,9 @@ def simple_workflow() -> WorkflowGraph: ], ), ), - EndCallRFNode( + RFNodeDTO( id="end", + type="endCall", position=Position(x=0, y=200), data=EndCallNodeData( name="End Call", @@ -333,8 +333,9 @@ def three_node_workflow() -> WorkflowGraph: """ dto = ReactFlowDTO( nodes=[ - StartCallRFNode( + RFNodeDTO( id="start", + type="startCall", position=Position(x=0, y=0), data=StartCallNodeData( name="Start Call", @@ -353,8 +354,9 @@ def three_node_workflow() -> WorkflowGraph: ], ), ), - AgentRFNode( + RFNodeDTO( id="agent", + type="agentNode", position=Position(x=0, y=200), data=AgentNodeData( name="Collect Info", @@ -372,8 +374,9 @@ def three_node_workflow() -> WorkflowGraph: ], ), ), - EndCallRFNode( + RFNodeDTO( id="end", + type="endCall", position=Position(x=0, y=400), data=EndCallNodeData( name="End Call", @@ -424,8 +427,9 @@ def three_node_workflow_extraction_start_only() -> WorkflowGraph: """ dto = ReactFlowDTO( nodes=[ - StartCallRFNode( + RFNodeDTO( id="start", + type="startCall", position=Position(x=0, y=0), data=StartCallNodeData( name="Start Call", @@ -444,8 +448,9 @@ def three_node_workflow_extraction_start_only() -> WorkflowGraph: ], ), ), - AgentRFNode( + RFNodeDTO( id="agent", + type="agentNode", position=Position(x=0, y=200), data=AgentNodeData( name="Collect Info", @@ -455,8 +460,9 @@ def three_node_workflow_extraction_start_only() -> WorkflowGraph: extraction_enabled=False, # Explicitly disabled for testing ), ), - EndCallRFNode( + RFNodeDTO( id="end", + type="endCall", position=Position(x=0, y=400), data=EndCallNodeData( name="End Call", @@ -503,8 +509,9 @@ def three_node_workflow_no_variable_extraction() -> WorkflowGraph: """ dto = ReactFlowDTO( nodes=[ - StartCallRFNode( + RFNodeDTO( id="start", + type="startCall", position=Position(x=0, y=0), data=StartCallNodeData( name="Start Call", @@ -515,8 +522,9 @@ def three_node_workflow_no_variable_extraction() -> WorkflowGraph: extraction_enabled=False, ), ), - AgentRFNode( + RFNodeDTO( id="agent", + type="agentNode", position=Position(x=0, y=200), data=AgentNodeData( name="Collect Info", @@ -526,8 +534,9 @@ def three_node_workflow_no_variable_extraction() -> WorkflowGraph: extraction_enabled=False, # Explicitly disabled for testing ), ), - EndCallRFNode( + RFNodeDTO( id="end", + type="endCall", position=Position(x=0, y=400), data=EndCallNodeData( name="End Call", diff --git a/api/tests/dto_fixtures/sample_branching_workflow.json b/api/tests/dto_fixtures/sample_branching_workflow.json index b470f71..888ae2a 100644 --- a/api/tests/dto_fixtures/sample_branching_workflow.json +++ b/api/tests/dto_fixtures/sample_branching_workflow.json @@ -63,7 +63,6 @@ }, "data": { "prompt": "Hello, I am Abhishek from Dograh. ", - "is_static": true, "name": "Start Call", "is_start": true }, @@ -83,7 +82,6 @@ }, "data": { "prompt": "Thank you for calling Dograh. Have a great day!", - "is_static": true, "name": "End Call" }, "measured": { @@ -161,4 +159,4 @@ "y": 0, "zoom": 1 } -} \ No newline at end of file +} diff --git a/api/tests/support/__init__.py b/api/tests/support/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/api/tests/support/mcp_mock_server.py b/api/tests/support/mcp_mock_server.py new file mode 100644 index 0000000..09a3c8b --- /dev/null +++ b/api/tests/support/mcp_mock_server.py @@ -0,0 +1,103 @@ +"""A real FastMCP server exposing 2 tools over streamable-HTTP, run in a +background uvicorn thread on an ephemeral port. Used to exercise the real +MCP protocol path in tests. +""" + +from __future__ import annotations + +import asyncio +import contextlib +import socket +import threading +from typing import AsyncIterator + +import httpx +import uvicorn +from fastmcp import FastMCP +from starlette.responses import JSONResponse + + +def _build_app(required_headers: dict[str, str] | None = None): + mcp = FastMCP("mock-mcp") + + @mcp.tool() + def echo(text: str) -> str: + """Echo the provided text back.""" + return f"echo:{text}" + + @mcp.tool() + def add(a: int, b: int) -> int: + """Add two integers.""" + return a + b + + # FastMCP 3.x: ASGI app for streamable-HTTP transport at "/mcp". + app = mcp.http_app() + if not required_headers: + return app + + normalized = {k.lower(): v for k, v in required_headers.items()} + + async def guarded_app(scope, receive, send): + if scope["type"] == "http": + headers = { + key.decode("latin-1").lower(): value.decode("latin-1") + for key, value in scope.get("headers", []) + } + for header_name, expected_value in normalized.items(): + if headers.get(header_name) != expected_value: + response = JSONResponse( + {"detail": f"Missing or invalid header: {header_name}"}, + status_code=401, + ) + await response(scope, receive, send) + return + await app(scope, receive, send) + + return guarded_app + + +def _free_port() -> int: + with contextlib.closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s: + s.bind(("127.0.0.1", 0)) + return s.getsockname()[1] + + +@contextlib.asynccontextmanager +async def running_mcp_server( + *, required_headers: dict[str, str] | None = None +) -> AsyncIterator[str]: + """Yield the base streamable-HTTP URL of a live mock MCP server.""" + port = _free_port() + config = uvicorn.Config( + _build_app(required_headers), host="127.0.0.1", port=port, log_level="warning" + ) + server = uvicorn.Server(config) + thread = threading.Thread(target=server.run, daemon=True) + thread.start() + + base_url = f"http://127.0.0.1:{port}/mcp" + server_ready = False + for _ in range(50): + try: + async with httpx.AsyncClient() as client: + await client.get(base_url, timeout=0.5) + server_ready = True + break + except Exception: + await asyncio.sleep(0.1) + if not server_ready: + server.should_exit = True + thread.join(timeout=5) + raise RuntimeError(f"Mock MCP server at {base_url} failed to start within 5s") + try: + yield base_url + finally: + server.should_exit = True + thread.join(timeout=5) + if thread.is_alive(): + import warnings + + warnings.warn( + "Mock MCP server thread did not terminate within 5s", + ResourceWarning, + ) diff --git a/api/tests/telephony/telnyx/test_provider.py b/api/tests/telephony/telnyx/test_provider.py index 3f0f6f3..6462119 100644 --- a/api/tests/telephony/telnyx/test_provider.py +++ b/api/tests/telephony/telnyx/test_provider.py @@ -153,45 +153,16 @@ async def test_verify_inbound_signature_rejects_missing_config_public_key(): _, headers = _signed_headers(body) provider = _provider() - # REMOVE-AFTER 2026-05-15: drop the patch wrapper once - # TELNYX_WEBHOOK_VERIFICATION_OPTIONAL is removed; the bare call below - # will then assert the only path. - with patch( - "api.services.telephony.providers.telnyx.provider.TELNYX_WEBHOOK_VERIFICATION_OPTIONAL", - False, - ): - result = await provider.verify_inbound_signature( - "https://example.test/api/v1/telephony/inbound/run", - json.loads(body), - headers, - body, - ) + result = await provider.verify_inbound_signature( + "https://example.test/api/v1/telephony/inbound/run", + json.loads(body), + headers, + body, + ) assert result is False -# REMOVE-AFTER 2026-05-15: delete this whole test along with the -# TELNYX_WEBHOOK_VERIFICATION_OPTIONAL flag. -@pytest.mark.asyncio -async def test_verify_inbound_signature_allows_missing_key_when_optional_flag_set(): - body = _body() - _, headers = _signed_headers(body) - provider = _provider() - - with patch( - "api.services.telephony.providers.telnyx.provider.TELNYX_WEBHOOK_VERIFICATION_OPTIONAL", - True, - ): - result = await provider.verify_inbound_signature( - "https://example.test/api/v1/telephony/inbound/run", - json.loads(body), - headers, - body, - ) - - assert result is True - - @pytest.mark.asyncio async def test_verify_inbound_signature_reads_headers_case_insensitively(): body = _body() diff --git a/api/tests/test_dograh_sdk_typed.py b/api/tests/test_dograh_sdk_typed.py index 4b23076..042f336 100644 --- a/api/tests/test_dograh_sdk_typed.py +++ b/api/tests/test_dograh_sdk_typed.py @@ -19,6 +19,7 @@ from dograh_sdk.typed import ( Qa, StartCall, Trigger, + Tuner, TypedNode, Webhook, ) @@ -50,6 +51,7 @@ def client() -> _StubClient: (Trigger, "trigger"), (Webhook, "webhook"), (Qa, "qa"), + (Tuner, "tuner"), ], ids=lambda v: v.__name__ if isinstance(v, type) else v, ) @@ -68,8 +70,15 @@ def test_typed_class_declares_spec_name(cls: type[TypedNode], expected_type: str inst = cls(name="t") elif cls is Webhook: inst = cls(name="wh") - else: # Qa + elif cls is Qa: inst = cls(name="qa") + else: # Tuner + inst = cls( + name="tuner", + tuner_agent_id="agent", + tuner_workspace_id=1, + tuner_api_key="secret", + ) assert inst.type == expected_type diff --git a/api/tests/test_dto.py b/api/tests/test_dto.py index 512252b..1f99d02 100644 --- a/api/tests/test_dto.py +++ b/api/tests/test_dto.py @@ -16,6 +16,37 @@ async def test_dto(): assert dto is not None +def test_dto_ignores_legacy_unknown_node_data_fields(): + dto = ReactFlowDTO.model_validate( + { + "nodes": [ + { + "id": "n1", + "type": "startCall", + "position": {"x": 0, "y": 0}, + "data": { + "name": "Start", + "prompt": "Hello", + "is_static": True, + "detect_voicemail": True, + "wait_for_user_response": False, + "wait_for_user_response_timeout": 2.5, + "legacy_field": "ignored", + }, + } + ], + "edges": [], + } + ) + + data = dto.nodes[0].data.model_dump() + assert "is_static" not in data + assert "detect_voicemail" not in data + assert "wait_for_user_response" not in data + assert "wait_for_user_response_timeout" not in data + assert "legacy_field" not in data + + def test_sanitize_strips_ui_runtime_fields(): definition = { "viewport": {"x": 0, "y": 0, "zoom": 1}, diff --git a/api/tests/test_is_private_ip_candidate.py b/api/tests/test_is_private_ip_candidate.py index 25feb5a..1ea6834 100644 --- a/api/tests/test_is_private_ip_candidate.py +++ b/api/tests/test_is_private_ip_candidate.py @@ -1,4 +1,11 @@ -from api.routes.webrtc_signaling import is_private_ip_candidate +from api.enums import Environment +from api.routes.webrtc_signaling import ( + NonRelayFilterPolicy, + _keep_candidate, + is_local_or_cgnat_ip, + is_private_ip_candidate, + resolve_ice_filter_policies, +) class TestIsPrivateIpCandidate: @@ -142,3 +149,78 @@ class TestIsPrivateIpCandidate: "candidate:999 1 tcp 1518280447 192.168.1.100 9 typ host tcptype active" ) assert is_private_ip_candidate(candidate) is True + + +class TestIsLocalOrCgnatIp: + def test_loopback_is_local(self): + assert is_local_or_cgnat_ip("127.0.0.1") is True + + def test_link_local_is_local(self): + assert is_local_or_cgnat_ip("169.254.1.1") is True + + def test_cgnat_is_local(self): + assert is_local_or_cgnat_ip("100.64.0.1") is True + + def test_public_ipv4_is_not_local(self): + assert is_local_or_cgnat_ip("8.8.8.8") is False + + +class TestKeepCandidate: + def test_private_relay_candidate_survives_private_policy(self): + candidate = ( + "candidate:111 1 udp 41885439 192.168.1.50 50000 typ relay raddr 0.0.0.0 rport 0" + ) + assert _keep_candidate(candidate, NonRelayFilterPolicy.PRIVATE) is True + + def test_private_host_candidate_drops_under_private_policy(self): + candidate = ( + "candidate:123 1 udp 2122260223 192.168.50.24 63603 typ host generation 0" + ) + assert _keep_candidate(candidate, NonRelayFilterPolicy.PRIVATE) is False + + +class TestResolveIceFilterPolicies: + def test_local_deployment_keeps_all_candidates(self): + outbound, inbound = resolve_ice_filter_policies( + Environment.LOCAL.value, + False, + "", + ) + assert outbound == NonRelayFilterPolicy.NONE + assert inbound == NonRelayFilterPolicy.NONE + + def test_private_lan_remote_keeps_all_candidates(self): + outbound, inbound = resolve_ice_filter_policies( + Environment.PRODUCTION.value, + False, + "192.168.50.24", + ) + assert outbound == NonRelayFilterPolicy.NONE + assert inbound == NonRelayFilterPolicy.NONE + + def test_public_remote_filters_private_candidates(self): + outbound, inbound = resolve_ice_filter_policies( + Environment.PRODUCTION.value, + False, + "8.8.8.8", + ) + assert outbound == NonRelayFilterPolicy.PRIVATE + assert inbound == NonRelayFilterPolicy.PRIVATE + + def test_force_turn_relay_stays_relay_only_on_private_lan(self): + outbound, inbound = resolve_ice_filter_policies( + Environment.PRODUCTION.value, + True, + "192.168.50.24", + ) + assert outbound == NonRelayFilterPolicy.ALL + assert inbound == NonRelayFilterPolicy.NONE + + def test_force_turn_relay_keeps_public_remote_private_filter(self): + outbound, inbound = resolve_ice_filter_policies( + Environment.PRODUCTION.value, + True, + "8.8.8.8", + ) + assert outbound == NonRelayFilterPolicy.ALL + assert inbound == NonRelayFilterPolicy.PRIVATE diff --git a/api/tests/test_mcp_auth.py b/api/tests/test_mcp_auth.py new file mode 100644 index 0000000..c6c10c1 --- /dev/null +++ b/api/tests/test_mcp_auth.py @@ -0,0 +1,63 @@ +from unittest.mock import AsyncMock, MagicMock, patch + +import pytest +from fastapi import HTTPException + +from api.mcp_server.auth import authenticate_mcp_request + + +@pytest.mark.asyncio +async def test_authenticate_mcp_request_accepts_bearer_authorization(): + user = MagicMock() + user.id = 1 + user.selected_organization_id = 90 + + with ( + patch( + "api.mcp_server.auth.get_http_headers", + return_value={"authorization": "Bearer secret-api-key"}, + ) as get_headers, + patch( + "api.mcp_server.auth._handle_api_key_auth", + AsyncMock(return_value=user), + ) as handle_auth, + ): + authed = await authenticate_mcp_request() + + assert authed is user + get_headers.assert_called_once_with(include={"authorization"}) + handle_auth.assert_awaited_once_with("secret-api-key") + + +@pytest.mark.asyncio +async def test_authenticate_mcp_request_accepts_x_api_key(): + user = MagicMock() + user.id = 2 + user.selected_organization_id = 91 + + with ( + patch( + "api.mcp_server.auth.get_http_headers", + return_value={"x-api-key": "secret-api-key"}, + ) as get_headers, + patch( + "api.mcp_server.auth._handle_api_key_auth", + AsyncMock(return_value=user), + ) as handle_auth, + ): + authed = await authenticate_mcp_request() + + assert authed is user + get_headers.assert_called_once_with(include={"authorization"}) + handle_auth.assert_awaited_once_with("secret-api-key") + + +@pytest.mark.asyncio +async def test_authenticate_mcp_request_rejects_missing_api_key(): + with patch("api.mcp_server.auth.get_http_headers", return_value={}) as get_headers: + with pytest.raises(HTTPException) as exc_info: + await authenticate_mcp_request() + + assert exc_info.value.status_code == 401 + assert "Missing API key" in str(exc_info.value.detail) + get_headers.assert_called_once_with(include={"authorization"}) diff --git a/api/tests/test_mcp_custom_tool_manager.py b/api/tests/test_mcp_custom_tool_manager.py new file mode 100644 index 0000000..b40776a --- /dev/null +++ b/api/tests/test_mcp_custom_tool_manager.py @@ -0,0 +1,181 @@ +import uuid +from unittest.mock import AsyncMock, MagicMock + +import pytest + +from api.enums import ToolCategory +from api.services.workflow.mcp_tool_session import McpToolSession +from api.services.workflow.pipecat_engine_custom_tools import CustomToolManager +from api.tests.support.mcp_mock_server import running_mcp_server + + +def _mcp_tool(): + t = MagicMock() + t.tool_uuid = "uuid-" + uuid.uuid4().hex[:8] + t.name = "Acme MCP" + t.category = ToolCategory.MCP.value + t.definition = {"type": "mcp", "config": {"url": "https://x/mcp"}} + return t + + +@pytest.mark.asyncio +async def test_get_tool_schemas_and_handler_for_mcp(monkeypatch): + async with running_mcp_server() as base_url: + tool = _mcp_tool() + session = McpToolSession( + tool_uuid=tool.tool_uuid, + tool_name=tool.name, + url=base_url, + credential=None, + tools_filter=[], + timeout_secs=10, + sse_read_timeout_secs=10, + ) + await session.start() + + engine = MagicMock() + engine._mcp_sessions = {tool.tool_uuid: session} + registered = {} + reg_kwargs = {} + + def _reg(name, fn, **kw): + registered[name] = fn + reg_kwargs[name] = kw + + engine.llm.register_function = _reg + + mgr = CustomToolManager(engine) + mgr.get_organization_id = AsyncMock(return_value=42) + + from api.db import db_client + + monkeypatch.setattr( + db_client, "get_tools_by_uuids", AsyncMock(return_value=[tool]) + ) + + try: + schemas = await mgr.get_tool_schemas([tool.tool_uuid]) + names = sorted(s.name for s in schemas) + assert names == ["mcp__acme_mcp__add", "mcp__acme_mcp__echo"] + + await mgr.register_handlers([tool.tool_uuid]) + assert "mcp__acme_mcp__echo" in registered + assert reg_kwargs["mcp__acme_mcp__echo"]["timeout_secs"] == pytest.approx( + 15.0 + ) + + captured = {} + + class P: + function_name = "mcp__acme_mcp__echo" + arguments = {"text": "yo"} + + async def result_callback(self, r, *, properties=None): + captured["r"] = r + + await registered["mcp__acme_mcp__echo"](P()) + assert "echo:yo" in str(captured["r"]) + finally: + await session.close() + + +@pytest.mark.asyncio +async def test_unavailable_mcp_session_contributes_nothing(monkeypatch): + tool = _mcp_tool() + session = McpToolSession( + tool_uuid=tool.tool_uuid, + tool_name=tool.name, + url="http://127.0.0.1:1/mcp", + credential=None, + tools_filter=[], + timeout_secs=1, + sse_read_timeout_secs=1, + ) + await session.start() # degrades + + engine = MagicMock() + engine._mcp_sessions = {tool.tool_uuid: session} + mgr = CustomToolManager(engine) + mgr.get_organization_id = AsyncMock(return_value=42) + + from api.db import db_client + + monkeypatch.setattr(db_client, "get_tools_by_uuids", AsyncMock(return_value=[tool])) + + schemas = await mgr.get_tool_schemas([tool.tool_uuid]) + assert schemas == [] + await mgr.register_handlers([tool.tool_uuid]) # must not raise + + +def test_call_timeout_secs_is_read_timeout_plus_buffer(): + session = McpToolSession( + tool_uuid="uuid-abc123", + tool_name="Acme MCP", + url="https://x/mcp", + credential=None, + tools_filter=[], + timeout_secs=10, + sse_read_timeout_secs=20, + ) + assert session.call_timeout_secs == 25.0 + + +@pytest.mark.asyncio +async def test_per_node_mcp_filter_intersection(monkeypatch): + async with running_mcp_server() as base_url: + tool = _mcp_tool() + session = McpToolSession( + tool_uuid=tool.tool_uuid, + tool_name=tool.name, + url=base_url, + credential=None, + tools_filter=[], + timeout_secs=10, + sse_read_timeout_secs=10, + ) + await session.start() + + engine = MagicMock() + engine._mcp_sessions = {tool.tool_uuid: session} + registered = {} + engine.llm.register_function = lambda name, fn, **kw: registered.__setitem__( + name, fn + ) + + mgr = CustomToolManager(engine) + mgr.get_organization_id = AsyncMock(return_value=42) + + from api.db import db_client + + monkeypatch.setattr( + db_client, "get_tools_by_uuids", AsyncMock(return_value=[tool]) + ) + try: + # Allow only raw "echo" for this node + filters = {tool.tool_uuid: ["echo"]} + schemas = await mgr.get_tool_schemas( + [tool.tool_uuid], mcp_tool_filters=filters + ) + # Check only "echo" schema returned (namespaced name depends on tool.name) + assert len(schemas) == 1 + assert all("echo" in s.name for s in schemas) + + await mgr.register_handlers([tool.tool_uuid], mcp_tool_filters=filters) + assert len(registered) == 1 + assert all("echo" in k for k in registered) + + # No filter entry for this uuid = none (default-none) + registered.clear() + result = await mgr.get_tool_schemas([tool.tool_uuid], mcp_tool_filters={}) + assert result == [] + await mgr.register_handlers([tool.tool_uuid], mcp_tool_filters={}) + assert registered == {} + + # mcp_tool_filters=None = backward-compatible (all tools) + registered.clear() + all_schemas = await mgr.get_tool_schemas([tool.tool_uuid]) + assert len(all_schemas) == 2 # both echo and add + await mgr.register_handlers([tool.tool_uuid]) + assert len(registered) == 2 # both handlers registered + finally: + await session.close() diff --git a/api/tests/test_mcp_docs_search.py b/api/tests/test_mcp_docs_search.py new file mode 100644 index 0000000..5019aeb --- /dev/null +++ b/api/tests/test_mcp_docs_search.py @@ -0,0 +1,359 @@ +"""Unit tests for the MCP docs discovery tools.""" + +from __future__ import annotations + +import os +from pathlib import Path +from unittest.mock import AsyncMock, patch + +import pytest +from fastapi import HTTPException + +from api.mcp_server.tools import docs_search as docs_search_module +from api.mcp_server.tools.docs_search import ( + _docs_index, + _extract_page_title, + _resolve_docs_root, + _score_page, + _strip_frontmatter, + _tokenize_query, + list_docs, + read_doc, + search_docs, +) + + +def _clear_docs_caches() -> None: + docs_search_module._docs_index.cache_clear() + + +@pytest.fixture +def fake_docs_root(tmp_path: Path) -> Path: + docs_root = tmp_path / "docs" + docs_root.mkdir() + + (docs_root / "getting-started").mkdir() + (docs_root / "getting-started" / "index.mdx").write_text( + "---\n" + 'title: "Getting started"\n' + 'description: "Start using Dograh."\n' + "---\n\n" + "# Getting started\n\n" + "Welcome to Dograh.\n", + encoding="utf-8", + ) + + (docs_root / "voice-agent").mkdir() + (docs_root / "voice-agent" / "introduction.mdx").write_text( + "---\n" + 'title: "Voice Agent Builder"\n' + 'description: "Build conversational workflows."\n' + "---\n\n" + "# Voice Agent Builder\n\n" + "Build workflows with nodes and tools.\n", + encoding="utf-8", + ) + + (docs_root / "voice-agent" / "tools").mkdir() + (docs_root / "voice-agent" / "tools" / "mcp-tool.mdx").write_text( + "---\n" + 'title: "MCP Tool"\n' + 'description: "Connect external MCP servers."\n' + 'llm_hint: "Use for MCP server setup, remote tools, or model context protocol questions."\n' + "aliases:\n" + ' - "model context protocol"\n' + "---\n\n" + "# MCP Tool\n\n" + "Connect an external MCP server to your voice agent.\n\n" + "## Authentication\n\n" + "Provide the MCP endpoint URL and headers.\n", + encoding="utf-8", + ) + + (docs_root / "deployment").mkdir() + (docs_root / "deployment" / "docker.mdx").write_text( + "---\n" + 'title: "Docker"\n' + 'description: "Deploy Dograh with Docker."\n' + 'llm_hint: "Use for Docker deployment, local setup, remote setup, TURN server, coturn, or WebRTC connectivity questions."\n' + "aliases:\n" + ' - "coturn"\n' + ' - "turn server"\n' + "---\n\n" + "# Docker\n\n" + "Run Dograh with Docker.\n\n" + "## Troubleshooting WebRTC Connectivity\n\n" + "If audio fails or ICE fails, configure a TURN server. Coturn is the recommended choice.\n", + encoding="utf-8", + ) + + # Hidden/orphaned docs page: present on disk but not in docs.json, so it + # must not be indexed by the MCP tools. + (docs_root / "internal-only.mdx").write_text( + "---\n" + 'title: "Internal TURN Notes"\n' + "---\n\n" + "# Internal TURN Notes\n\n" + "This page mentions zyxinternalturntoken but is not user-facing.\n", + encoding="utf-8", + ) + + (docs_root / "AGENTS.md").write_text("# Internal instructions\n", encoding="utf-8") + + (docs_root / "docs.json").write_text( + """{ + "navigation": { + "tabs": [ + { + "tab": "Guides", + "groups": [ + { + "group": "Getting started", + "pages": [ + "getting-started/index" + ] + }, + { + "group": "Voice Agent Builder", + "pages": [ + "voice-agent/introduction", + { + "group": "Tools", + "pages": [ + "voice-agent/tools/mcp-tool" + ] + } + ] + } + ] + }, + { + "tab": "Developer", + "groups": [ + { + "group": "Deployment", + "pages": [ + "deployment/docker" + ] + } + ] + } + ] + } +} +""", + encoding="utf-8", + ) + + _clear_docs_caches() + with patch.dict(os.environ, {"DOGRAH_DOCS_PATH": str(docs_root)}): + yield docs_root + _clear_docs_caches() + + +@pytest.fixture +def authed_user(): + class _FakeUser: + selected_organization_id = 1 + id = 42 + + with patch( + "api.mcp_server.tools.docs_search.authenticate_mcp_request", + new=AsyncMock(return_value=_FakeUser()), + ): + yield _FakeUser() + + +def test_tokenize_query_dedupes_and_drops_stopwords(): + assert _tokenize_query("How do I configure a TURN server TURN?") == [ + "configure", + "turn", + "server", + ] + + +def test_tokenize_query_empty_input_returns_empty(): + assert _tokenize_query("") == [] + assert _tokenize_query("?? // !!") == [] + + +def test_strip_frontmatter_removes_yaml_block(): + body = '---\ntitle: "X"\n---\n\n# Heading\n' + assert _strip_frontmatter(body).startswith("# Heading") + + +def test_extract_page_title_prefers_frontmatter(): + body = '---\ntitle: "Front Title"\n---\n\n# Heading Title\n' + assert _extract_page_title(body, fallback="x.mdx") == "Front Title" + + +def test_extract_page_title_falls_back_to_first_heading(): + body = "# Heading Title\nbody\n" + assert _extract_page_title(body, fallback="x.mdx") == "Heading Title" + + +def test_score_page_uses_llm_hint_and_aliases(): + page = docs_search_module.DocPage( + path="deployment/docker", + file_path="deployment/docker.mdx", + title="Docker", + description="Deploy Dograh with Docker.", + llm_hint="Use for TURN server and coturn setup.", + aliases=("coturn",), + breadcrumb=("Developer", "Deployment"), + content="Docker deployment.", + sections=( + docs_search_module.DocSection( + title="Troubleshooting WebRTC Connectivity", + slug="troubleshooting-webrtc-connectivity", + level=2, + content="Configure a TURN server with coturn.", + ), + ), + order=0, + ) + score, section = _score_page(page, ["coturn"]) + assert score > 0 + assert section is not None + assert section.slug == "troubleshooting-webrtc-connectivity" + + +def test_resolve_docs_root_honors_env_override(tmp_path: Path): + docs = tmp_path / "custom_docs" + docs.mkdir() + (docs / "docs.json").write_text("{}", encoding="utf-8") + with patch.dict(os.environ, {"DOGRAH_DOCS_PATH": str(docs)}): + assert _resolve_docs_root() == docs.resolve() + + +@pytest.mark.asyncio +async def test_search_docs_ranks_turn_doc_and_uses_route_path( + fake_docs_root, authed_user +): + results = await search_docs("How do I configure coturn for WebRTC?") + assert results + assert results[0]["path"] == "deployment/docker" + assert results[0]["section_slug"] == "troubleshooting-webrtc-connectivity" + assert "TURN server" in results[0]["llm_hint"] + assert "snippet" not in results[0] + assert "score" not in results[0] + assert "url" not in results[0] + + +@pytest.mark.asyncio +async def test_search_docs_indexes_only_docs_json_pages(fake_docs_root, authed_user): + results = await search_docs("zyxinternalturntoken") + assert results == [] + + +@pytest.mark.asyncio +async def test_search_docs_respects_limit(fake_docs_root, authed_user): + results = await search_docs("dograh", limit=1) + assert len(results) == 1 + + +@pytest.mark.asyncio +async def test_search_docs_returns_empty_when_no_match(fake_docs_root, authed_user): + assert await search_docs("xyzzy unrelated zzz") == [] + + +@pytest.mark.asyncio +async def test_search_docs_returns_empty_when_no_corpus( + tmp_path, authed_user, monkeypatch +): + nonexistent = tmp_path / "no-docs-here" + monkeypatch.setenv("DOGRAH_DOCS_PATH", str(nonexistent)) + _clear_docs_caches() + with patch( + "api.mcp_server.tools.docs_search._resolve_docs_root", return_value=None + ): + assert await search_docs("anything") == [] + + +@pytest.mark.asyncio +async def test_search_docs_rejects_empty_query(fake_docs_root, authed_user): + with pytest.raises(ValueError, match="non-empty string"): + await search_docs("") + + +@pytest.mark.asyncio +async def test_search_docs_rejects_query_with_only_stopwords( + fake_docs_root, authed_user +): + with pytest.raises(ValueError, match="non-stopword"): + await search_docs("how do I") + + +@pytest.mark.asyncio +async def test_search_docs_rejects_zero_limit(fake_docs_root, authed_user): + with pytest.raises(ValueError, match="at least 1"): + await search_docs("Dograh", limit=0) + + +@pytest.mark.asyncio +async def test_list_docs_returns_top_level_sections(fake_docs_root, authed_user): + results = await list_docs() + assert results[0]["kind"] == "section" + assert results[0]["path"] == "guides/getting-started" + assert results[1]["path"] == "guides/voice-agent-builder" + + +@pytest.mark.asyncio +async def test_list_docs_depth_expands_children(fake_docs_root, authed_user): + results = await list_docs("guides/voice-agent-builder", depth=2) + paths = [item["path"] for item in results] + assert "voice-agent/introduction" in paths + assert "guides/voice-agent-builder/tools" in paths + assert "voice-agent/tools/mcp-tool" in paths + + +@pytest.mark.asyncio +async def test_list_docs_rejects_unknown_section(fake_docs_root, authed_user): + with pytest.raises(HTTPException, match="Unknown docs section"): + await list_docs("nope") + + +@pytest.mark.asyncio +async def test_read_doc_returns_full_page_and_sections(fake_docs_root, authed_user): + result = await read_doc("deployment/docker") + assert result["path"] == "deployment/docker" + assert result["title"] == "Docker" + assert "url" not in result + section_slugs = [section["slug"] for section in result["sections"]] + assert "docker" in section_slugs + assert "troubleshooting-webrtc-connectivity" in section_slugs + assert "Coturn" in result["content"] or "coturn" in result["content"].lower() + + +@pytest.mark.asyncio +async def test_read_doc_can_target_section(fake_docs_root, authed_user): + result = await read_doc( + "deployment/docker", + section="troubleshooting-webrtc-connectivity", + ) + assert result["section_slug"] == "troubleshooting-webrtc-connectivity" + assert "ICE fails" in result["content"] or "TURN server" in result["content"] + assert "Run Dograh with Docker." not in result["content"] + + +@pytest.mark.asyncio +async def test_read_doc_rejects_unknown_page(fake_docs_root, authed_user): + with pytest.raises(HTTPException, match="Unknown docs page"): + await read_doc("missing/page") + + +@pytest.mark.asyncio +async def test_read_doc_rejects_unknown_section(fake_docs_root, authed_user): + with pytest.raises(HTTPException, match="Unknown section"): + await read_doc("deployment/docker", section="missing-section") + + +def test_docs_index_uses_docs_json_navigation(fake_docs_root): + index = _docs_index() + assert "internal-only" not in index.pages_by_path + assert "guides/voice-agent-builder/tools" in index.sections_by_path + assert index.pages_by_path["voice-agent/tools/mcp-tool"].breadcrumb == ( + "Guides", + "Voice Agent Builder", + "Tools", + ) diff --git a/api/tests/test_mcp_instructions_drift.py b/api/tests/test_mcp_instructions_drift.py new file mode 100644 index 0000000..275b824 --- /dev/null +++ b/api/tests/test_mcp_instructions_drift.py @@ -0,0 +1,115 @@ +"""Drift guards between the static MCP guide and the live tool surface. + +`api/mcp_server/instructions.py` is free text baked into the client +system prompt. It is *not* the authoritative description of the tools — +names, signatures, and per-tool error codes reach the model dynamically +via `tools/list`, derived from each tool's own function signature and +docstring. These tests fail on the two classic drift modes: + +1. The guide references a tool that is no longer registered (renamed or + removed) — the model would be told to call something that 404s. +2. A tool returns an `error_code` that is absent from the description it + ships via `tools/list` — the model can't learn to recover from it. + +Keep the guide about orchestration (call order, hard constraints) and let +the tools describe themselves. +""" + +from __future__ import annotations + +import re +from pathlib import Path + +import pytest + +from api.mcp_server import instructions as instructions_module +from api.mcp_server.server import mcp +from api.mcp_server.tools import create_workflow as create_workflow_module +from api.mcp_server.tools import save_workflow as save_workflow_module + +# Every registered MCP tool name starts with one of these verbs. A +# backticked snake_case token in the guide whose leading word is a verb is +# treated as a tool reference; field/reference names like `tool_refs`, +# `credential_ref`, or `pre_call_fetch` don't start with a verb and are +# correctly ignored. Extend this only when a new tool introduces a new +# leading verb (a missing verb under-checks, it never false-fails). +_TOOL_VERB_PREFIXES = frozenset( + { + "search", + "read", + "list", + "get", + "save", + "create", + "update", + "delete", + "add", + "remove", + "set", + } +) + +# A backtick immediately followed by a snake_case identifier (>= 1 +# underscore). Anchoring on the opening backtick captures the leading +# identifier of a code span whether it is bare (`read_doc`) or a call +# (`read_doc(path)`), while skipping DSL constructs like `wf.edge` or +# `new Workflow` whose first char after the backtick isn't `[a-z_]`. +_BACKTICKED_SNAKE_RE = re.compile(r"`([a-z][a-z0-9]*(?:_[a-z0-9]+)+)") + +# Error codes are emitted as the first string arg to `_error_result(...)`. +_ERROR_RESULT_LITERAL_RE = re.compile(r'_error_result\(\s*"([a-z_]+)"') +# `parse_error` / `validation_error` are picked by a `code_key` ternary +# rather than passed as a literal to `_error_result`, so match them too. +_CODE_KEY_LITERAL_RE = re.compile(r'"(parse_error|validation_error)"') + + +def _referenced_tool_names(text: str) -> set[str]: + return { + token + for token in _BACKTICKED_SNAKE_RE.findall(text) + if token.split("_", 1)[0] in _TOOL_VERB_PREFIXES + } + + +def _returned_error_codes(module) -> set[str]: + source = Path(module.__file__).read_text(encoding="utf-8") + return set(_ERROR_RESULT_LITERAL_RE.findall(source)) | set( + _CODE_KEY_LITERAL_RE.findall(source) + ) + + +@pytest.mark.asyncio +async def test_guide_only_references_registered_tools(): + registered = {tool.name for tool in await mcp.list_tools()} + referenced = _referenced_tool_names(instructions_module.DOGRAH_MCP_INSTRUCTIONS) + + assert referenced, "no tool references extracted — the regex likely broke" + unknown = sorted(referenced - registered) + assert not unknown, ( + f"instructions.py references tools that are not registered: {unknown}. " + f"Rename/remove the reference or register the tool. " + f"Registered tools: {sorted(registered)}." + ) + + +@pytest.mark.asyncio +@pytest.mark.parametrize( + "tool_name, module", + [ + ("save_workflow", save_workflow_module), + ("create_workflow", create_workflow_module), + ], +) +async def test_tool_documents_every_error_code_it_returns(tool_name, module): + descriptions = { + tool.name: tool.description or "" for tool in await mcp.list_tools() + } + description = descriptions[tool_name] + returned = _returned_error_codes(module) + + assert returned, f"no error codes detected in {tool_name} source — regex broke" + undocumented = sorted(code for code in returned if code not in description) + assert not undocumented, ( + f"{tool_name} returns error_code(s) {undocumented} absent from the description " + f"shipped via tools/list. Document them in the {tool_name} docstring." + ) diff --git a/api/tests/test_mcp_integration.py b/api/tests/test_mcp_integration.py new file mode 100644 index 0000000..4cf01f0 --- /dev/null +++ b/api/tests/test_mcp_integration.py @@ -0,0 +1,107 @@ +import uuid +from unittest.mock import AsyncMock, MagicMock + +import pytest + +from api.enums import ToolCategory +from api.services.workflow.pipecat_engine import PipecatEngine +from api.tests.support.mcp_mock_server import running_mcp_server + + +def _mcp_tool(url: str): + t = MagicMock() + t.tool_uuid = "uuid-" + uuid.uuid4().hex[:8] + t.name = "Acme MCP" + t.category = ToolCategory.MCP.value + t.definition = { + "schema_version": 1, + "type": "mcp", + "config": {"transport": "streamable_http", "url": url}, + } + return t + + +@pytest.mark.asyncio +async def test_engine_opens_and_closes_mcp_sessions(monkeypatch): + async with running_mcp_server() as base_url: + tool = _mcp_tool(base_url) + + engine = PipecatEngine.__new__(PipecatEngine) + node = MagicMock() + node.tool_uuids = [tool.tool_uuid] + workflow = MagicMock() + workflow.nodes = {"n1": node} + engine.workflow = workflow + engine._mcp_sessions = {} + + from api.db import db_client + + monkeypatch.setattr( + db_client, "get_tools_by_uuids", AsyncMock(return_value=[tool]) + ) + monkeypatch.setattr( + db_client, "get_credential_by_uuid", AsyncMock(return_value=None) + ) + engine._get_organization_id = AsyncMock(return_value=42) + + await engine._open_mcp_sessions() + try: + assert tool.tool_uuid in engine._mcp_sessions + sess = engine._mcp_sessions[tool.tool_uuid] + assert sess.available is True + assert len(sess.function_schemas()) == 2 + finally: + await engine._close_mcp_sessions() + assert engine._mcp_sessions == {} + + +@pytest.mark.asyncio +async def test_open_mcp_sessions_swallows_db_error(monkeypatch): + engine = PipecatEngine.__new__(PipecatEngine) + node = MagicMock() + node.tool_uuids = ["uuid-deadbeef"] + workflow = MagicMock() + workflow.nodes = {"n1": node} + engine.workflow = workflow + engine._mcp_sessions = {} + + from api.db import db_client + + monkeypatch.setattr( + db_client, + "get_tools_by_uuids", + AsyncMock(side_effect=RuntimeError("db down")), + ) + engine._get_organization_id = AsyncMock(return_value=42) + + # Must NOT raise + await engine._open_mcp_sessions() + assert engine._mcp_sessions == {} + + +@pytest.mark.asyncio +async def test_open_mcp_sessions_skips_tool_when_credential_fetch_fails(monkeypatch): + tool = _mcp_tool("http://127.0.0.1:1/mcp") + tool.definition["config"]["credential_uuid"] = "cred-1234" + + engine = PipecatEngine.__new__(PipecatEngine) + node = MagicMock() + node.tool_uuids = [tool.tool_uuid] + workflow = MagicMock() + workflow.nodes = {"n1": node} + engine.workflow = workflow + engine._mcp_sessions = {} + + from api.db import db_client + + monkeypatch.setattr(db_client, "get_tools_by_uuids", AsyncMock(return_value=[tool])) + monkeypatch.setattr( + db_client, + "get_credential_by_uuid", + AsyncMock(side_effect=RuntimeError("cred store down")), + ) + engine._get_organization_id = AsyncMock(return_value=42) + + # Must NOT raise, and must skip the tool (no futile unauthenticated start) + await engine._open_mcp_sessions() + assert engine._mcp_sessions == {} diff --git a/api/tests/test_mcp_tool_definition.py b/api/tests/test_mcp_tool_definition.py new file mode 100644 index 0000000..5158c3a --- /dev/null +++ b/api/tests/test_mcp_tool_definition.py @@ -0,0 +1,112 @@ +import importlib + +import pytest + +from api.enums import ToolCategory +from api.routes.tool import McpToolConfig as RouteMcpToolConfig +from api.routes.tool import McpToolDefinition as RouteMcpToolDefinition +from api.services.workflow.tools.mcp_tool import ( + McpDefinitionError, + McpToolConfig, + McpToolDefinition, + namespace_function_name, + validate_mcp_definition, +) + + +def test_mcp_category_exists(): + assert ToolCategory.MCP.value == "mcp" + assert ToolCategory("mcp") is ToolCategory.MCP + + +def test_mcp_migration_present_and_chained(monkeypatch): + mod = importlib.import_module( + "api.alembic.versions.0a1b2c3d4e5f_add_mcp_in_toolcategory" + ) + assert mod.revision == "0a1b2c3d4e5f" + assert mod.down_revision == "4c1f1e3e8ef2" + + calls = [] + + def fake_sync_enum_values(**kwargs): + calls.append(kwargs) + + monkeypatch.setattr(mod.op, "sync_enum_values", fake_sync_enum_values) + + mod.upgrade() + mod.downgrade() + + assert len(calls) == 2 + assert calls[0]["enum_name"] == "tool_category" + assert "mcp" in calls[0]["new_values"] + assert "mcp" not in calls[1]["new_values"] + + +def test_route_reuses_shared_mcp_models(): + assert RouteMcpToolConfig is McpToolConfig + assert RouteMcpToolDefinition is McpToolDefinition + + +def test_validate_mcp_definition_ok(): + cfg = validate_mcp_definition( + { + "schema_version": 1, + "type": "mcp", + "config": { + "transport": "streamable_http", + "url": "https://acme.example.com/mcp", + "credential_uuid": "cred-123", + "tools_filter": ["lookup_patient"], + "timeout_secs": 30, + "sse_read_timeout_secs": 300, + }, + } + ) + assert cfg["url"] == "https://acme.example.com/mcp" + assert cfg["transport"] == "streamable_http" + assert cfg["tools_filter"] == ["lookup_patient"] + assert cfg["timeout_secs"] == 30 + assert cfg["sse_read_timeout_secs"] == 300 + assert cfg["credential_uuid"] == "cred-123" + + +def test_validate_mcp_definition_defaults(): + cfg = validate_mcp_definition({"type": "mcp", "config": {"url": "https://x/mcp"}}) + assert cfg["transport"] == "streamable_http" + assert cfg["tools_filter"] == [] + assert cfg["timeout_secs"] == 30 + assert cfg["sse_read_timeout_secs"] == 300 + assert cfg["credential_uuid"] is None + + +@pytest.mark.parametrize( + "definition", + [ + {"type": "mcp", "config": {}}, + {"type": "mcp", "config": {"url": ""}}, + {"type": "mcp", "config": {"url": "ftp://x"}}, + {"type": "mcp"}, + {"type": "mcp", "config": {"url": "https://x", "transport": "stdio"}}, + ], +) +def test_validate_mcp_definition_rejects(definition): + with pytest.raises(McpDefinitionError): + validate_mcp_definition(definition) + + +def test_validate_mcp_definition_zero_timeout_preserved(): + cfg = validate_mcp_definition( + {"type": "mcp", "config": {"url": "https://x/mcp", "timeout_secs": 0}} + ) + assert cfg["timeout_secs"] == 0 + + +def test_namespace_function_name(): + assert ( + namespace_function_name("Acme MCP", "lookup_patient") + == "mcp__acme_mcp__lookup_patient" + ) + assert ( + namespace_function_name("", "ping", fallback="abcd1234") + == "mcp__abcd1234__ping" + ) diff --git a/api/tests/test_mcp_tool_route.py b/api/tests/test_mcp_tool_route.py new file mode 100644 index 0000000..a16f75c --- /dev/null +++ b/api/tests/test_mcp_tool_route.py @@ -0,0 +1,437 @@ +"""Route-level tests for the MCP tool definition schema. + +These tests exercise the Pydantic request models (CreateToolRequest / +UpdateToolRequest) to catch schema gaps at the route/request-model layer — +the layer where the pre-fix defect lived (HTTP 422 on every MCP tool +creation attempt). + +Test coverage: +- CreateToolRequest validates a valid MCP definition (was 422 before Part A). +- UpdateToolRequest validates a valid MCP definition. +- Invalid MCP bodies are rejected (ftp:// url, missing url). +- Round-trip: validated definition dict passes through validate_mcp_definition + unchanged, proving the request schema and call-time validator agree. +- Full HTTP round-trip via the ASGI test client (POST /api/v1/tools/). +""" + +from __future__ import annotations + +import pytest +from pydantic import ValidationError + +from api.routes.tool import CreateToolRequest, McpToolDefinition, UpdateToolRequest +from api.services.workflow.tools.mcp_tool import ( + validate_mcp_definition, +) + +# ── Canonical valid MCP request body ───────────────────────────────────────── + +VALID_MCP_DEFINITION = { + "schema_version": 1, + "type": "mcp", + "config": { + "transport": "streamable_http", + "url": "https://x/mcp", + "credential_uuid": None, + "tools_filter": [], + }, +} + + +# ── Part A regression: CreateToolRequest / UpdateToolRequest validation ─────── + + +def test_create_tool_request_accepts_mcp_definition(): + """CreateToolRequest must accept an MCP definition (was HTTP 422 before fix).""" + req = CreateToolRequest( + name="My MCP Tool", + description="Integration via MCP", + category="mcp", + definition=VALID_MCP_DEFINITION, + ) + assert isinstance(req.definition, McpToolDefinition) + assert req.definition.type == "mcp" + assert req.definition.config.url == "https://x/mcp" + assert req.definition.config.transport == "streamable_http" + assert req.definition.config.credential_uuid is None + assert req.definition.config.tools_filter == [] + assert req.definition.config.timeout_secs == 30 + assert req.definition.config.sse_read_timeout_secs == 300 + + +def test_update_tool_request_accepts_mcp_definition(): + """UpdateToolRequest must also accept an MCP definition.""" + req = UpdateToolRequest( + name="Updated MCP Tool", + definition=VALID_MCP_DEFINITION, + ) + assert isinstance(req.definition, McpToolDefinition) + assert req.definition.type == "mcp" + assert req.definition.config.url == "https://x/mcp" + + +def test_create_tool_request_accepts_mcp_with_all_fields(): + """All optional MCP config fields are accepted and preserved.""" + req = CreateToolRequest( + name="Full MCP Tool", + category="mcp", + definition={ + "schema_version": 1, + "type": "mcp", + "config": { + "transport": "streamable_http", + "url": "https://acme.example.com/mcp", + "credential_uuid": "cred-abc-123", + "tools_filter": ["lookup_patient", "schedule_appointment"], + "timeout_secs": 60, + "sse_read_timeout_secs": 600, + }, + }, + ) + cfg = req.definition.config # type: ignore[union-attr] + assert cfg.url == "https://acme.example.com/mcp" + assert cfg.credential_uuid == "cred-abc-123" + assert cfg.tools_filter == ["lookup_patient", "schedule_appointment"] + assert cfg.timeout_secs == 60 + assert cfg.sse_read_timeout_secs == 600 + + +# ── Invalid bodies are rejected ─────────────────────────────────────────────── + + +@pytest.mark.parametrize( + "definition", + [ + # ftp:// URL — rejected by McpToolConfig.validate_url + { + "schema_version": 1, + "type": "mcp", + "config": {"transport": "streamable_http", "url": "ftp://x/mcp"}, + }, + # Empty url — rejected by McpToolConfig.validate_url + { + "schema_version": 1, + "type": "mcp", + "config": {"transport": "streamable_http", "url": ""}, + }, + # Missing url — rejected by McpToolConfig (required field) + { + "schema_version": 1, + "type": "mcp", + "config": {"transport": "streamable_http"}, + }, + # Unsupported transport — rejected because Literal["streamable_http"] constraint + { + "schema_version": 1, + "type": "mcp", + "config": {"url": "https://x/mcp", "transport": "stdio"}, + }, + ], +) +def test_create_tool_request_rejects_invalid_mcp_definition(definition): + """Invalid MCP definitions must raise ValidationError.""" + with pytest.raises(ValidationError): + CreateToolRequest( + name="Bad MCP Tool", + category="mcp", + definition=definition, + ) + + +# ── Round-trip compatibility: request schema ↔ validate_mcp_definition ─────── + + +def test_mcp_definition_round_trips_through_validate_mcp_definition(): + """The dict produced by CreateToolRequest.definition.model_dump() must be + accepted by validate_mcp_definition without raising, and the result must + contain the expected fields. This proves the request-layer schema and the + call-time validator agree on the stored config shape.""" + req = CreateToolRequest( + name="Round-Trip MCP Tool", + category="mcp", + definition={ + "schema_version": 1, + "type": "mcp", + "config": { + "transport": "streamable_http", + "url": "https://roundtrip.example.com/mcp", + "credential_uuid": "cred-rt-456", + "tools_filter": ["ping"], + "timeout_secs": 45, + "sse_read_timeout_secs": 400, + }, + }, + ) + + # Simulate what the route does: persist definition as a plain dict + persisted = req.definition.model_dump() # type: ignore[union-attr] + + # validate_mcp_definition must accept the persisted shape without raising + normalized = validate_mcp_definition(persisted) + + assert normalized["url"] == "https://roundtrip.example.com/mcp" + assert normalized["transport"] == "streamable_http" + assert normalized["credential_uuid"] == "cred-rt-456" + assert normalized["tools_filter"] == ["ping"] + assert normalized["timeout_secs"] == 45 + assert normalized["sse_read_timeout_secs"] == 400 + + +def test_mcp_definition_round_trip_defaults(): + """Round-trip with minimal body: defaults fill in correctly and + validate_mcp_definition agrees on them.""" + req = CreateToolRequest( + name="Minimal MCP Tool", + category="mcp", + definition=VALID_MCP_DEFINITION, + ) + + persisted = req.definition.model_dump() # type: ignore[union-attr] + normalized = validate_mcp_definition(persisted) + + assert normalized["transport"] == "streamable_http" + assert normalized["tools_filter"] == [] + assert normalized["timeout_secs"] == 30 + assert normalized["sse_read_timeout_secs"] == 300 + assert normalized["credential_uuid"] is None + # Part B: auth_header / auth_scheme must NOT be present in the normalized + # config dict (they were dead config removed in the fix) + assert "auth_header" not in normalized + assert "auth_scheme" not in normalized + + +# ── Full HTTP round-trip via ASGI test client ───────────────────────────────── + + +async def test_post_tool_mcp_returns_200(test_client_factory, db_session): + """POST /api/v1/tools/ with an MCP definition must return HTTP 200 and + persist the definition with type='mcp'. Before Part A this always + returned 422.""" + # Create a user and an organization, then link them so the route's + # selected_organization_id check passes. + user, _ = await db_session.get_or_create_user_by_provider_id("mcp_route_test_user") + org, _ = await db_session.get_or_create_organization_by_provider_id( + "mcp_route_test_org", user.id + ) + await db_session.update_user_selected_organization(user.id, org.id) + # Reload the user so selected_organization_id is populated on the object. + user = await db_session.get_user_by_id(user.id) + + async with test_client_factory(user) as client: + response = await client.post( + "/api/v1/tools/", + json={ + "name": "HTTP Round-Trip MCP Tool", + "description": "Testing the full route", + "category": "mcp", + "definition": { + "schema_version": 1, + "type": "mcp", + "config": { + "transport": "streamable_http", + "url": "https://roundtrip.example.com/mcp", + "credential_uuid": None, + "tools_filter": [], + }, + }, + }, + ) + + assert response.status_code == 200, ( + f"Expected 200, got {response.status_code}: {response.text}" + ) + body = response.json() + assert body["definition"]["type"] == "mcp" + assert body["definition"]["config"]["url"] == "https://roundtrip.example.com/mcp" + assert body["category"] == "mcp" + + +async def test_post_tool_mcp_invalid_url_returns_422(test_client_factory, db_session): + """POST /api/v1/tools/ with an ftp:// URL must return HTTP 422.""" + user, _ = await db_session.get_or_create_user_by_provider_id( + "mcp_route_test_user_422" + ) + org, _ = await db_session.get_or_create_organization_by_provider_id( + "mcp_route_test_org_422", user.id + ) + await db_session.update_user_selected_organization(user.id, org.id) + user = await db_session.get_user_by_id(user.id) + + async with test_client_factory(user) as client: + response = await client.post( + "/api/v1/tools/", + json={ + "name": "Bad MCP Tool", + "category": "mcp", + "definition": { + "schema_version": 1, + "type": "mcp", + "config": { + "transport": "streamable_http", + "url": "ftp://invalid.example.com/mcp", + }, + }, + }, + ) + + assert response.status_code == 422 + + +# ── Task 6: discovered_tools field and _populate_discovered_tools helper ────── + +from unittest.mock import AsyncMock, MagicMock + +from api.routes.tool import McpToolConfig, _populate_discovered_tools + + +def test_mcp_config_accepts_discovered_tools(): + cfg = McpToolConfig( + url="https://x/mcp", + discovered_tools=[{"name": "echo", "description": "Echo"}], + ) + assert cfg.discovered_tools == [{"name": "echo", "description": "Echo"}] + # Defaults to [] when omitted + assert McpToolConfig(url="https://x/mcp").discovered_tools == [] + + +@pytest.mark.asyncio +async def test_populate_discovered_tools_overwrites_cache(monkeypatch): + import api.routes.tool as tool_mod + + monkeypatch.setattr( + tool_mod, + "discover_mcp_tools", + AsyncMock(return_value=[{"name": "echo", "description": "Echo"}]), + ) + definition = { + "schema_version": 1, + "type": "mcp", + "config": { + "url": "https://x/mcp", + "tools_filter": [], + "discovered_tools": [{"name": "stale", "description": "old"}], + }, + } + out = await _populate_discovered_tools(definition, organization_id=1) + assert out["config"]["discovered_tools"] == [ + {"name": "echo", "description": "Echo"} + ] + + +@pytest.mark.asyncio +async def test_populate_discovered_tools_non_mcp_is_noop(): + definition = {"schema_version": 1, "type": "http_api", "config": {}} + out = await _populate_discovered_tools(definition, organization_id=1) + assert out == definition # untouched + + +@pytest.mark.asyncio +async def test_populate_discovered_tools_server_down_sets_empty(monkeypatch): + import api.routes.tool as tool_mod + + monkeypatch.setattr( + tool_mod, + "discover_mcp_tools", + AsyncMock(side_effect=RuntimeError("connection refused")), + ) + definition = { + "schema_version": 1, + "type": "mcp", + "config": {"url": "https://x/mcp", "tools_filter": []}, + } + out = await _populate_discovered_tools(definition, organization_id=1) + assert out["config"]["discovered_tools"] == [] + + +# ── Task 7: POST /{tool_uuid}/mcp/refresh ───────────────────────────────────── + +from fastapi import HTTPException + +from api.routes.tool import refresh_mcp_tools + + +def _fake_user(org_id=1): + u = MagicMock() + u.selected_organization_id = org_id + u.id = 1 + u.provider_id = "p1" + return u + + +def _mcp_tool_model(org_id=1): + t = MagicMock() + t.tool_uuid = "tu-mcp" + t.name = "Mock MCP" + t.category = "mcp" + t.definition = { + "schema_version": 1, + "type": "mcp", + "config": {"url": "https://x/mcp", "tools_filter": []}, + } + return t + + +@pytest.mark.asyncio +async def test_refresh_success(monkeypatch): + import api.routes.tool as tool_mod + + tool = _mcp_tool_model() + monkeypatch.setattr( + tool_mod.db_client, "get_tool_by_uuid", AsyncMock(return_value=tool) + ) + monkeypatch.setattr( + tool_mod.db_client, + "update_tool", + AsyncMock(return_value=tool), + ) + monkeypatch.setattr( + tool_mod, + "discover_mcp_tools", + AsyncMock(return_value=[{"name": "echo", "description": "Echo"}]), + ) + resp = await refresh_mcp_tools("tu-mcp", user=_fake_user()) + assert resp.discovered_tools == [{"name": "echo", "description": "Echo"}] + assert resp.error is None + + +@pytest.mark.asyncio +async def test_refresh_server_down_returns_200_with_error(monkeypatch): + import api.routes.tool as tool_mod + + tool = _mcp_tool_model() + monkeypatch.setattr( + tool_mod.db_client, "get_tool_by_uuid", AsyncMock(return_value=tool) + ) + monkeypatch.setattr(tool_mod.db_client, "update_tool", AsyncMock(return_value=tool)) + monkeypatch.setattr(tool_mod, "discover_mcp_tools", AsyncMock(return_value=[])) + resp = await refresh_mcp_tools("tu-mcp", user=_fake_user()) + assert resp.discovered_tools == [] + assert resp.error # non-empty human-readable message + # update_tool should NOT be called when discovery returns empty + tool_mod.db_client.update_tool.assert_not_called() + + +@pytest.mark.asyncio +async def test_refresh_non_mcp_is_400(monkeypatch): + import api.routes.tool as tool_mod + + tool = _mcp_tool_model() + tool.category = "http_api" + monkeypatch.setattr( + tool_mod.db_client, "get_tool_by_uuid", AsyncMock(return_value=tool) + ) + with pytest.raises(HTTPException) as ei: + await refresh_mcp_tools("tu-mcp", user=_fake_user()) + assert ei.value.status_code == 400 + + +@pytest.mark.asyncio +async def test_refresh_not_found_is_404(monkeypatch): + import api.routes.tool as tool_mod + + monkeypatch.setattr( + tool_mod.db_client, "get_tool_by_uuid", AsyncMock(return_value=None) + ) + with pytest.raises(HTTPException) as ei: + await refresh_mcp_tools("nope", user=_fake_user()) + assert ei.value.status_code == 404 diff --git a/api/tests/test_mcp_tool_session.py b/api/tests/test_mcp_tool_session.py new file mode 100644 index 0000000..eab3d5c --- /dev/null +++ b/api/tests/test_mcp_tool_session.py @@ -0,0 +1,274 @@ +from datetime import timedelta +from unittest.mock import MagicMock + +import httpx +import pytest + +from api.services.workflow.mcp_tool_session import ( + McpToolSession, + build_streamable_http_params, + discover_mcp_tools, +) +from api.tests.support.mcp_mock_server import running_mcp_server + + +@pytest.mark.asyncio +async def test_mock_server_starts_and_serves(): + async with running_mcp_server() as base_url: + async with httpx.AsyncClient() as client: + resp = await client.get(base_url, timeout=5.0) + assert resp.status_code in (400, 404, 405, 406) + + +def test_build_streamable_http_params_with_credential(): + cred = MagicMock() + cred.credential_type = "bearer_token" + cred.credential_data = {"token": "abc"} + params = build_streamable_http_params( + url="https://acme.example.com/mcp", + credential=cred, + timeout_secs=30, + sse_read_timeout_secs=300, + ) + assert params.url == "https://acme.example.com/mcp" + assert params.headers == {"Authorization": "Bearer abc"} + assert params.timeout == timedelta(seconds=30) + assert params.sse_read_timeout == timedelta(seconds=300) + + +def test_build_streamable_http_params_no_credential(): + params = build_streamable_http_params( + url="https://acme.example.com/mcp", + credential=None, + timeout_secs=10, + sse_read_timeout_secs=20, + ) + assert params.headers is None or params.headers == {} + + +@pytest.mark.asyncio +async def test_session_start_passes_auth_header_to_real_server(): + cred = MagicMock() + cred.credential_type = "bearer_token" + cred.credential_data = {"token": "abc"} + + async with running_mcp_server( + required_headers={"Authorization": "Bearer abc"} + ) as base_url: + session = McpToolSession( + tool_uuid="uuid-auth-ok", + tool_name="Secure MCP", + url=base_url, + credential=cred, + tools_filter=[], + timeout_secs=10, + sse_read_timeout_secs=20, + ) + await session.start() + try: + assert session.available is True + names = sorted(s.name for s in session.function_schemas()) + assert names == ["mcp__secure_mcp__add", "mcp__secure_mcp__echo"] + result = await session.call("mcp__secure_mcp__echo", {"text": "hi"}) + assert "echo:hi" in result + finally: + await session.close() + + +@pytest.mark.asyncio +async def test_session_auth_failure_degrades_not_raises(): + async with running_mcp_server( + required_headers={"Authorization": "Bearer abc"} + ) as base_url: + session = McpToolSession( + tool_uuid="uuid-auth-fail", + tool_name="Secure MCP", + url=base_url, + credential=None, + tools_filter=[], + timeout_secs=2, + sse_read_timeout_secs=2, + ) + await session.start() # must degrade instead of raising on 401 + try: + assert session.available is False + assert session.function_schemas() == [] + finally: + await session.close() + + +@pytest.mark.asyncio +async def test_session_start_lists_and_calls_real_server(): + async with running_mcp_server() as base_url: + session = McpToolSession( + tool_uuid="uuid-1234abcd", + tool_name="Acme MCP", + url=base_url, + credential=None, + tools_filter=[], + timeout_secs=10, + sse_read_timeout_secs=20, + ) + await session.start() + try: + assert session.available is True + schemas = session.function_schemas() + names = sorted(s.name for s in schemas) + assert names == ["mcp__acme_mcp__add", "mcp__acme_mcp__echo"] + result = await session.call("mcp__acme_mcp__echo", {"text": "hi"}) + assert "echo:hi" in result + finally: + await session.close() + + +@pytest.mark.asyncio +async def test_session_tools_filter_applied(): + async with running_mcp_server() as base_url: + session = McpToolSession( + tool_uuid="uuid-1234abcd", + tool_name="Acme MCP", + url=base_url, + credential=None, + tools_filter=["echo"], + timeout_secs=10, + sse_read_timeout_secs=20, + ) + await session.start() + try: + names = sorted(s.name for s in session.function_schemas()) + assert names == ["mcp__acme_mcp__echo"] + finally: + await session.close() + + +@pytest.mark.asyncio +async def test_session_unreachable_degrades_not_raises(): + session = McpToolSession( + tool_uuid="uuid-1234abcd", + tool_name="Acme MCP", + url="http://127.0.0.1:1/mcp", + credential=None, + tools_filter=[], + timeout_secs=2, + sse_read_timeout_secs=2, + ) + await session.start() # must NOT raise + assert session.available is False + assert session.function_schemas() == [] + await session.close() + + +@pytest.mark.asyncio +async def test_call_on_unavailable_session_raises(): + session = McpToolSession( + tool_uuid="uuid-1234abcd", + tool_name="Acme MCP", + url="http://127.0.0.1:1/mcp", + credential=None, + tools_filter=[], + timeout_secs=2, + sse_read_timeout_secs=2, + ) + await session.start() + with pytest.raises(RuntimeError): + await session.call("mcp__acme_mcp__echo", {"text": "x"}) + await session.close() + + +@pytest.mark.asyncio +async def test_call_unknown_function_raises(): + async with running_mcp_server() as base_url: + session = McpToolSession( + tool_uuid="uuid-1234abcd", + tool_name="Acme MCP", + url=base_url, + credential=None, + tools_filter=[], + timeout_secs=10, + sse_read_timeout_secs=10, + ) + await session.start() + try: + with pytest.raises(RuntimeError): + await session.call("mcp__acme_mcp__does_not_exist", {}) + finally: + await session.close() + + +@pytest.mark.asyncio +async def test_function_schemas_filter_by_raw_name(): + async with running_mcp_server() as base_url: + session = McpToolSession( + tool_uuid="t-filter", + tool_name="Mock MCP", + url=base_url, + credential=None, + tools_filter=[], + timeout_secs=10, + sse_read_timeout_secs=10, + ) + await session.start() + try: + # No arg = all (backward compatible) + all_names = sorted(s.name for s in session.function_schemas()) + assert all_names == ["mcp__mock_mcp__add", "mcp__mock_mcp__echo"] + + # Allow only raw "echo" + only_echo = session.function_schemas(allowed_raw_names={"echo"}) + assert [s.name for s in only_echo] == ["mcp__mock_mcp__echo"] + + # Empty set = none (default-none semantics) + assert session.function_schemas(allowed_raw_names=set()) == [] + + # Unknown raw name = skipped (pure intersection) + assert session.function_schemas(allowed_raw_names={"nope"}) == [] + finally: + await session.close() + + +@pytest.mark.asyncio +async def test_discover_mcp_tools_success(): + async with running_mcp_server() as base_url: + tools = await discover_mcp_tools( + url=base_url, + credential=None, + timeout_secs=10, + sse_read_timeout_secs=10, + ) + names = sorted(t["name"] for t in tools) + assert names == ["add", "echo"] + by_name = {t["name"]: t for t in tools} + assert by_name["echo"]["description"] # non-empty description + assert set(by_name["echo"]) == {"name", "description"} + + +@pytest.mark.asyncio +async def test_discover_mcp_tools_server_down_returns_empty(): + # Unroutable port, short timeouts: must degrade to [] (never raise). + tools = await discover_mcp_tools( + url="http://127.0.0.1:1/mcp", + credential=None, + timeout_secs=1, + sse_read_timeout_secs=1, + ) + assert tools == [] + + +def test_agent_node_data_carries_mcp_tool_filters(): + from api.services.workflow.dto import AgentNodeData, NodeType + from api.services.workflow.workflow_graph import Node + + data = AgentNodeData( + name="N1", + tool_uuids=["tu-1"], + mcp_tool_filters={"tu-1": ["echo"]}, + ) + assert data.mcp_tool_filters == {"tu-1": ["echo"]} + + node = Node("n1", NodeType.agentNode, data) + assert node.mcp_tool_filters == {"tu-1": ["echo"]} + + # Absent field defaults to None (backward compatible) + data2 = AgentNodeData(name="N2") + assert data2.mcp_tool_filters is None + assert Node("n2", NodeType.agentNode, data2).mcp_tool_filters is None diff --git a/api/tests/test_message_sanitization.py b/api/tests/test_message_sanitization.py new file mode 100644 index 0000000..2d2ef66 --- /dev/null +++ b/api/tests/test_message_sanitization.py @@ -0,0 +1,42 @@ +from __future__ import annotations + +from copy import deepcopy + +from pipecat.utils.context.message_sanitization import ( + strip_thought_from_id, + strip_thought_ids_from_messages, +) + + +def test_strip_thought_from_id(): + assert strip_thought_from_id("call_123__thought__abc") == "call_123" + assert strip_thought_from_id("call_123") == "call_123" + assert strip_thought_from_id(None) is None + + +def test_strip_thought_ids_from_messages_does_not_mutate_input(): + messages = [ + { + "role": "assistant", + "tool_calls": [ + { + "id": "call_1__thought__hidden", + "type": "function", + "function": {"name": "lookup", "arguments": "{}"}, + } + ], + }, + { + "role": "tool", + "tool_call_id": "call_1__thought__hidden", + "content": '{"status":"ok"}', + }, + ] + original = deepcopy(messages) + + cleaned = strip_thought_ids_from_messages(messages) + + assert messages == original + assert cleaned is not messages + assert cleaned[0]["tool_calls"][0]["id"] == "call_1" + assert cleaned[1]["tool_call_id"] == "call_1" diff --git a/api/tests/test_node_specs.py b/api/tests/test_node_specs.py index 110927b..b4797df 100644 --- a/api/tests/test_node_specs.py +++ b/api/tests/test_node_specs.py @@ -14,7 +14,12 @@ import re import pytest -from api.services.workflow.dto import NodeType, ReactFlowDTO +from api.services.workflow.dto import ( + ReactFlowDTO, + all_node_type_names, + get_node_data_model, +) +from api.services.workflow.node_data import BaseNodeData from api.services.workflow.node_specs import ( NodeSpec, PropertySpec, @@ -118,9 +123,9 @@ def test_fixed_collection_has_sub_properties(spec: NodeSpec): @pytest.mark.parametrize("spec", all_specs(), ids=lambda s: s.name) def test_spec_name_matches_dto_discriminator(spec: NodeSpec): - valid_names = {t.value for t in NodeType} + valid_names = all_node_type_names() assert spec.name in valid_names, ( - f"NodeSpec {spec.name!r} doesn't match any NodeType discriminator. " + f"NodeSpec {spec.name!r} doesn't match any registered node type. " f"Valid: {sorted(valid_names)}" ) @@ -187,10 +192,226 @@ def test_examples_validate_against_dto(spec: NodeSpec): def test_all_dto_types_have_specs(): - """Every NodeType discriminator value must have a registered NodeSpec — - catches the case where someone adds a new node type to dto.py but - forgets to author a spec.""" + """Every registered node type must have a registered NodeSpec.""" spec_names = {s.name for s in all_specs()} - type_values = {t.value for t in NodeType} + type_values = all_node_type_names() missing = type_values - spec_names - assert not missing, f"NodeType discriminators without specs: {sorted(missing)}" + assert not missing, f"Registered node types without specs: {sorted(missing)}" + + +def test_all_registered_node_models_inherit_base_node_data(): + for type_name in sorted(all_node_type_names()): + data_model = get_node_data_model(type_name) + assert data_model is not None, f"{type_name}: missing node data model" + assert issubclass(data_model, BaseNodeData), ( + f"{type_name}: node data model must inherit BaseNodeData" + ) + + +@pytest.mark.parametrize( + ("spec_name", "expected_order"), + [ + ( + "startCall", + [ + "name", + "greeting_type", + "greeting", + "greeting_recording_id", + "prompt", + "allow_interrupt", + "add_global_prompt", + "delayed_start", + "delayed_start_duration", + "extraction_enabled", + "extraction_prompt", + "extraction_variables", + "tool_uuids", + "document_uuids", + "pre_call_fetch_enabled", + "pre_call_fetch_url", + "pre_call_fetch_credential_uuid", + ], + ), + ( + "agentNode", + [ + "name", + "prompt", + "allow_interrupt", + "add_global_prompt", + "extraction_enabled", + "extraction_prompt", + "extraction_variables", + "tool_uuids", + "document_uuids", + ], + ), + ( + "endCall", + [ + "name", + "prompt", + "add_global_prompt", + "extraction_enabled", + "extraction_prompt", + "extraction_variables", + ], + ), + ("globalNode", ["name", "prompt"]), + ("trigger", ["name", "enabled", "trigger_path"]), + ( + "webhook", + [ + "name", + "enabled", + "http_method", + "endpoint_url", + "credential_uuid", + "custom_headers", + "payload_template", + ], + ), + ( + "qa", + [ + "name", + "qa_enabled", + "qa_system_prompt", + "qa_min_call_duration", + "qa_voicemail_calls", + "qa_sample_rate", + "qa_use_workflow_llm", + "qa_provider", + "qa_model", + "qa_api_key", + "qa_endpoint", + ], + ), + ( + "tuner", + [ + "name", + "tuner_enabled", + "tuner_agent_id", + "tuner_workspace_id", + "tuner_api_key", + ], + ), + ], +) +def test_node_spec_property_order_stable(spec_name: str, expected_order: list[str]): + spec = next(spec for spec in all_specs() if spec.name == spec_name) + assert [prop.name for prop in spec.properties] == expected_order + + +# ───────────────────────────────────────────────────────────────────────── +# `to_mcp_dict` projection — the lean view served by the `get_node_type` +# MCP tool. UI-only metadata is dropped so it doesn't poison LLM context; +# the full spec stays available to the frontend and SDK via other paths. +# ───────────────────────────────────────────────────────────────────────── + +# Keys that are UI-rendering concerns and must never reach the LLM view, at +# either the node or property level. +_UI_ONLY_KEYS = frozenset( + { + "display_name", + "icon", + "category", + "version", + "placeholder", + "display_options", + "editor", + "extra", + "label", # PropertyOption display string + } +) + + +def _walk_dicts(node): + """Yield every dict nested anywhere inside a projected structure.""" + if isinstance(node, dict): + yield node + for value in node.values(): + yield from _walk_dicts(value) + elif isinstance(node, list): + for item in node: + yield from _walk_dicts(item) + + +@pytest.mark.parametrize("spec", all_specs(), ids=lambda s: s.name) +def test_to_mcp_dict_drops_ui_only_keys(spec: NodeSpec): + projected = spec.to_mcp_dict() + for d in _walk_dicts(projected): + leaked = _UI_ONLY_KEYS & d.keys() + assert not leaked, f"{spec.name}: UI-only keys leaked into LLM view: {leaked}" + + +@pytest.mark.parametrize("spec", all_specs(), ids=lambda s: s.name) +def test_to_mcp_dict_omits_null_and_empty(spec: NodeSpec): + """The lean view never emits null values — absent means unset/optional, + which is what halves the noise versus the full model dump.""" + for d in _walk_dicts(spec.to_mcp_dict()): + for key, value in d.items(): + assert value is not None, f"{spec.name}: {key!r} emitted as null" + + +@pytest.mark.parametrize("spec", all_specs(), ids=lambda s: s.name) +def test_to_mcp_dict_keeps_property_essentials(spec: NodeSpec): + """Every property in the LLM view carries the minimum an LLM needs to + author a value: machine name, type, and a description.""" + + def _check(props: list[dict]): + for prop in props: + assert prop.get("name"), f"{spec.name}: property missing name" + assert prop.get("type"), f"{spec.name}.{prop.get('name')}: missing type" + assert prop.get("description"), ( + f"{spec.name}.{prop.get('name')}: missing description" + ) + if prop.get("properties"): + _check(prop["properties"]) + + _check(spec.to_mcp_dict()["properties"]) + + +def test_to_mcp_dict_retains_authoring_signal_startcall(): + """startCall is the richest core node — lock in that the projection + keeps the fields an LLM actually authors against while shedding the rest.""" + spec = next(s for s in all_specs() if s.name == "startCall") + projected = spec.to_mcp_dict() + + assert set(projected) == { + "name", + "description", + "llm_hint", + "properties", + "examples", + "graph_constraints", + } + + props = {p["name"]: p for p in projected["properties"]} + + # Required field keeps `required`; optional fields omit it. + assert props["prompt"]["required"] is True + assert "required" not in props["greeting"] + + # Enum options project to bare values, dropping the UI label. + assert props["greeting_type"]["options"] == [{"value": "text"}, {"value": "audio"}] + + # Validation bounds survive (they constrain valid authored values). + assert props["delayed_start_duration"]["min_value"] == 0.1 + assert props["delayed_start_duration"]["max_value"] == 10.0 + + # llm_hint survives where present (catalog-tool references). + assert "list_recordings" in props["greeting_recording_id"]["llm_hint"] + + # fixed_collection rows recurse through the same projection. + var_rows = {p["name"]: p for p in props["extraction_variables"]["properties"]} + assert var_rows["type"]["options"] == [ + {"value": "string"}, + {"value": "number"}, + {"value": "boolean"}, + ] + + # graph_constraints drops its null sub-fields. + assert projected["graph_constraints"] == {"min_incoming": 0, "max_incoming": 0} diff --git a/api/tests/test_pipecat_engine_end_call.py b/api/tests/test_pipecat_engine_end_call.py index 2ba4570..523ad54 100644 --- a/api/tests/test_pipecat_engine_end_call.py +++ b/api/tests/test_pipecat_engine_end_call.py @@ -45,12 +45,11 @@ from api.enums import ToolCategory from api.services.workflow.dto import ( EdgeDataDTO, EndCallNodeData, - EndCallRFNode, Position, ReactFlowDTO, RFEdgeDTO, + RFNodeDTO, StartCallNodeData, - StartCallRFNode, ) from api.services.workflow.pipecat_engine import PipecatEngine from api.services.workflow.pipecat_engine_custom_tools import CustomToolManager @@ -1014,8 +1013,9 @@ class TestEndCallExtractionBehavior: # Create a workflow where start node has NO extraction dto = ReactFlowDTO( nodes=[ - StartCallRFNode( + RFNodeDTO( id="start", + type="startCall", position=Position(x=0, y=0), data=StartCallNodeData( name="Start Call", @@ -1026,8 +1026,9 @@ class TestEndCallExtractionBehavior: extraction_enabled=False, # No extraction ), ), - EndCallRFNode( + RFNodeDTO( id="end", + type="endCall", position=Position(x=0, y=200), data=EndCallNodeData( name="End Call", diff --git a/api/tests/test_text_and_audio_playback.py b/api/tests/test_text_and_audio_playback.py index 57a401d..7460c10 100644 --- a/api/tests/test_text_and_audio_playback.py +++ b/api/tests/test_text_and_audio_playback.py @@ -34,12 +34,11 @@ from api.services.pipecat.recording_audio_cache import RecordingAudio from api.services.workflow.dto import ( EdgeDataDTO, EndCallNodeData, - EndCallRFNode, Position, ReactFlowDTO, RFEdgeDTO, + RFNodeDTO, StartCallNodeData, - StartCallRFNode, ) from api.services.workflow.pipecat_engine import PipecatEngine from api.services.workflow.pipecat_engine_custom_tools import CustomToolManager @@ -65,8 +64,9 @@ def text_workflow() -> WorkflowGraph: """Start->End workflow with text greeting and text transition speech.""" dto = ReactFlowDTO( nodes=[ - StartCallRFNode( + RFNodeDTO( id="start", + type="startCall", position=Position(x=0, y=0), data=StartCallNodeData( name="Start Call", @@ -79,8 +79,9 @@ def text_workflow() -> WorkflowGraph: extraction_enabled=False, ), ), - EndCallRFNode( + RFNodeDTO( id="end", + type="endCall", position=Position(x=0, y=200), data=EndCallNodeData( name="End Call", @@ -114,8 +115,9 @@ def audio_workflow() -> WorkflowGraph: """Start->End workflow with audio greeting and audio transition speech.""" dto = ReactFlowDTO( nodes=[ - StartCallRFNode( + RFNodeDTO( id="start", + type="startCall", position=Position(x=0, y=0), data=StartCallNodeData( name="Start Call", @@ -128,8 +130,9 @@ def audio_workflow() -> WorkflowGraph: extraction_enabled=False, ), ), - EndCallRFNode( + RFNodeDTO( id="end", + type="endCall", position=Position(x=0, y=200), data=EndCallNodeData( name="End Call", @@ -290,8 +293,9 @@ class TestStartGreeting: """No greeting configured should return None.""" dto = ReactFlowDTO( nodes=[ - StartCallRFNode( + RFNodeDTO( id="start", + type="startCall", position=Position(x=0, y=0), data=StartCallNodeData( name="Start", @@ -301,8 +305,9 @@ class TestStartGreeting: extraction_enabled=False, ), ), - EndCallRFNode( + RFNodeDTO( id="end", + type="endCall", position=Position(x=0, y=200), data=EndCallNodeData( name="End", @@ -333,8 +338,9 @@ class TestStartGreeting: """Text greeting with {{variable}} placeholders should be rendered.""" dto = ReactFlowDTO( nodes=[ - StartCallRFNode( + RFNodeDTO( id="start", + type="startCall", position=Position(x=0, y=0), data=StartCallNodeData( name="Start", @@ -346,8 +352,9 @@ class TestStartGreeting: extraction_enabled=False, ), ), - EndCallRFNode( + RFNodeDTO( id="end", + type="endCall", position=Position(x=0, y=200), data=EndCallNodeData( name="End", diff --git a/api/tests/test_workflow_qa_masking.py b/api/tests/test_workflow_qa_masking.py index 1377ab7..e1a1ac7 100644 --- a/api/tests/test_workflow_qa_masking.py +++ b/api/tests/test_workflow_qa_masking.py @@ -18,6 +18,25 @@ def _qa_node(node_id="qa-1", api_key="", **extra_data): return {"id": node_id, "type": "qa", "position": {"x": 0, "y": 0}, "data": data} +def _tuner_node(node_id="tuner-1", api_key="", **extra_data): + """Helper to build a Tuner node.""" + data = { + "name": "Tuner", + "tuner_enabled": True, + "tuner_agent_id": "sales-bot", + "tuner_workspace_id": 7, + **extra_data, + } + if api_key: + data["tuner_api_key"] = api_key + return { + "id": node_id, + "type": "tuner", + "position": {"x": 0, "y": 0}, + "data": data, + } + + def _agent_node(node_id="agent-1"): """Helper to build a non-QA node.""" return { @@ -66,6 +85,19 @@ class TestMaskWorkflowDefinition: assert "qa_api_key" not in masked["nodes"][0]["data"] assert masked["nodes"][1]["data"]["qa_api_key"] == mask_key("sk-secret1234") + def test_masks_tuner_api_key(self): + """Tuner node api_key is masked, showing only last 4 chars.""" + real_key = "tuner_live_abcdefghijklmnop" + wf = _make_workflow_def([_tuner_node(api_key=real_key)]) + + masked = mask_workflow_definition(wf) + + masked_key = masked["nodes"][0]["data"]["tuner_api_key"] + assert masked_key == mask_key(real_key) + assert masked_key.endswith("mnop") + assert masked_key.startswith("*") + assert real_key not in str(masked) + def test_qa_node_without_api_key(self): """QA node with no api_key is left as-is.""" wf = _make_workflow_def([_qa_node()]) @@ -154,6 +186,16 @@ class TestMergeWorkflowApiKeys: assert result["nodes"][0]["data"]["qa_api_key"] == new_key + def test_masked_tuner_key_is_restored(self): + """Masked Tuner keys round-trip without losing the stored secret.""" + real_key = "tuner_live_abcdefghijklmnop" + existing = _make_workflow_def([_tuner_node(api_key=real_key)]) + incoming = _make_workflow_def([_tuner_node(api_key=mask_key(real_key))]) + + result = merge_workflow_api_keys(incoming, existing) + + assert result["nodes"][0]["data"]["tuner_api_key"] == real_key + def test_no_incoming_api_key(self): """QA node without api_key in incoming is left alone.""" existing = _make_workflow_def([_qa_node(api_key="sk-existing-key1")]) diff --git a/docs/AGENTS.md b/docs/AGENTS.md new file mode 100644 index 0000000..2daec40 --- /dev/null +++ b/docs/AGENTS.md @@ -0,0 +1,53 @@ +# Mintlify documentation + +## Working relationship + +- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so +- ALWAYS ask for clarification rather than making assumptions +- NEVER lie, guess, or make up information + +## Project context + +- Format: MDX files with YAML frontmatter +- Config: docs.json for navigation, theme, settings +- Components: Mintlify components + +## Content strategy + +- Document just enough for user success - not too much, not too little +- Prioritize accuracy and usability of information +- Make content evergreen when possible +- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason +- Check existing patterns for consistency +- Start by making the smallest reasonable changes + +## Frontmatter requirements for pages + +- title: Clear, descriptive page title +- description: Concise summary for SEO/navigation + +## Writing standards + +- Second-person voice ("you") +- Prerequisites at start of procedural content +- Test all code examples before publishing +- Match style and formatting of existing pages +- Include both basic and advanced use cases +- Language tags on all code blocks +- Alt text on all images +- Relative paths for internal links + +## Git workflow + +- NEVER use --no-verify when committing +- Ask how to handle uncommitted changes before starting +- Create a new branch when no clear branch exists for changes +- Commit frequently throughout development +- NEVER skip or disable pre-commit hooks + +## Do not + +- Skip frontmatter on any MDX file +- Use absolute URLs for internal links +- Include untested code examples +- Make assumptions - always ask for clarification diff --git a/docs/CLAUDE.md b/docs/CLAUDE.md index 2daec40..43c994c 100644 --- a/docs/CLAUDE.md +++ b/docs/CLAUDE.md @@ -1,53 +1 @@ -# Mintlify documentation - -## Working relationship - -- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so -- ALWAYS ask for clarification rather than making assumptions -- NEVER lie, guess, or make up information - -## Project context - -- Format: MDX files with YAML frontmatter -- Config: docs.json for navigation, theme, settings -- Components: Mintlify components - -## Content strategy - -- Document just enough for user success - not too much, not too little -- Prioritize accuracy and usability of information -- Make content evergreen when possible -- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason -- Check existing patterns for consistency -- Start by making the smallest reasonable changes - -## Frontmatter requirements for pages - -- title: Clear, descriptive page title -- description: Concise summary for SEO/navigation - -## Writing standards - -- Second-person voice ("you") -- Prerequisites at start of procedural content -- Test all code examples before publishing -- Match style and formatting of existing pages -- Include both basic and advanced use cases -- Language tags on all code blocks -- Alt text on all images -- Relative paths for internal links - -## Git workflow - -- NEVER use --no-verify when committing -- Ask how to handle uncommitted changes before starting -- Create a new branch when no clear branch exists for changes -- Commit frequently throughout development -- NEVER skip or disable pre-commit hooks - -## Do not - -- Skip frontmatter on any MDX file -- Use absolute URLs for internal links -- Include untested code examples -- Make assumptions - always ask for clarification +@AGENTS.md diff --git a/docs/api-reference/openapi.json b/docs/api-reference/openapi.json index 424437e..762a8a1 100644 --- a/docs/api-reference/openapi.json +++ b/docs/api-reference/openapi.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Dograh API","description":"API for the Dograh app","version":"1.0.0"},"servers":[{"url":"https://app.dograh.com","description":"Production"},{"url":"http://localhost:8000","description":"Local development"}],"paths":{"/api/v1/telephony/initiate-call":{"post":{"tags":["main"],"summary":"Initiate Call","description":"Initiate a call using the configured telephony provider from web browser. This is\nsupposed to be a test call method for the draft version of the agent.","operationId":"initiate_call_api_v1_telephony_initiate_call_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateCallRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"test_phone_call","x-sdk-description":"Place a test call from a workflow to a phone number."}},"/api/v1/telephony/inbound/run":{"post":{"tags":["main"],"summary":"Handle Inbound Run","description":"Workflow-agnostic inbound dispatcher.\n\nAll providers can point a single webhook at this endpoint instead of one\nURL per workflow. The dispatcher resolves the org from the webhook's\naccount_id and the workflow from the called number's\n``inbound_workflow_id``. This is what ``configure_inbound`` writes into\neach provider's resource so per-workflow webhook bookkeeping disappears.\n\nProvider-specific signature/timestamp headers are not enumerated here \u2014\neach provider's ``verify_inbound_signature`` reads its own headers from\nthe dict, so adding a new provider doesn't require changes to this route.","operationId":"handle_inbound_run_api_v1_telephony_inbound_run_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"}}}},"/api/v1/telephony/inbound/fallback":{"post":{"tags":["main"],"summary":"Handle Inbound Fallback","description":"Fallback endpoint that returns audio message when calls cannot be processed.","operationId":"handle_inbound_fallback_api_v1_telephony_inbound_fallback_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"}}}},"/api/v1/telephony/inbound/{workflow_id}":{"post":{"tags":["main"],"summary":"Handle Inbound Telephony","description":"[LEGACY] Per-workflow inbound webhook.\n\nSuperseded by ``POST /inbound/run``, which resolves the workflow from\nthe called number's ``inbound_workflow_id`` and lets a single webhook\nURL serve every workflow in the org. New integrations should point\ntheir provider at ``/inbound/run``; this route is kept only for\nexisting provider configurations that still encode ``workflow_id``\nin the URL.","operationId":"handle_inbound_telephony_api_v1_telephony_inbound__workflow_id__post","deprecated":true,"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/transfer-result/{transfer_id}":{"post":{"tags":["main"],"summary":"Complete Transfer Function Call","description":"Webhook endpoint to complete the function call with transfer result.\n\nCalled by Twilio's StatusCallback when the transfer call status changes.","operationId":"complete_transfer_function_call_api_v1_telephony_transfer_result__transfer_id__post","parameters":[{"name":"transfer_id","in":"path","required":true,"schema":{"type":"string","title":"Transfer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/cloudonix/status-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Cloudonix Status Callback","description":"Handle Cloudonix-specific status callbacks.\n\nCloudonix sends call status updates to the callback URL specified during call initiation.","operationId":"handle_cloudonix_status_callback_api_v1_telephony_cloudonix_status_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/cloudonix/cdr":{"post":{"tags":["main"],"summary":"Handle Cloudonix Cdr","description":"Handle Cloudonix CDR (Call Detail Record) webhooks.\n\nCloudonix sends CDR records when calls complete. The CDR contains:\n- domain: Used to identify the organization\n- call_id: Used to find the workflow run\n- disposition: Call termination status (ANSWER, BUSY, CANCEL, FAILED, CONGESTION, NOANSWER)\n- duration/billsec: Call duration information","operationId":"handle_cloudonix_cdr_api_v1_telephony_cloudonix_cdr_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"}}}},"/api/v1/telephony/plivo/hangup-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Plivo Hangup Callback","description":"Handle Plivo hangup callbacks.","operationId":"handle_plivo_hangup_callback_api_v1_telephony_plivo_hangup_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}},{"name":"x-plivo-signature-v3","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-V3"}},{"name":"x-plivo-signature-ma-v3","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-Ma-V3"}},{"name":"x-plivo-signature-v3-nonce","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-V3-Nonce"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/plivo/ring-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Plivo Ring Callback","description":"Handle Plivo ring callbacks.","operationId":"handle_plivo_ring_callback_api_v1_telephony_plivo_ring_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}},{"name":"x-plivo-signature-v3","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-V3"}},{"name":"x-plivo-signature-ma-v3","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-Ma-V3"}},{"name":"x-plivo-signature-v3-nonce","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-V3-Nonce"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/telnyx/events/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Telnyx Events","description":"Handle Telnyx Call Control webhook events.\n\nTelnyx sends all call lifecycle events (call.initiated, call.answered,\ncall.hangup, streaming.started, streaming.stopped) as JSON POST requests.","operationId":"handle_telnyx_events_api_v1_telephony_telnyx_events__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/telnyx/transfer-result/{transfer_id}":{"post":{"tags":["main"],"summary":"Handle Telnyx Transfer Result","description":"Handle Telnyx Call Control events for the transfer destination leg.\n\nThe destination leg is dialed by :meth:`TelnyxProvider.transfer_call` with\nthis URL as ``webhook_url``. Telnyx sends every event for that leg here.\nOutcomes:\n\n- ``call.answered``: seed a conference with the destination's live\n ``call_control_id``, stamp ``conference_id`` onto the TransferContext,\n and publish ``DESTINATION_ANSWERED`` so ``transfer_call_handler`` can\n end the pipeline. ``TelnyxConferenceStrategy`` then joins the caller\n into this conference at pipeline teardown.\n- ``call.hangup`` pre-answer (no ``conference_id`` on the context):\n publish ``TRANSFER_FAILED`` so the LLM can recover.\n- ``call.hangup`` post-answer (``conference_id`` set): the destination\n left a bridged conference; hang up the caller's leg to tear down the\n empty bridge (Telnyx's create_conference doesn't accept\n ``end_conference_on_exit`` on the seed leg).\n\nEvent references:\n - call.answered: https://developers.telnyx.com/api-reference/callbacks/call-answered\n - call.hangup: https://developers.telnyx.com/api-reference/callbacks/call-hangup","operationId":"handle_telnyx_transfer_result_api_v1_telephony_telnyx_transfer_result__transfer_id__post","parameters":[{"name":"transfer_id","in":"path","required":true,"schema":{"type":"string","title":"Transfer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/twilio/status-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Twilio Status Callback","description":"Handle Twilio-specific status callbacks.","operationId":"handle_twilio_status_callback_api_v1_telephony_twilio_status_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}},{"name":"x-webhook-signature","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Webhook-Signature"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/vobiz/hangup-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Vobiz Hangup Callback","description":"Handle Vobiz hangup callback (sent when call ends).\n\nVobiz sends callbacks to hangup_url when the call terminates.\nThis includes call duration, status, and billing information.","operationId":"handle_vobiz_hangup_callback_api_v1_telephony_vobiz_hangup_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}},{"name":"x-vobiz-signature","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Signature"}},{"name":"x-vobiz-timestamp","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Timestamp"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/vobiz/ring-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Vobiz Ring Callback","description":"Handle Vobiz ring callback (sent when call starts ringing).\n\nVobiz can send callbacks to ring_url when the call starts ringing.\nThis is optional and used for tracking ringing status.","operationId":"handle_vobiz_ring_callback_api_v1_telephony_vobiz_ring_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}},{"name":"x-vobiz-signature","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Signature"}},{"name":"x-vobiz-timestamp","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Timestamp"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/vobiz/hangup-callback/workflow/{workflow_id}":{"post":{"tags":["main"],"summary":"Handle Vobiz Hangup Callback By Workflow","description":"Handle Vobiz hangup callback with workflow_id - finds workflow run by call_id.","operationId":"handle_vobiz_hangup_callback_by_workflow_api_v1_telephony_vobiz_hangup_callback_workflow__workflow_id__post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"x-vobiz-signature","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Signature"}},{"name":"x-vobiz-timestamp","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Timestamp"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/vonage/events/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Vonage Events","description":"Handle Vonage-specific event webhooks.\n\nVonage sends all call events to a single endpoint.\nEvents include: started, ringing, answered, complete, failed, etc.","operationId":"handle_vonage_events_api_v1_telephony_vonage_events__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/superuser/impersonate":{"post":{"tags":["main","superuser"],"summary":"Impersonate","description":"Impersonate a user as a super-admin.\nInternally, Stack Auth requires the **provider user ID** (a UUID-ish string)\nto create an impersonation session.","operationId":"impersonate_api_v1_superuser_impersonate_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpersonateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpersonateResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/superuser/workflow-runs":{"get":{"tags":["main","superuser"],"summary":"Get Workflow Runs","description":"Get paginated list of all workflow runs with organization information.\nRequires superuser privileges.\n\nFilters should be provided as a JSON-encoded array of filter criteria.\nExample: [{\"field\": \"id\", \"type\": \"number\", \"value\": {\"value\": 680}}]","operationId":"get_workflow_runs_api_v1_superuser_workflow_runs_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number (starts from 1)","default":1,"title":"Page"},"description":"Page number (starts from 1)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of items per page","default":50,"title":"Limit"},"description":"Number of items per page"},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded filter criteria","title":"Filters"},"description":"JSON-encoded filter criteria"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Field to sort by (e.g., 'duration', 'created_at')","title":"Sort By"},"description":"Field to sort by (e.g., 'duration', 'created_at')"},{"name":"sort_order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort order ('asc' or 'desc')","default":"desc","title":"Sort Order"},"description":"Sort order ('asc' or 'desc')"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuperuserWorkflowRunsListResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/validate":{"post":{"tags":["main"],"summary":"Validate Workflow","description":"Validate all nodes in a workflow to ensure they have required fields.\n\nArgs:\n workflow_id: The ID of the workflow to validate\n user: The authenticated user\n\nReturns:\n Object indicating if workflow is valid and any invalid nodes/edges","operationId":"validate_workflow_api_v1_workflow__workflow_id__validate_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateWorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/create/definition":{"post":{"tags":["main"],"summary":"Create Workflow","description":"Create a new workflow from the client\n\nArgs:\n request: The create workflow request\n user: The user to create the workflow for","operationId":"create_workflow_api_v1_workflow_create_definition_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"create_workflow","x-sdk-description":"Create a new workflow from a workflow definition."}},"/api/v1/workflow/create/template":{"post":{"tags":["main"],"summary":"Create Workflow From Template","description":"Create a new workflow from a natural language template request.\n\nThis endpoint:\n1. Uses mps_service_key_client to call MPS workflow API\n2. Passes organization ID (authenticated mode) or created_by (OSS mode)\n3. Creates the workflow in the database\n\nArgs:\n request: The template creation request with call_type, use_case, and activity_description\n user: The authenticated user\n\nReturns:\n The created workflow\n\nRaises:\n HTTPException: If MPS API call fails","operationId":"create_workflow_from_template_api_v1_workflow_create_template_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowTemplateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/count":{"get":{"tags":["main"],"summary":"Get Workflow Count","description":"Get workflow counts for the authenticated user's organization.\n\nThis is a lightweight endpoint for checking if the user has workflows,\nuseful for redirect logic without fetching full workflow data.","operationId":"get_workflow_count_api_v1_workflow_count_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCountResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/fetch":{"get":{"tags":["main"],"summary":"Get Workflows","description":"Get all workflows for the authenticated user's organization.\n\nReturns a lightweight response with only essential fields for listing.\nUse GET /workflow/fetch/{workflow_id} to get full workflow details.","operationId":"get_workflows_api_v1_workflow_fetch_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by status - can be single value (active/archived) or comma-separated (active,archived)","title":"Status"},"description":"Filter by status - can be single value (active/archived) or comma-separated (active,archived)"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowListResponse"},"title":"Response Get Workflows Api V1 Workflow Fetch Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_workflows","x-sdk-description":"List all workflows in the authenticated organization."}},"/api/v1/workflow/fetch/{workflow_id}":{"get":{"tags":["main"],"summary":"Get Workflow","description":"Get a single workflow by ID.\n\nIf a draft version exists, returns the draft content for editing.\nOtherwise returns the published version's content.","operationId":"get_workflow_api_v1_workflow_fetch__workflow_id__get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"get_workflow","x-sdk-description":"Get a single workflow by ID (returns draft if one exists, else published)."}},"/api/v1/workflow/{workflow_id}/versions":{"get":{"tags":["main"],"summary":"Get Workflow Versions","description":"List versions for a workflow, newest first.\n\nPass `limit`/`offset` to page through long histories. With no `limit`,\nreturns every version (legacy behavior).","operationId":"get_workflow_versions_api_v1_workflow__workflow_id__versions_get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":100,"minimum":1},{"type":"null"}],"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowVersionResponse"},"title":"Response Get Workflow Versions Api V1 Workflow Workflow Id Versions Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/publish":{"post":{"tags":["main"],"summary":"Publish Workflow","description":"Publish the current draft version of a workflow.\n\nDrafts are allowed to be incomplete (so the editor can save mid-edit),\nbut a published version is what runtime executes \u2014 so this is the gate\nwhere the full DTO + graph + trigger-conflict checks must pass.","operationId":"publish_workflow_api_v1_workflow__workflow_id__publish_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/create-draft":{"post":{"tags":["main"],"summary":"Create Workflow Draft","description":"Create a draft version from the current published version.\n\nIf a draft already exists, returns the existing draft.","operationId":"create_workflow_draft_api_v1_workflow__workflow_id__create_draft_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowVersionResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/summary":{"get":{"tags":["main"],"summary":"Get Workflows Summary","description":"Get minimal workflow information (id and name only) for all workflows","operationId":"get_workflows_summary_api_v1_workflow_summary_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by status (e.g. 'active' or 'archived'). Omit to return all.","title":"Status"},"description":"Filter by status (e.g. 'active' or 'archived'). Omit to return all."},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowSummaryResponse"},"title":"Response Get Workflows Summary Api V1 Workflow Summary Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/status":{"put":{"tags":["main"],"summary":"Update Workflow Status","description":"Update the status of a workflow (e.g., archive/unarchive).\n\nArgs:\n workflow_id: The ID of the workflow to update\n request: The status update request\n\nReturns:\n The updated workflow","operationId":"update_workflow_status_api_v1_workflow__workflow_id__status_put","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkflowStatusRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}":{"put":{"tags":["main"],"summary":"Update Workflow","description":"Update an existing workflow.\n\nArgs:\n workflow_id: The ID of the workflow to update\n request: The update request containing the new name and workflow definition\n\nReturns:\n The updated workflow\n\nRaises:\n HTTPException: If the workflow is not found or if there's a database error","operationId":"update_workflow_api_v1_workflow__workflow_id__put","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkflowRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"update_workflow","x-sdk-description":"Update a workflow's name and/or definition. Saves as a new draft."}},"/api/v1/workflow/{workflow_id}/duplicate":{"post":{"tags":["main"],"summary":"Duplicate Workflow Endpoint","description":"Duplicate a workflow including its definition, configuration, recordings, and triggers.","operationId":"duplicate_workflow_endpoint_api_v1_workflow__workflow_id__duplicate_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/runs":{"post":{"tags":["main"],"summary":"Create Workflow Run","description":"Create a new workflow run when the user decides to execute the workflow via chat or voice\n\nArgs:\n workflow_id: The ID of the workflow to run\n request: The create workflow run request\n user: The user to create the workflow run for","operationId":"create_workflow_run_api_v1_workflow__workflow_id__runs_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowRunRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowRunResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["main"],"summary":"Get Workflow Runs","description":"Get workflow runs with optional filtering and sorting.\n\nFilters should be provided as a JSON-encoded array of filter criteria.\nExample: [{\"attribute\": \"dateRange\", \"value\": {\"from\": \"2024-01-01\", \"to\": \"2024-01-31\"}}]","operationId":"get_workflow_runs_api_v1_workflow__workflow_id__runs_get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded filter criteria","title":"Filters"},"description":"JSON-encoded filter criteria"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Field to sort by (e.g., 'duration', 'created_at')","title":"Sort By"},"description":"Field to sort by (e.g., 'duration', 'created_at')"},{"name":"sort_order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort order ('asc' or 'desc')","default":"desc","title":"Sort Order"},"description":"Sort order ('asc' or 'desc')"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRunsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/runs/{run_id}":{"get":{"tags":["main"],"summary":"Get Workflow Run","operationId":"get_workflow_run_api_v1_workflow__workflow_id__runs__run_id__get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"run_id","in":"path","required":true,"schema":{"type":"integer","title":"Run Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRunResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/report":{"get":{"tags":["main"],"summary":"Download Workflow Report","description":"Download a CSV report of completed runs for a workflow.","operationId":"download_workflow_report_api_v1_workflow__workflow_id__report_get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter runs created on or after this datetime (ISO 8601)","title":"Start Date"},"description":"Filter runs created on or after this datetime (ISO 8601)"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter runs created on or before this datetime (ISO 8601)","title":"End Date"},"description":"Filter runs created on or before this datetime (ISO 8601)"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/templates":{"get":{"tags":["main"],"summary":"Get Workflow Templates","description":"Get all available workflow templates.\n\nReturns:\n List of workflow templates","operationId":"get_workflow_templates_api_v1_workflow_templates_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/WorkflowTemplateResponse"},"type":"array","title":"Response Get Workflow Templates Api V1 Workflow Templates Get"}}}},"404":{"description":"Not found"}}}},"/api/v1/workflow/templates/duplicate":{"post":{"tags":["main"],"summary":"Duplicate Workflow Template","description":"Duplicate a workflow template to create a new workflow for the user.\n\nArgs:\n request: The duplicate template request\n user: The authenticated user\n\nReturns:\n The newly created workflow","operationId":"duplicate_workflow_template_api_v1_workflow_templates_duplicate_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateTemplateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/ambient-noise/upload-url":{"post":{"tags":["main"],"summary":"Get a presigned URL to upload a custom ambient noise audio file","description":"Generate a presigned PUT URL for uploading a custom ambient noise file.","operationId":"get_ambient_noise_upload_url_api_v1_workflow_ambient_noise_upload_url_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmbientNoiseUploadRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmbientNoiseUploadResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/configurations/defaults":{"get":{"tags":["main"],"summary":"Get Default Configurations","operationId":"get_default_configurations_api_v1_user_configurations_defaults_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultConfigurationsResponse"}}}},"404":{"description":"Not found"}}}},"/api/v1/user/auth/user":{"get":{"tags":["main"],"summary":"Get Auth User","operationId":"get_auth_user_api_v1_user_auth_user_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthUserResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/configurations/user":{"get":{"tags":["main"],"summary":"Get User Configurations","operationId":"get_user_configurations_api_v1_user_configurations_user_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserConfigurationRequestResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["main"],"summary":"Update User Configurations","operationId":"update_user_configurations_api_v1_user_configurations_user_put","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserConfigurationRequestResponseSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserConfigurationRequestResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/configurations/user/validate":{"get":{"tags":["main"],"summary":"Validate User Configurations","operationId":"validate_user_configurations_api_v1_user_configurations_user_validate_get","parameters":[{"name":"validity_ttl_seconds","in":"query","required":false,"schema":{"type":"integer","maximum":86400,"minimum":0,"default":60,"title":"Validity Ttl Seconds"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKeyStatusResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/api-keys":{"get":{"tags":["main"],"summary":"Get Api Keys","description":"Get all API keys for the user's selected organization.","operationId":"get_api_keys_api_v1_user_api_keys_get","parameters":[{"name":"include_archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Archived"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIKeyResponse"},"title":"Response Get Api Keys Api V1 User Api Keys Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main"],"summary":"Create Api Key","description":"Create a new API key for the user's selected organization.","operationId":"create_api_key_api_v1_user_api_keys_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIKeyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIKeyResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/api-keys/{api_key_id}":{"delete":{"tags":["main"],"summary":"Archive Api Key","description":"Archive an API key (soft delete).","operationId":"archive_api_key_api_v1_user_api_keys__api_key_id__delete","parameters":[{"name":"api_key_id","in":"path","required":true,"schema":{"type":"integer","title":"Api Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Archive Api Key Api V1 User Api Keys Api Key Id Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/api-keys/{api_key_id}/reactivate":{"put":{"tags":["main"],"summary":"Reactivate Api Key","description":"Reactivate an archived API key.","operationId":"reactivate_api_key_api_v1_user_api_keys__api_key_id__reactivate_put","parameters":[{"name":"api_key_id","in":"path","required":true,"schema":{"type":"integer","title":"Api Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Reactivate Api Key Api V1 User Api Keys Api Key Id Reactivate Put"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/configurations/voices/{provider}":{"get":{"tags":["main"],"summary":"Get Voices","description":"Get available voices for a TTS provider.","operationId":"get_voices_api_v1_user_configurations_voices__provider__get","parameters":[{"name":"provider","in":"path","required":true,"schema":{"enum":["elevenlabs","deepgram","sarvam","cartesia","dograh","rime"],"type":"string","title":"Provider"}},{"name":"model","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"}},{"name":"language","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoicesResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/create":{"post":{"tags":["main"],"summary":"Create Campaign","description":"Create a new campaign","operationId":"create_campaign_api_v1_campaign_create_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/":{"get":{"tags":["main"],"summary":"Get Campaigns","description":"Get campaigns for user's organization","operationId":"get_campaigns_api_v1_campaign__get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}":{"get":{"tags":["main"],"summary":"Get Campaign","description":"Get campaign details","operationId":"get_campaign_api_v1_campaign__campaign_id__get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["main"],"summary":"Update Campaign","description":"Update campaign settings (name, retry config, max concurrency, schedule)","operationId":"update_campaign_api_v1_campaign__campaign_id__patch","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/start":{"post":{"tags":["main"],"summary":"Start Campaign","description":"Start campaign execution","operationId":"start_campaign_api_v1_campaign__campaign_id__start_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/pause":{"post":{"tags":["main"],"summary":"Pause Campaign","description":"Pause campaign execution","operationId":"pause_campaign_api_v1_campaign__campaign_id__pause_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/runs":{"get":{"tags":["main"],"summary":"Get Campaign Runs","description":"Get campaign workflow runs with pagination, filters and sorting","operationId":"get_campaign_runs_api_v1_campaign__campaign_id__runs_get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded filter criteria","title":"Filters"},"description":"JSON-encoded filter criteria"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Field to sort by (e.g., 'duration', 'created_at')","title":"Sort By"},"description":"Field to sort by (e.g., 'duration', 'created_at')"},{"name":"sort_order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort order ('asc' or 'desc')","default":"desc","title":"Sort Order"},"description":"Sort order ('asc' or 'desc')"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignRunsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/redial":{"post":{"tags":["main"],"summary":"Redial Campaign","description":"Create a new campaign that re-dials unique subscribers from a completed\ncampaign whose latest call resulted in voicemail, no-answer, or busy.\n\nThe new campaign is created in 'created' state with queued_runs pre-seeded\nfrom the parent's original initial contexts. A campaign can be redialed at\nmost once.","operationId":"redial_campaign_api_v1_campaign__campaign_id__redial_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedialCampaignRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/resume":{"post":{"tags":["main"],"summary":"Resume Campaign","description":"Resume a paused campaign","operationId":"resume_campaign_api_v1_campaign__campaign_id__resume_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/progress":{"get":{"tags":["main"],"summary":"Get Campaign Progress","description":"Get current campaign progress and statistics","operationId":"get_campaign_progress_api_v1_campaign__campaign_id__progress_get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignProgressResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/source-download-url":{"get":{"tags":["main"],"summary":"Get Campaign Source Download Url","description":"Get presigned download URL for campaign CSV source file\n\nOnly works for CSV source type. For Google Sheets, use the source_id directly.\nValidates that the campaign belongs to the user's organization for security.","operationId":"get_campaign_source_download_url_api_v1_campaign__campaign_id__source_download_url_get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignSourceDownloadResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/report":{"get":{"tags":["main"],"summary":"Download Campaign Report","description":"Download a CSV report of completed campaign runs.","operationId":"download_campaign_report_api_v1_campaign__campaign_id__report_get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter runs created on or after this datetime (ISO 8601)","title":"Start Date"},"description":"Filter runs created on or after this datetime (ISO 8601)"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter runs created on or before this datetime (ISO 8601)","title":"End Date"},"description":"Filter runs created on or before this datetime (ISO 8601)"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/credentials/":{"get":{"tags":["main"],"summary":"List Credentials","description":"List all webhook credentials for the user's organization.\n\nReturns:\n List of credentials (without sensitive data)","operationId":"list_credentials_api_v1_credentials__get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CredentialResponse"},"title":"Response List Credentials Api V1 Credentials Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_credentials","x-sdk-description":"List webhook credentials available to the authenticated organization."},"post":{"tags":["main"],"summary":"Create Credential","description":"Create a new webhook credential.\n\nArgs:\n request: The credential creation request\n\nReturns:\n The created credential (without sensitive data)","operationId":"create_credential_api_v1_credentials__post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/credentials/{credential_uuid}":{"get":{"tags":["main"],"summary":"Get Credential","description":"Get a specific webhook credential by UUID.\n\nArgs:\n credential_uuid: The UUID of the credential\n\nReturns:\n The credential (without sensitive data)","operationId":"get_credential_api_v1_credentials__credential_uuid__get","parameters":[{"name":"credential_uuid","in":"path","required":true,"schema":{"type":"string","title":"Credential Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["main"],"summary":"Update Credential","description":"Update a webhook credential.\n\nArgs:\n credential_uuid: The UUID of the credential to update\n request: The update request\n\nReturns:\n The updated credential (without sensitive data)","operationId":"update_credential_api_v1_credentials__credential_uuid__put","parameters":[{"name":"credential_uuid","in":"path","required":true,"schema":{"type":"string","title":"Credential Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCredentialRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main"],"summary":"Delete Credential","description":"Delete (soft delete) a webhook credential.\n\nArgs:\n credential_uuid: The UUID of the credential to delete\n\nReturns:\n Success message","operationId":"delete_credential_api_v1_credentials__credential_uuid__delete","parameters":[{"name":"credential_uuid","in":"path","required":true,"schema":{"type":"string","title":"Credential Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Credential Api V1 Credentials Credential Uuid Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tools/":{"get":{"tags":["main"],"summary":"List Tools","description":"List all tools for the user's organization.\n\nArgs:\n status: Optional filter by status (active, archived, draft)\n category: Optional filter by category (http_api, native, integration)\n\nReturns:\n List of tools","operationId":"list_tools_api_v1_tools__get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ToolResponse"},"title":"Response List Tools Api V1 Tools Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_tools","x-sdk-description":"List tools available to the authenticated organization."},"post":{"tags":["main"],"summary":"Create Tool","description":"Create a new tool.\n\nArgs:\n request: The tool creation request\n\nReturns:\n The created tool","operationId":"create_tool_api_v1_tools__post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateToolRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tools/{tool_uuid}":{"get":{"tags":["main"],"summary":"Get Tool","description":"Get a specific tool by UUID.\n\nArgs:\n tool_uuid: The UUID of the tool\n\nReturns:\n The tool","operationId":"get_tool_api_v1_tools__tool_uuid__get","parameters":[{"name":"tool_uuid","in":"path","required":true,"schema":{"type":"string","title":"Tool Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["main"],"summary":"Update Tool","description":"Update a tool.\n\nArgs:\n tool_uuid: The UUID of the tool to update\n request: The update request\n\nReturns:\n The updated tool","operationId":"update_tool_api_v1_tools__tool_uuid__put","parameters":[{"name":"tool_uuid","in":"path","required":true,"schema":{"type":"string","title":"Tool Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateToolRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main"],"summary":"Delete Tool","description":"Archive (soft delete) a tool.\n\nArgs:\n tool_uuid: The UUID of the tool to delete\n\nReturns:\n Success message","operationId":"delete_tool_api_v1_tools__tool_uuid__delete","parameters":[{"name":"tool_uuid","in":"path","required":true,"schema":{"type":"string","title":"Tool Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Tool Api V1 Tools Tool Uuid Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tools/{tool_uuid}/unarchive":{"post":{"tags":["main"],"summary":"Unarchive Tool","description":"Unarchive a tool (restore from archived state).\n\nArgs:\n tool_uuid: The UUID of the tool to unarchive\n\nReturns:\n The unarchived tool","operationId":"unarchive_tool_api_v1_tools__tool_uuid__unarchive_post","parameters":[{"name":"tool_uuid","in":"path","required":true,"schema":{"type":"string","title":"Tool Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/integration/":{"get":{"tags":["main"],"summary":"Get Integrations","description":"Get all integrations for the user's selected organization.\n\nReturns:\n List of integrations associated with the user's selected organization","operationId":"get_integrations_api_v1_integration__get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationResponse"},"title":"Response Get Integrations Api V1 Integration Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/integration/session":{"post":{"tags":["main"],"summary":"Create Session","description":"Create a Nango session for the user's selected organization.\n\nReturns:\n Session token and ID for the created session","operationId":"create_session_api_v1_integration_session_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/integration/{integration_id}":{"put":{"tags":["main"],"summary":"Update Integration","description":"Update an integration's selected files (for Google Sheets).\n\nArgs:\n integration_id: The ID of the integration to update\n request: The update request containing selected files\n user: The authenticated user\n\nReturns:\n Updated integration details","operationId":"update_integration_api_v1_integration__integration_id__put","parameters":[{"name":"integration_id","in":"path","required":true,"schema":{"type":"integer","title":"Integration Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/integration/{integration_id}/access-token":{"get":{"tags":["main"],"summary":"Get Integration Access Token","description":"Get the latest access token for an integration from Nango.\n\nArgs:\n integration_id: The ID of the integration\n user: The authenticated user\n\nReturns:\n Dict containing access token and expiration info","operationId":"get_integration_access_token_api_v1_integration__integration_id__access_token_get","parameters":[{"name":"integration_id","in":"path","required":true,"schema":{"type":"integer","title":"Integration Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-providers/metadata":{"get":{"tags":["main","organizations"],"summary":"Get Telephony Providers Metadata","description":"Return the list of available telephony providers and their form schemas.\n\nThe UI uses this to render the configuration form generically instead of\nhard-coding fields per provider. Adding a new provider only requires\ndeclaring its ui_metadata in providers//__init__.py.","operationId":"get_telephony_providers_metadata_api_v1_organizations_telephony_providers_metadata_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyProvidersMetadataResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-config-warnings":{"get":{"tags":["main","organizations"],"summary":"Get Telephony Config Warnings","description":"Return aggregated warning counts for the current org's telephony configs.\n\nToday this surfaces only Telnyx configs missing ``webhook_public_key``;\nadditional warning types should be added as new fields on the response.","operationId":"get_telephony_config_warnings_api_v1_organizations_telephony_config_warnings_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigWarningsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs":{"get":{"tags":["main","organizations"],"summary":"List Telephony Configurations","description":"List the org's telephony configurations with phone-number counts.","operationId":"list_telephony_configurations_api_v1_organizations_telephony_configs_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationListResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main","organizations"],"summary":"Create Telephony Configuration","description":"Create a new telephony configuration for the org.","operationId":"create_telephony_configuration_api_v1_organizations_telephony_configs_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationDetail"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs/{config_id}":{"get":{"tags":["main","organizations"],"summary":"Get Telephony Configuration By Id","operationId":"get_telephony_configuration_by_id_api_v1_organizations_telephony_configs__config_id__get","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationDetail"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["main","organizations"],"summary":"Update Telephony Configuration","operationId":"update_telephony_configuration_api_v1_organizations_telephony_configs__config_id__put","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationDetail"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main","organizations"],"summary":"Delete Telephony Configuration","operationId":"delete_telephony_configuration_api_v1_organizations_telephony_configs__config_id__delete","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs/{config_id}/set-default-outbound":{"post":{"tags":["main","organizations"],"summary":"Set Default Outbound","operationId":"set_default_outbound_api_v1_organizations_telephony_configs__config_id__set_default_outbound_post","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationDetail"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs/{config_id}/phone-numbers":{"get":{"tags":["main","organizations"],"summary":"List Phone Numbers","operationId":"list_phone_numbers_api_v1_organizations_telephony_configs__config_id__phone_numbers_get","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberListResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main","organizations"],"summary":"Create Phone Number","operationId":"create_phone_number_api_v1_organizations_telephony_configs__config_id__phone_numbers_post","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}":{"get":{"tags":["main","organizations"],"summary":"Get Phone Number","operationId":"get_phone_number_api_v1_organizations_telephony_configs__config_id__phone_numbers__phone_number_id__get","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"integer","title":"Phone Number Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["main","organizations"],"summary":"Update Phone Number","operationId":"update_phone_number_api_v1_organizations_telephony_configs__config_id__phone_numbers__phone_number_id__put","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"integer","title":"Phone Number Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main","organizations"],"summary":"Delete Phone Number","operationId":"delete_phone_number_api_v1_organizations_telephony_configs__config_id__phone_numbers__phone_number_id__delete","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"integer","title":"Phone Number Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}/set-default-caller":{"post":{"tags":["main","organizations"],"summary":"Set Default Caller Id","operationId":"set_default_caller_id_api_v1_organizations_telephony_configs__config_id__phone_numbers__phone_number_id__set_default_caller_post","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"integer","title":"Phone Number Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-config":{"get":{"tags":["main","organizations"],"summary":"Get Telephony Configuration","description":"Legacy: returns the org's default config in the original per-provider\nresponse shape so the existing single-form UI keeps working. Prefer the\nmulti-config endpoints (``/telephony-configs``) for new clients.","operationId":"get_telephony_configuration_api_v1_organizations_telephony_config_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main","organizations"],"summary":"Save Telephony Configuration","description":"Legacy: upserts the org's default config (and its phone numbers) in the\noriginal payload shape so existing UI clients keep working. Prefer the\nmulti-config + phone-number endpoints for new clients.","operationId":"save_telephony_configuration_api_v1_organizations_telephony_config_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ARIConfigurationRequest"},{"$ref":"#/components/schemas/CloudonixConfigurationRequest"},{"$ref":"#/components/schemas/PlivoConfigurationRequest"},{"$ref":"#/components/schemas/TelnyxConfigurationRequest"},{"$ref":"#/components/schemas/TwilioConfigurationRequest"},{"$ref":"#/components/schemas/VobizConfigurationRequest"},{"$ref":"#/components/schemas/VonageConfigurationRequest"}],"discriminator":{"propertyName":"provider","mapping":{"ari":"#/components/schemas/ARIConfigurationRequest","cloudonix":"#/components/schemas/CloudonixConfigurationRequest","plivo":"#/components/schemas/PlivoConfigurationRequest","telnyx":"#/components/schemas/TelnyxConfigurationRequest","twilio":"#/components/schemas/TwilioConfigurationRequest","vobiz":"#/components/schemas/VobizConfigurationRequest","vonage":"#/components/schemas/VonageConfigurationRequest"}},"title":"Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/langfuse-credentials":{"get":{"tags":["main","organizations"],"summary":"Get Langfuse Credentials","description":"Get Langfuse credentials for the user's organization with masked sensitive fields.","operationId":"get_langfuse_credentials_api_v1_organizations_langfuse_credentials_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LangfuseCredentialsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main","organizations"],"summary":"Save Langfuse Credentials","description":"Save Langfuse credentials for the user's organization.","operationId":"save_langfuse_credentials_api_v1_organizations_langfuse_credentials_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LangfuseCredentialsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main","organizations"],"summary":"Delete Langfuse Credentials","description":"Delete Langfuse credentials for the user's organization.","operationId":"delete_langfuse_credentials_api_v1_organizations_langfuse_credentials_delete","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/campaign-defaults":{"get":{"tags":["main","organizations"],"summary":"Get Campaign Defaults","description":"Get campaign limits for the user's organization.\n\nReturns the organization's concurrent call limit and default retry configuration.","operationId":"get_campaign_defaults_api_v1_organizations_campaign_defaults_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignDefaultsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/s3/signed-url":{"get":{"tags":["main","s3"],"summary":"Generate a signed S3 URL","description":"Return a short-lived signed URL for a file stored on S3 / MinIO.\n\nAccess Control:\n* Keys that embed an organization ID (``{prefix}/{org_id}/...``) are\n authorized by matching the org_id against the requesting user's\n organization.\n* Legacy keys (``recordings/{run_id}.wav``, ``transcripts/{run_id}.txt``)\n are authorized via the workflow run they belong to.\n* Superusers can request any key.","operationId":"get_signed_url_api_v1_s3_signed_url_get","parameters":[{"name":"key","in":"query","required":true,"schema":{"type":"string","description":"S3 object key","title":"Key"},"description":"S3 object key"},{"name":"expires_in","in":"query","required":false,"schema":{"type":"integer","default":3600,"title":"Expires In"}},{"name":"inline","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Inline"}},{"name":"storage_backend","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Storage backend to use (e.g. 'minio', 's3'). When omitted the backend is inferred from the resource.","title":"Storage Backend"},"description":"Storage backend to use (e.g. 'minio', 's3'). When omitted the backend is inferred from the resource."},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/S3SignedUrlResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/s3/file-metadata":{"get":{"tags":["main","s3"],"summary":"Get file metadata for debugging","description":"Get file metadata including creation timestamp for debugging.\n\nAccess Control:\n* Superusers can request any key.\n* Regular users can only request resources belonging to **their** workflow runs.","operationId":"get_file_metadata_api_v1_s3_file_metadata_get","parameters":[{"name":"key","in":"query","required":true,"schema":{"type":"string","description":"S3 object key","title":"Key"},"description":"S3 object key"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileMetadataResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/s3/presigned-upload-url":{"post":{"tags":["main","s3"],"summary":"Generate a presigned URL for direct CSV upload","description":"Generate a presigned PUT URL for direct CSV file upload to S3/MinIO.\n\nThis endpoint enables browser-to-storage uploads without passing through the backend\n\nAccess Control:\n* All authenticated users can upload CSV files scoped to their organization.\n* Files are stored with organization-scoped keys for multi-tenancy.\n\nReturns:\n* upload_url: Presigned URL (valid for 15 minutes) for PUT request\n* file_key: Unique storage key to use as source_id in campaign creation\n* expires_in: URL expiration time in seconds","operationId":"get_presigned_upload_url_api_v1_s3_presigned_upload_url_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresignedUploadUrlRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresignedUploadUrlResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/service-keys":{"get":{"tags":["main"],"summary":"Get Service Keys","description":"Get all service keys for the user's organization.","operationId":"get_service_keys_api_v1_user_service_keys_get","parameters":[{"name":"include_archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Archived"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServiceKeyResponse"},"title":"Response Get Service Keys Api V1 User Service Keys Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main"],"summary":"Create Service Key","description":"Create a new service key for the user's organization.","operationId":"create_service_key_api_v1_user_service_keys_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceKeyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceKeyResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/service-keys/{service_key_id}":{"delete":{"tags":["main"],"summary":"Archive Service Key","description":"Archive a service key.","operationId":"archive_service_key_api_v1_user_service_keys__service_key_id__delete","parameters":[{"name":"service_key_id","in":"path","required":true,"schema":{"type":"string","title":"Service Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/service-keys/{service_key_id}/reactivate":{"put":{"tags":["main"],"summary":"Reactivate Service Key","description":"Reactivate an archived service key.\n\nNote: This endpoint is provided for API compatibility but service key\nreactivation is not supported by MPS. Once archived, a service key\ncannot be reactivated and a new key must be created instead.","operationId":"reactivate_service_key_api_v1_user_service_keys__service_key_id__reactivate_put","parameters":[{"name":"service_key_id","in":"path","required":true,"schema":{"type":"string","title":"Service Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/usage/current-period":{"get":{"tags":["main"],"summary":"Get Current Period Usage","description":"Get current billing period usage for the user's organization.","operationId":"get_current_period_usage_api_v1_organizations_usage_current_period_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentUsageResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/usage/mps-credits":{"get":{"tags":["main"],"summary":"Get Mps Credits","description":"Get aggregated usage and quota from MPS.\n\nOSS users: queries by provider_id (created_by).\nHosted users: queries by organization_id.","operationId":"get_mps_credits_api_v1_organizations_usage_mps_credits_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MPSCreditsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/usage/runs":{"get":{"tags":["main"],"summary":"Get Usage History","description":"Get paginated workflow runs with usage for the organization.","operationId":"get_usage_history_api_v1_organizations_usage_runs_get","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 date-time string (UTC). Lower bound (inclusive) on `created_at`.","examples":["2026-04-01T00:00:00Z"],"title":"Start Date"},"description":"ISO 8601 date-time string (UTC). Lower bound (inclusive) on `created_at`."},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 date-time string (UTC). Upper bound (inclusive) on `created_at`.","examples":["2026-05-01T00:00:00Z"],"title":"End Date"},"description":"ISO 8601 date-time string (UTC). Upper bound (inclusive) on `created_at`."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded array of filter objects. Each object has the shape:\n\n```json\n{ \"attribute\": \"\", \"type\": \"\", \"value\": }\n```\n\nSupported `attribute` / `type` / `value` combinations:\n\n| attribute | type | value shape | matches |\n|-----------------|---------------|----------------------------------------------|------------------------------------------------------|\n| `runId` | `number` | `{ \"value\": 12345 }` | exact run id |\n| `workflowId` | `number` | `{ \"value\": 42 }` | exact agent (workflow) id |\n| `campaignId` | `number` | `{ \"value\": 7 }` | exact campaign id |\n| `callerNumber` | `text` | `{ \"value\": \"415555\" }` | substring match on `initial_context.caller_number` |\n| `calledNumber` | `text` | `{ \"value\": \"9911848\" }` | substring match on `initial_context.called_number` |\n| `dispositionCode` | `multiSelect` | `{ \"codes\": [\"XFER\", \"DNC\"] }` | any of the codes in `gathered_context.mapped_call_disposition` |\n| `duration` | `numberRange` | `{ \"min\": 60, \"max\": 300 }` | call duration (seconds), inclusive bounds |\n\nUnknown attributes and unsupported `type` values are silently ignored.\n\nDate filtering on this endpoint is done via the dedicated `start_date` / `end_date` query params, not via a `dateRange` filter object.\n","examples":["[{\"attribute\":\"callerNumber\",\"type\":\"text\",\"value\":{\"value\":\"415555\"}}]","[{\"attribute\":\"campaignId\",\"type\":\"number\",\"value\":{\"value\":7}},{\"attribute\":\"duration\",\"type\":\"numberRange\",\"value\":{\"min\":60,\"max\":300}}]","[{\"attribute\":\"dispositionCode\",\"type\":\"multiSelect\",\"value\":{\"codes\":[\"XFER\",\"DNC\"]}}]"],"title":"Filters"},"description":"JSON-encoded array of filter objects. Each object has the shape:\n\n```json\n{ \"attribute\": \"\", \"type\": \"\", \"value\": }\n```\n\nSupported `attribute` / `type` / `value` combinations:\n\n| attribute | type | value shape | matches |\n|-----------------|---------------|----------------------------------------------|------------------------------------------------------|\n| `runId` | `number` | `{ \"value\": 12345 }` | exact run id |\n| `workflowId` | `number` | `{ \"value\": 42 }` | exact agent (workflow) id |\n| `campaignId` | `number` | `{ \"value\": 7 }` | exact campaign id |\n| `callerNumber` | `text` | `{ \"value\": \"415555\" }` | substring match on `initial_context.caller_number` |\n| `calledNumber` | `text` | `{ \"value\": \"9911848\" }` | substring match on `initial_context.called_number` |\n| `dispositionCode` | `multiSelect` | `{ \"codes\": [\"XFER\", \"DNC\"] }` | any of the codes in `gathered_context.mapped_call_disposition` |\n| `duration` | `numberRange` | `{ \"min\": 60, \"max\": 300 }` | call duration (seconds), inclusive bounds |\n\nUnknown attributes and unsupported `type` values are silently ignored.\n\nDate filtering on this endpoint is done via the dedicated `start_date` / `end_date` query params, not via a `dateRange` filter object.\n"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageHistoryResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/usage/runs/report":{"get":{"tags":["main"],"summary":"Download Usage Runs Report","description":"Download a CSV of runs matching the same filters as `/usage/runs`.","operationId":"download_usage_runs_report_api_v1_organizations_usage_runs_report_get","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 date-time string (UTC). Lower bound (inclusive) on `created_at`.","title":"Start Date"},"description":"ISO 8601 date-time string (UTC). Lower bound (inclusive) on `created_at`."},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 date-time string (UTC). Upper bound (inclusive) on `created_at`.","title":"End Date"},"description":"ISO 8601 date-time string (UTC). Upper bound (inclusive) on `created_at`."},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded array of filter objects. Each object has the shape:\n\n```json\n{ \"attribute\": \"\", \"type\": \"\", \"value\": }\n```\n\nSupported `attribute` / `type` / `value` combinations:\n\n| attribute | type | value shape | matches |\n|-----------------|---------------|----------------------------------------------|------------------------------------------------------|\n| `runId` | `number` | `{ \"value\": 12345 }` | exact run id |\n| `workflowId` | `number` | `{ \"value\": 42 }` | exact agent (workflow) id |\n| `campaignId` | `number` | `{ \"value\": 7 }` | exact campaign id |\n| `callerNumber` | `text` | `{ \"value\": \"415555\" }` | substring match on `initial_context.caller_number` |\n| `calledNumber` | `text` | `{ \"value\": \"9911848\" }` | substring match on `initial_context.called_number` |\n| `dispositionCode` | `multiSelect` | `{ \"codes\": [\"XFER\", \"DNC\"] }` | any of the codes in `gathered_context.mapped_call_disposition` |\n| `duration` | `numberRange` | `{ \"min\": 60, \"max\": 300 }` | call duration (seconds), inclusive bounds |\n\nUnknown attributes and unsupported `type` values are silently ignored.\n\nDate filtering on this endpoint is done via the dedicated `start_date` / `end_date` query params, not via a `dateRange` filter object.\n","title":"Filters"},"description":"JSON-encoded array of filter objects. Each object has the shape:\n\n```json\n{ \"attribute\": \"\", \"type\": \"\", \"value\": }\n```\n\nSupported `attribute` / `type` / `value` combinations:\n\n| attribute | type | value shape | matches |\n|-----------------|---------------|----------------------------------------------|------------------------------------------------------|\n| `runId` | `number` | `{ \"value\": 12345 }` | exact run id |\n| `workflowId` | `number` | `{ \"value\": 42 }` | exact agent (workflow) id |\n| `campaignId` | `number` | `{ \"value\": 7 }` | exact campaign id |\n| `callerNumber` | `text` | `{ \"value\": \"415555\" }` | substring match on `initial_context.caller_number` |\n| `calledNumber` | `text` | `{ \"value\": \"9911848\" }` | substring match on `initial_context.called_number` |\n| `dispositionCode` | `multiSelect` | `{ \"codes\": [\"XFER\", \"DNC\"] }` | any of the codes in `gathered_context.mapped_call_disposition` |\n| `duration` | `numberRange` | `{ \"min\": 60, \"max\": 300 }` | call duration (seconds), inclusive bounds |\n\nUnknown attributes and unsupported `type` values are silently ignored.\n\nDate filtering on this endpoint is done via the dedicated `start_date` / `end_date` query params, not via a `dateRange` filter object.\n"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/usage/daily-breakdown":{"get":{"tags":["main"],"summary":"Get Daily Usage Breakdown","description":"Get daily usage breakdown for the last N days. Only available for organizations with pricing.","operationId":"get_daily_usage_breakdown_api_v1_organizations_usage_daily_breakdown_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":30,"minimum":1,"description":"Number of days to include","default":7,"title":"Days"},"description":"Number of days to include"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailyUsageBreakdownResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/reports/daily":{"get":{"tags":["main"],"summary":"Get Daily Report","description":"Get daily report for the specified date and timezone.\nIf workflow_id is provided, filters results to that specific workflow.\nIf workflow_id is None, includes all workflows for the organization.","operationId":"get_daily_report_api_v1_organizations_reports_daily_get","parameters":[{"name":"date","in":"query","required":true,"schema":{"type":"string","description":"Date in YYYY-MM-DD format","title":"Date"},"description":"Date in YYYY-MM-DD format"},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA timezone (e.g., 'America/New_York')","title":"Timezone"},"description":"IANA timezone (e.g., 'America/New_York')"},{"name":"workflow_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Optional workflow ID to filter by","title":"Workflow Id"},"description":"Optional workflow ID to filter by"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailyReportResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/reports/workflows":{"get":{"tags":["main"],"summary":"Get Workflow Options","description":"Get all workflows for the user's organization.\nUsed to populate the workflow selector dropdown in the reports page.","operationId":"get_workflow_options_api_v1_organizations_reports_workflows_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowOption"},"title":"Response Get Workflow Options Api V1 Organizations Reports Workflows Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/reports/daily/runs":{"get":{"tags":["main"],"summary":"Get Daily Runs Detail","description":"Get detailed workflow runs for the specified date.\nUsed for CSV export functionality.","operationId":"get_daily_runs_detail_api_v1_organizations_reports_daily_runs_get","parameters":[{"name":"date","in":"query","required":true,"schema":{"type":"string","description":"Date in YYYY-MM-DD format","title":"Date"},"description":"Date in YYYY-MM-DD format"},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA timezone (e.g., 'America/New_York')","title":"Timezone"},"description":"IANA timezone (e.g., 'America/New_York')"},{"name":"workflow_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Optional workflow ID to filter by","title":"Workflow Id"},"description":"Optional workflow ID to filter by"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowRunDetail"},"title":"Response Get Daily Runs Detail Api V1 Organizations Reports Daily Runs Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/turn/credentials":{"get":{"tags":["main","turn"],"summary":"Get Turn Credentials","description":"Get time-limited TURN credentials for WebRTC connections.\n\nThis endpoint generates ephemeral TURN credentials that are:\n- Valid for the configured TTL (default: 24 hours)\n- Cryptographically bound to the user via HMAC\n- Compatible with coturn's use-auth-secret mode\n\nReturns:\n TurnCredentialsResponse with username, password, ttl, and TURN URIs","operationId":"get_turn_credentials_api_v1_turn_credentials_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TurnCredentialsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/public/embed/init":{"post":{"tags":["main"],"summary":"Initialize Embed Session","description":"Initialize an embed session with token validation and domain checking.\n\nThis endpoint:\n1. Validates the embed token\n2. Checks domain whitelist\n3. Creates a workflow run\n4. Generates a temporary session token\n5. Returns configuration for the widget","operationId":"initialize_embed_session_api_v1_public_embed_init_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitEmbedRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitEmbedResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"options":{"tags":["main"],"summary":"Options Init","description":"Handle CORS preflight for init endpoint","operationId":"options_init_api_v1_public_embed_init_options","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"}}}},"/api/v1/public/embed/config/{token}":{"get":{"tags":["main"],"summary":"Get Embed Config","description":"Get embed configuration without creating a session.\n\nThis endpoint is used to fetch widget configuration for display purposes\nwithout actually starting a call session.","operationId":"get_embed_config_api_v1_public_embed_config__token__get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedConfigResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"options":{"tags":["main"],"summary":"Options Config","description":"Handle CORS preflight for config endpoint","operationId":"options_config_api_v1_public_embed_config__token__options","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/public/embed/turn-credentials/{session_token}":{"get":{"tags":["main"],"summary":"Get Public Turn Credentials","description":"Get TURN credentials for an embed session.\n\nThis endpoint allows embedded widgets to obtain TURN server credentials\nfor WebRTC connections without requiring authentication.\n\nArgs:\n session_token: The session token from embed initialization\n\nReturns:\n TurnCredentialsResponse with username, password, ttl, and TURN URIs","operationId":"get_public_turn_credentials_api_v1_public_embed_turn_credentials__session_token__get","parameters":[{"name":"session_token","in":"path","required":true,"schema":{"type":"string","title":"Session Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TurnCredentialsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"options":{"tags":["main"],"summary":"Options Turn Credentials","description":"Handle CORS preflight for TURN credentials endpoint","operationId":"options_turn_credentials_api_v1_public_embed_turn_credentials__session_token__options","parameters":[{"name":"session_token","in":"path","required":true,"schema":{"type":"string","title":"Session Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/public/agent/{uuid}":{"post":{"tags":["main"],"summary":"Initiate Call","description":"Initiate a phone call against the published agent.\n\nExecutes the workflow's currently released definition.","operationId":"initiate_call_api_v1_public_agent__uuid__post","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","title":"Uuid"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCallRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCallResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/public/agent/test/{uuid}":{"post":{"tags":["main"],"summary":"Initiate Call Test","description":"Initiate a phone call against the latest draft of the agent.\n\nUseful for verifying changes before publishing. Falls back to the\npublished definition when no draft exists.","operationId":"initiate_call_test_api_v1_public_agent_test__uuid__post","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","title":"Uuid"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCallRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCallResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/public/download/workflow/{token}/{artifact_type}":{"get":{"tags":["main"],"summary":"Download Workflow Artifact","description":"Download a workflow recording or transcript via public access token.\n\nThis endpoint:\n1. Validates the public access token\n2. Looks up the corresponding workflow run\n3. Generates a signed URL for the requested artifact\n4. Redirects to the signed URL\n\nArgs:\n token: The public access token (UUID format)\n artifact_type: Type of artifact - \"recording\" or \"transcript\"\n inline: If true, sets Content-Disposition to inline for browser preview\n\nReturns:\n RedirectResponse to the signed URL (302 redirect)\n\nRaises:\n HTTPException 404: If token is invalid or artifact not found","operationId":"download_workflow_artifact_api_v1_public_download_workflow__token___artifact_type__get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}},{"name":"artifact_type","in":"path","required":true,"schema":{"enum":["recording","transcript"],"type":"string","title":"Artifact Type"}},{"name":"inline","in":"query","required":false,"schema":{"type":"boolean","description":"Display inline in browser instead of download","default":false,"title":"Inline"},"description":"Display inline in browser instead of download"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/embed-token":{"post":{"tags":["main"],"summary":"Create Or Update Embed Token","description":"Create or update an embed token for a workflow.\nEach workflow can have only one active embed token.","operationId":"create_or_update_embed_token_api_v1_workflow__workflow_id__embed_token_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedTokenRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedTokenResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["main"],"summary":"Get Embed Token","description":"Get the embed token for a workflow if it exists.","operationId":"get_embed_token_api_v1_workflow__workflow_id__embed_token_get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/EmbedTokenResponse"},{"type":"null"}],"title":"Response Get Embed Token Api V1 Workflow Workflow Id Embed Token Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main"],"summary":"Deactivate Embed Token","description":"Deactivate the embed token for a workflow.","operationId":"deactivate_embed_token_api_v1_workflow__workflow_id__embed_token_delete","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Deactivate Embed Token Api V1 Workflow Workflow Id Embed Token Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/knowledge-base/upload-url":{"post":{"tags":["main","knowledge-base"],"summary":"Get presigned URL for document upload","description":"Generate a presigned PUT URL for uploading a document.\n\nThis endpoint:\n1. Generates a unique document UUID for organizing the S3 key\n2. Generates a presigned S3/MinIO URL for uploading the file\n3. Returns the upload URL and document metadata\n\nAfter uploading to the returned URL, call /process-document to create\nthe document record and trigger processing.\n\nAccess Control:\n* All authenticated users can upload documents scoped to their organization.","operationId":"get_upload_url_api_v1_knowledge_base_upload_url_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUploadRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUploadResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/knowledge-base/process-document":{"post":{"tags":["main","knowledge-base"],"summary":"Trigger document processing","description":"Trigger asynchronous processing of an uploaded document.\n\nThis endpoint should be called after successfully uploading a file to the presigned URL.\nIt will:\n1. Create a document record in the database with the specified UUID\n2. Enqueue a background task to process the document (chunking and embedding)\n\nThe document status will be updated from 'pending' -> 'processing' -> 'completed' or 'failed'.\n\nEmbedding:\nUses OpenAI text-embedding-3-small (1536-dimensional embeddings, requires API key configured in Model Configurations).\n\nAccess Control:\n* Users can only process documents in their organization.","operationId":"process_document_api_v1_knowledge_base_process_document_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessDocumentRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/knowledge-base/documents":{"get":{"tags":["main","knowledge-base"],"summary":"List documents","description":"List all documents for the user's organization.\n\nAccess Control:\n* Users can only see documents from their organization.","operationId":"list_documents_api_v1_knowledge_base_documents_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by processing status","title":"Status"},"description":"Filter by processing status"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentListResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_documents","x-sdk-description":"List knowledge base documents available to the authenticated organization."}},"/api/v1/knowledge-base/documents/{document_uuid}":{"get":{"tags":["main","knowledge-base"],"summary":"Get document details","description":"Get details of a specific document.\n\nAccess Control:\n* Users can only access documents from their organization.","operationId":"get_document_api_v1_knowledge_base_documents__document_uuid__get","parameters":[{"name":"document_uuid","in":"path","required":true,"schema":{"type":"string","title":"Document Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main","knowledge-base"],"summary":"Delete document","description":"Soft delete a document and its chunks.\n\nAccess Control:\n* Users can only delete documents from their organization.","operationId":"delete_document_api_v1_knowledge_base_documents__document_uuid__delete","parameters":[{"name":"document_uuid","in":"path","required":true,"schema":{"type":"string","title":"Document Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/knowledge-base/search":{"post":{"tags":["main","knowledge-base"],"summary":"Search for similar chunks","description":"Search for document chunks similar to the query.\n\nThis endpoint uses vector similarity search to find relevant chunks.\nResults are returned without threshold filtering - apply similarity\nthresholds at the application layer after optional reranking.\n\nAccess Control:\n* Users can only search documents from their organization.","operationId":"search_chunks_api_v1_knowledge_base_search_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunkSearchRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunkSearchResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow-recordings/upload-url":{"post":{"tags":["main","workflow-recordings"],"summary":"Get presigned URLs for recording uploads","description":"Generate presigned PUT URLs for uploading one or more audio recordings.","operationId":"get_upload_urls_api_v1_workflow_recordings_upload_url_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRecordingUploadRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRecordingUploadResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow-recordings/":{"post":{"tags":["main","workflow-recordings"],"summary":"Create recording records after upload","description":"Create one or more recording records after audio files have been uploaded.","operationId":"create_recordings_api_v1_workflow_recordings__post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRecordingCreateRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRecordingCreateResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["main","workflow-recordings"],"summary":"List recordings","description":"List recordings for the organization, optionally filtered.","operationId":"list_recordings_api_v1_workflow_recordings__get","parameters":[{"name":"workflow_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by workflow ID","title":"Workflow Id"},"description":"Filter by workflow ID"},{"name":"tts_provider","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by TTS provider","title":"Tts Provider"},"description":"Filter by TTS provider"},{"name":"tts_model","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by TTS model","title":"Tts Model"},"description":"Filter by TTS model"},{"name":"tts_voice_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by TTS voice ID","title":"Tts Voice Id"},"description":"Filter by TTS voice ID"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordingListResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_recordings","x-sdk-description":"List workflow recordings available to the authenticated organization."}},"/api/v1/workflow-recordings/{recording_id}":{"delete":{"tags":["main","workflow-recordings"],"summary":"Delete a recording","description":"Soft delete a recording.","operationId":"delete_recording_api_v1_workflow_recordings__recording_id__delete","parameters":[{"name":"recording_id","in":"path","required":true,"schema":{"type":"string","title":"Recording Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow-recordings/{id}":{"patch":{"tags":["main","workflow-recordings"],"summary":"Update a recording's Recording ID","description":"Update the recording_id (descriptive name) of a recording.","operationId":"update_recording_api_v1_workflow_recordings__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","title":"Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordingUpdateRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordingResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow-recordings/transcribe":{"post":{"tags":["main","workflow-recordings"],"summary":"Transcribe an audio file","description":"Transcribe an uploaded audio file using MPS STT.","operationId":"transcribe_audio_api_v1_workflow_recordings_transcribe_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_transcribe_audio_api_v1_workflow_recordings_transcribe_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/auth/signup":{"post":{"tags":["main","auth"],"summary":"Signup","operationId":"signup_api_v1_auth_signup_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignupRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/auth/login":{"post":{"tags":["main","auth"],"summary":"Login","operationId":"login_api_v1_auth_login_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/auth/me":{"get":{"tags":["main","auth"],"summary":"Get Current User","operationId":"get_current_user_api_v1_auth_me_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/node-types":{"get":{"tags":["main"],"summary":"List Node Types","description":"List every registered NodeSpec.\n\nSDK clients should pin to `spec_version` and warn if the server reports\na higher version than what they were generated against.","operationId":"list_node_types_api_v1_node_types_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeTypesResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_node_types","x-sdk-description":"List every registered node type with its spec. Pinned to spec_version."}},"/api/v1/node-types/{name}":{"get":{"tags":["main"],"summary":"Get Node Type","operationId":"get_node_type_api_v1_node_types__name__get","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeSpec"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"get_node_type","x-sdk-description":"Fetch a single node spec by name."}},"/api/v1/health":{"get":{"tags":["main"],"summary":"Health","operationId":"health_api_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}},"404":{"description":"Not found"}}}}},"components":{"schemas":{"APIKeyResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"key_prefix":{"type":"string","title":"Key Prefix"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"}},"type":"object","required":["id","name","key_prefix","is_active","created_at"],"title":"APIKeyResponse"},"APIKeyStatus":{"properties":{"model":{"type":"string","title":"Model"},"message":{"type":"string","title":"Message"}},"type":"object","required":["model","message"],"title":"APIKeyStatus"},"APIKeyStatusResponse":{"properties":{"status":{"items":{"$ref":"#/components/schemas/APIKeyStatus"},"type":"array","title":"Status"}},"type":"object","required":["status"],"title":"APIKeyStatusResponse"},"ARIConfigurationRequest":{"properties":{"provider":{"type":"string","const":"ari","title":"Provider","default":"ari"},"ari_endpoint":{"type":"string","title":"Ari Endpoint","description":"ARI base URL (e.g., http://asterisk.example.com:8088)"},"app_name":{"type":"string","title":"App Name","description":"Stasis application name registered in Asterisk"},"app_password":{"type":"string","title":"App Password","description":"ARI user password"},"ws_client_name":{"type":"string","title":"Ws Client Name","description":"websocket_client.conf connection name for externalMedia (e.g., dograh_staging)","default":""},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of SIP extensions/numbers for outbound calls (optional)"}},"type":"object","required":["ari_endpoint","app_name","app_password"],"title":"ARIConfigurationRequest","description":"Request schema for Asterisk ARI configuration."},"ARIConfigurationResponse":{"properties":{"provider":{"type":"string","const":"ari","title":"Provider","default":"ari"},"ari_endpoint":{"type":"string","title":"Ari Endpoint"},"app_name":{"type":"string","title":"App Name"},"app_password":{"type":"string","title":"App Password"},"ws_client_name":{"type":"string","title":"Ws Client Name","default":""},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["ari_endpoint","app_name","app_password","from_numbers"],"title":"ARIConfigurationResponse","description":"Response schema for ARI configuration with masked sensitive fields."},"AccessTokenResponse":{"properties":{"access_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Access Token"},"refresh_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Refresh Token"},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expires At"},"connection_id":{"type":"string","title":"Connection Id"}},"type":"object","required":["access_token","refresh_token","expires_at","connection_id"],"title":"AccessTokenResponse"},"AmbientNoiseUploadRequest":{"properties":{"workflow_id":{"type":"integer","title":"Workflow Id"},"filename":{"type":"string","title":"Filename"},"mime_type":{"type":"string","title":"Mime Type","default":"audio/wav"},"file_size":{"type":"integer","maximum":10485760.0,"exclusiveMinimum":0.0,"title":"File Size","description":"Max 10MB"}},"type":"object","required":["workflow_id","filename","file_size"],"title":"AmbientNoiseUploadRequest"},"AmbientNoiseUploadResponse":{"properties":{"upload_url":{"type":"string","title":"Upload Url"},"storage_key":{"type":"string","title":"Storage Key"},"storage_backend":{"type":"string","title":"Storage Backend"}},"type":"object","required":["upload_url","storage_key","storage_backend"],"title":"AmbientNoiseUploadResponse"},"AuthResponse":{"properties":{"token":{"type":"string","title":"Token"},"user":{"$ref":"#/components/schemas/UserResponse"}},"type":"object","required":["token","user"],"title":"AuthResponse"},"AuthUserResponse":{"properties":{"id":{"type":"integer","title":"Id"},"is_superuser":{"type":"boolean","title":"Is Superuser"}},"type":"object","required":["id","is_superuser"],"title":"AuthUserResponse"},"BatchRecordingCreateRequestSchema":{"properties":{"recordings":{"items":{"$ref":"#/components/schemas/RecordingCreateRequestSchema"},"type":"array","maxItems":20,"minItems":1,"title":"Recordings","description":"List of recordings to create"}},"type":"object","required":["recordings"],"title":"BatchRecordingCreateRequestSchema","description":"Request schema for creating one or more recording records after upload."},"BatchRecordingCreateResponseSchema":{"properties":{"recordings":{"items":{"$ref":"#/components/schemas/RecordingResponseSchema"},"type":"array","title":"Recordings","description":"Created recording records"}},"type":"object","required":["recordings"],"title":"BatchRecordingCreateResponseSchema","description":"Response schema for recording creation."},"BatchRecordingUploadRequestSchema":{"properties":{"files":{"items":{"$ref":"#/components/schemas/FileDescriptor"},"type":"array","maxItems":20,"minItems":1,"title":"Files","description":"List of files to upload"}},"type":"object","required":["files"],"title":"BatchRecordingUploadRequestSchema","description":"Request schema for getting presigned upload URLs for one or more files."},"BatchRecordingUploadResponseSchema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/RecordingUploadResponseSchema"},"type":"array","title":"Items","description":"Upload URLs for each file"}},"type":"object","required":["items"],"title":"BatchRecordingUploadResponseSchema","description":"Response schema with presigned upload URLs."},"Body_transcribe_audio_api_v1_workflow_recordings_transcribe_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"language":{"type":"string","title":"Language","default":"en"}},"type":"object","required":["file"],"title":"Body_transcribe_audio_api_v1_workflow_recordings_transcribe_post"},"CalculatorToolDefinition":{"properties":{"schema_version":{"type":"integer","title":"Schema Version","description":"Schema version","default":1},"type":{"type":"string","const":"calculator","title":"Type","description":"Tool type"}},"type":"object","required":["type"],"title":"CalculatorToolDefinition","description":"Tool definition for Calculator tools (no configuration needed)."},"CallDispositionCodes":{"properties":{"disposition_codes":{"items":{"type":"string"},"type":"array","title":"Disposition Codes","default":[]}},"type":"object","title":"CallDispositionCodes"},"CallType":{"type":"string","enum":["inbound","outbound"],"title":"CallType"},"CampaignDefaultsResponse":{"properties":{"concurrent_call_limit":{"type":"integer","title":"Concurrent Call Limit"},"from_numbers_count":{"type":"integer","title":"From Numbers Count"},"default_retry_config":{"$ref":"#/components/schemas/RetryConfigResponse"},"last_campaign_settings":{"anyOf":[{"$ref":"#/components/schemas/LastCampaignSettingsResponse"},{"type":"null"}]}},"type":"object","required":["concurrent_call_limit","from_numbers_count","default_retry_config"],"title":"CampaignDefaultsResponse"},"CampaignLogEntryResponse":{"properties":{"ts":{"type":"string","title":"Ts"},"level":{"type":"string","title":"Level"},"event":{"type":"string","title":"Event"},"message":{"type":"string","title":"Message"},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details"}},"type":"object","required":["ts","level","event","message"],"title":"CampaignLogEntryResponse","description":"A single timestamped entry from the campaign's append-only log.\n\nSurfaced in the UI so operators can see why a campaign moved to\npaused / failed without digging through server logs."},"CampaignProgressResponse":{"properties":{"campaign_id":{"type":"integer","title":"Campaign Id"},"state":{"type":"string","title":"State"},"total_rows":{"type":"integer","title":"Total Rows"},"processed_rows":{"type":"integer","title":"Processed Rows"},"failed_calls":{"type":"integer","title":"Failed Calls"},"progress_percentage":{"type":"number","title":"Progress Percentage"},"source_sync":{"additionalProperties":true,"type":"object","title":"Source Sync"},"rate_limit":{"type":"integer","title":"Rate Limit"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"}},"type":"object","required":["campaign_id","state","total_rows","processed_rows","failed_calls","progress_percentage","source_sync","rate_limit","started_at","completed_at"],"title":"CampaignProgressResponse"},"CampaignResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"workflow_id":{"type":"integer","title":"Workflow Id"},"workflow_name":{"type":"string","title":"Workflow Name"},"state":{"type":"string","title":"State"},"source_type":{"type":"string","title":"Source Type"},"source_id":{"type":"string","title":"Source Id"},"total_rows":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Rows"},"processed_rows":{"type":"integer","title":"Processed Rows"},"failed_rows":{"type":"integer","title":"Failed Rows"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"retry_config":{"$ref":"#/components/schemas/RetryConfigResponse"},"max_concurrency":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Concurrency"},"schedule_config":{"anyOf":[{"$ref":"#/components/schemas/ScheduleConfigResponse"},{"type":"null"}]},"circuit_breaker":{"anyOf":[{"$ref":"#/components/schemas/CircuitBreakerConfigResponse"},{"type":"null"}]},"executed_count":{"type":"integer","title":"Executed Count","default":0},"total_queued_count":{"type":"integer","title":"Total Queued Count","default":0},"parent_campaign_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent Campaign Id"},"redialed_campaign_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Redialed Campaign Id"},"telephony_configuration_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Telephony Configuration Id"},"telephony_configuration_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Telephony Configuration Name"},"logs":{"items":{"$ref":"#/components/schemas/CampaignLogEntryResponse"},"type":"array","title":"Logs"}},"type":"object","required":["id","name","workflow_id","workflow_name","state","source_type","source_id","total_rows","processed_rows","failed_rows","created_at","started_at","completed_at","retry_config"],"title":"CampaignResponse"},"CampaignRunsResponse":{"properties":{"runs":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Runs"},"total_count":{"type":"integer","title":"Total Count"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"},"total_pages":{"type":"integer","title":"Total Pages"}},"type":"object","required":["runs","total_count","page","limit","total_pages"],"title":"CampaignRunsResponse","description":"Paginated response for campaign workflow runs"},"CampaignSourceDownloadResponse":{"properties":{"download_url":{"type":"string","title":"Download Url"},"expires_in":{"type":"integer","title":"Expires In"}},"type":"object","required":["download_url","expires_in"],"title":"CampaignSourceDownloadResponse"},"CampaignsResponse":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignResponse"},"type":"array","title":"Campaigns"}},"type":"object","required":["campaigns"],"title":"CampaignsResponse"},"ChunkResponseSchema":{"properties":{"id":{"type":"integer","title":"Id"},"document_id":{"type":"integer","title":"Document Id"},"chunk_text":{"type":"string","title":"Chunk Text"},"contextualized_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contextualized Text"},"chunk_index":{"type":"integer","title":"Chunk Index"},"chunk_metadata":{"additionalProperties":true,"type":"object","title":"Chunk Metadata"},"filename":{"type":"string","title":"Filename"},"document_uuid":{"type":"string","title":"Document Uuid"},"similarity":{"type":"number","title":"Similarity"}},"type":"object","required":["id","document_id","chunk_text","contextualized_text","chunk_index","chunk_metadata","filename","document_uuid","similarity"],"title":"ChunkResponseSchema","description":"Response schema for a document chunk."},"ChunkSearchRequestSchema":{"properties":{"query":{"type":"string","title":"Query","description":"Search query text"},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Maximum number of results","default":5},"document_uuids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Document Uuids","description":"Filter by specific document UUIDs"},"min_similarity":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Min Similarity","description":"Minimum similarity threshold"}},"type":"object","required":["query"],"title":"ChunkSearchRequestSchema","description":"Request schema for searching similar chunks."},"ChunkSearchResponseSchema":{"properties":{"chunks":{"items":{"$ref":"#/components/schemas/ChunkResponseSchema"},"type":"array","title":"Chunks"},"query":{"type":"string","title":"Query"},"total_results":{"type":"integer","title":"Total Results"}},"type":"object","required":["chunks","query","total_results"],"title":"ChunkSearchResponseSchema","description":"Response schema for chunk search results."},"CircuitBreakerConfigRequest":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":true},"failure_threshold":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Failure Threshold","default":0.5},"window_seconds":{"type":"integer","maximum":600.0,"minimum":30.0,"title":"Window Seconds","default":120},"min_calls_in_window":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Min Calls In Window","default":5}},"type":"object","title":"CircuitBreakerConfigRequest"},"CircuitBreakerConfigResponse":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false},"failure_threshold":{"type":"number","title":"Failure Threshold","default":0.5},"window_seconds":{"type":"integer","title":"Window Seconds","default":120},"min_calls_in_window":{"type":"integer","title":"Min Calls In Window","default":5}},"type":"object","title":"CircuitBreakerConfigResponse"},"CloudonixConfigurationRequest":{"properties":{"provider":{"type":"string","const":"cloudonix","title":"Provider","default":"cloudonix"},"bearer_token":{"type":"string","title":"Bearer Token","description":"Cloudonix API Bearer Token"},"domain_id":{"type":"string","title":"Domain Id","description":"Cloudonix Domain ID"},"application_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Name","description":"Cloudonix Voice Application name. The application's url is updated when inbound workflows are attached to numbers on this domain. If omitted, an application is auto-created on save and its name is stored on the configuration."},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Cloudonix phone numbers (optional)"}},"type":"object","required":["bearer_token","domain_id"],"title":"CloudonixConfigurationRequest","description":"Request schema for Cloudonix configuration."},"CloudonixConfigurationResponse":{"properties":{"provider":{"type":"string","const":"cloudonix","title":"Provider","default":"cloudonix"},"bearer_token":{"type":"string","title":"Bearer Token"},"domain_id":{"type":"string","title":"Domain Id"},"application_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Name"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["bearer_token","domain_id","from_numbers"],"title":"CloudonixConfigurationResponse","description":"Response schema for Cloudonix configuration with masked sensitive fields."},"CreateAPIKeyRequest":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"CreateAPIKeyRequest"},"CreateAPIKeyResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"key_prefix":{"type":"string","title":"Key Prefix"},"api_key":{"type":"string","title":"Api Key"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","name","key_prefix","api_key","created_at"],"title":"CreateAPIKeyResponse"},"CreateCampaignRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name"},"workflow_id":{"type":"integer","title":"Workflow Id"},"source_type":{"type":"string","pattern":"^(google-sheet|csv)$","title":"Source Type"},"source_id":{"type":"string","title":"Source Id"},"telephony_configuration_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Telephony Configuration Id"},"retry_config":{"anyOf":[{"$ref":"#/components/schemas/RetryConfigRequest"},{"type":"null"}]},"max_concurrency":{"anyOf":[{"type":"integer","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Max Concurrency"},"schedule_config":{"anyOf":[{"$ref":"#/components/schemas/ScheduleConfigRequest"},{"type":"null"}]},"circuit_breaker":{"anyOf":[{"$ref":"#/components/schemas/CircuitBreakerConfigRequest"},{"type":"null"}]}},"type":"object","required":["name","workflow_id","source_type","source_id"],"title":"CreateCampaignRequest"},"CreateCredentialRequest":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"credential_type":{"$ref":"#/components/schemas/WebhookCredentialType"},"credential_data":{"additionalProperties":true,"type":"object","title":"Credential Data"}},"type":"object","required":["name","credential_type","credential_data"],"title":"CreateCredentialRequest","description":"Request schema for creating a webhook credential."},"CreateServiceKeyRequest":{"properties":{"name":{"type":"string","title":"Name"},"expires_in_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires In Days","default":90}},"type":"object","required":["name"],"title":"CreateServiceKeyRequest"},"CreateServiceKeyResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"service_key":{"type":"string","title":"Service Key"},"key_prefix":{"type":"string","title":"Key Prefix"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"}},"type":"object","required":["id","name","service_key","key_prefix"],"title":"CreateServiceKeyResponse"},"CreateToolRequest":{"properties":{"name":{"type":"string","maxLength":255,"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"category":{"type":"string","title":"Category","default":"http_api"},"icon":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"title":"Icon","default":"globe"},"icon_color":{"anyOf":[{"type":"string","maxLength":7},{"type":"null"}],"title":"Icon Color","default":"#3B82F6"},"definition":{"oneOf":[{"$ref":"#/components/schemas/HttpApiToolDefinition"},{"$ref":"#/components/schemas/EndCallToolDefinition"},{"$ref":"#/components/schemas/TransferCallToolDefinition"},{"$ref":"#/components/schemas/CalculatorToolDefinition"}],"title":"Definition","discriminator":{"propertyName":"type","mapping":{"calculator":"#/components/schemas/CalculatorToolDefinition","end_call":"#/components/schemas/EndCallToolDefinition","http_api":"#/components/schemas/HttpApiToolDefinition","transfer_call":"#/components/schemas/TransferCallToolDefinition"}}}},"type":"object","required":["name","definition"],"title":"CreateToolRequest","description":"Request schema for creating a tool."},"CreateWorkflowRequest":{"properties":{"name":{"type":"string","title":"Name"},"workflow_definition":{"additionalProperties":true,"type":"object","title":"Workflow Definition"}},"type":"object","required":["name","workflow_definition"],"title":"CreateWorkflowRequest"},"CreateWorkflowRunRequest":{"properties":{"mode":{"type":"string","title":"Mode"},"name":{"type":"string","title":"Name"}},"type":"object","required":["mode","name"],"title":"CreateWorkflowRunRequest"},"CreateWorkflowRunResponse":{"properties":{"id":{"type":"integer","title":"Id"},"workflow_id":{"type":"integer","title":"Workflow Id"},"name":{"type":"string","title":"Name"},"mode":{"type":"string","title":"Mode"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"definition_id":{"type":"integer","title":"Definition Id"},"initial_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Initial Context"}},"type":"object","required":["id","workflow_id","name","mode","created_at","definition_id"],"title":"CreateWorkflowRunResponse"},"CreateWorkflowTemplateRequest":{"properties":{"call_type":{"type":"string","enum":["inbound","outbound"],"title":"Call Type"},"use_case":{"type":"string","title":"Use Case"},"activity_description":{"type":"string","title":"Activity Description"}},"type":"object","required":["call_type","use_case","activity_description"],"title":"CreateWorkflowTemplateRequest"},"CreatedByResponse":{"properties":{"id":{"type":"integer","title":"Id"},"provider_id":{"type":"string","title":"Provider Id"}},"type":"object","required":["id","provider_id"],"title":"CreatedByResponse","description":"Response schema for the user who created a tool."},"CredentialResponse":{"properties":{"uuid":{"type":"string","title":"Uuid"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"credential_type":{"type":"string","title":"Credential Type"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["uuid","name","description","credential_type","created_at","updated_at"],"title":"CredentialResponse","description":"Response schema for a webhook credential (never includes sensitive data)."},"CurrentUsageResponse":{"properties":{"period_start":{"type":"string","title":"Period Start"},"period_end":{"type":"string","title":"Period End"},"used_dograh_tokens":{"type":"number","title":"Used Dograh Tokens"},"quota_dograh_tokens":{"type":"integer","title":"Quota Dograh Tokens"},"percentage_used":{"type":"number","title":"Percentage Used"},"next_refresh_date":{"type":"string","title":"Next Refresh Date"},"quota_enabled":{"type":"boolean","title":"Quota Enabled"},"total_duration_seconds":{"type":"integer","title":"Total Duration Seconds"},"used_amount_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Used Amount Usd"},"quota_amount_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quota Amount Usd"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"price_per_second_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price Per Second Usd"}},"type":"object","required":["period_start","period_end","used_dograh_tokens","quota_dograh_tokens","percentage_used","next_refresh_date","quota_enabled","total_duration_seconds"],"title":"CurrentUsageResponse"},"DailyReportResponse":{"properties":{"date":{"type":"string","title":"Date"},"timezone":{"type":"string","title":"Timezone"},"workflow_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Workflow Id"},"metrics":{"additionalProperties":{"type":"integer"},"type":"object","title":"Metrics"},"disposition_distribution":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Disposition Distribution"},"call_duration_distribution":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Call Duration Distribution"}},"type":"object","required":["date","timezone","workflow_id","metrics","disposition_distribution","call_duration_distribution"],"title":"DailyReportResponse"},"DailyUsageBreakdownResponse":{"properties":{"breakdown":{"items":{"$ref":"#/components/schemas/DailyUsageItem"},"type":"array","title":"Breakdown"},"total_minutes":{"type":"number","title":"Total Minutes"},"total_cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Cost Usd"},"total_dograh_tokens":{"type":"number","title":"Total Dograh Tokens"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"}},"type":"object","required":["breakdown","total_minutes","total_dograh_tokens"],"title":"DailyUsageBreakdownResponse"},"DailyUsageItem":{"properties":{"date":{"type":"string","title":"Date"},"minutes":{"type":"number","title":"Minutes"},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cost Usd"},"dograh_tokens":{"type":"number","title":"Dograh Tokens"},"call_count":{"type":"integer","title":"Call Count"}},"type":"object","required":["date","minutes","dograh_tokens","call_count"],"title":"DailyUsageItem"},"DefaultConfigurationsResponse":{"properties":{"llm":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Llm"},"tts":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Tts"},"stt":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Stt"},"embeddings":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Embeddings"},"realtime":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Realtime"},"default_providers":{"additionalProperties":{"type":"string"},"type":"object","title":"Default Providers"}},"type":"object","required":["llm","tts","stt","embeddings","realtime","default_providers"],"title":"DefaultConfigurationsResponse"},"DisplayOptions":{"properties":{"show":{"anyOf":[{"additionalProperties":{"items":{},"type":"array"},"type":"object"},{"type":"null"}],"title":"Show"},"hide":{"anyOf":[{"additionalProperties":{"items":{},"type":"array"},"type":"object"},{"type":"null"}],"title":"Hide"}},"additionalProperties":false,"type":"object","title":"DisplayOptions","description":"Conditional visibility rules.\n\n`show` keys are AND-combined: this property is visible only when EVERY\nreferenced field's value matches one of the listed values.\n\n`hide` keys are OR-combined: this property is hidden when ANY referenced\nfield's value matches one of the listed values.\n\nExample:\n DisplayOptions(show={\"extraction_enabled\": [True]})\n DisplayOptions(show={\"greeting_type\": [\"audio\"]})"},"DocumentListResponseSchema":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/DocumentResponseSchema"},"type":"array","title":"Documents"},"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["documents","total","limit","offset"],"title":"DocumentListResponseSchema","description":"Response schema for list of documents."},"DocumentResponseSchema":{"properties":{"id":{"type":"integer","title":"Id"},"document_uuid":{"type":"string","title":"Document Uuid"},"filename":{"type":"string","title":"Filename"},"file_size_bytes":{"type":"integer","title":"File Size Bytes"},"file_hash":{"type":"string","title":"File Hash"},"mime_type":{"type":"string","title":"Mime Type"},"processing_status":{"type":"string","title":"Processing Status"},"processing_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processing Error"},"total_chunks":{"type":"integer","title":"Total Chunks"},"retrieval_mode":{"type":"string","title":"Retrieval Mode","default":"chunked"},"custom_metadata":{"additionalProperties":true,"type":"object","title":"Custom Metadata"},"docling_metadata":{"additionalProperties":true,"type":"object","title":"Docling Metadata"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"organization_id":{"type":"integer","title":"Organization Id"},"created_by":{"type":"integer","title":"Created By"},"is_active":{"type":"boolean","title":"Is Active"}},"type":"object","required":["id","document_uuid","filename","file_size_bytes","file_hash","mime_type","processing_status","total_chunks","custom_metadata","docling_metadata","created_at","updated_at","organization_id","created_by","is_active"],"title":"DocumentResponseSchema","description":"Response schema for document metadata."},"DocumentUploadRequestSchema":{"properties":{"filename":{"type":"string","title":"Filename","description":"Name of the file to upload"},"mime_type":{"type":"string","title":"Mime Type","description":"MIME type of the file"},"custom_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Metadata","description":"Optional custom metadata"}},"type":"object","required":["filename","mime_type"],"title":"DocumentUploadRequestSchema","description":"Request schema for initiating document upload."},"DocumentUploadResponseSchema":{"properties":{"upload_url":{"type":"string","title":"Upload Url","description":"Signed URL for uploading the file"},"document_uuid":{"type":"string","title":"Document Uuid","description":"Unique identifier for the document"},"s3_key":{"type":"string","title":"S3 Key","description":"S3 key where file should be uploaded"}},"type":"object","required":["upload_url","document_uuid","s3_key"],"title":"DocumentUploadResponseSchema","description":"Response schema containing upload URL and document metadata."},"DuplicateTemplateRequest":{"properties":{"template_id":{"type":"integer","title":"Template Id"},"workflow_name":{"type":"string","title":"Workflow Name"}},"type":"object","required":["template_id","workflow_name"],"title":"DuplicateTemplateRequest"},"EmbedConfigResponse":{"properties":{"workflow_id":{"type":"integer","title":"Workflow Id"},"settings":{"additionalProperties":true,"type":"object","title":"Settings"},"theme":{"type":"string","title":"Theme"},"position":{"type":"string","title":"Position"},"button_text":{"type":"string","title":"Button Text"},"button_color":{"type":"string","title":"Button Color"},"size":{"type":"string","title":"Size"},"auto_start":{"type":"boolean","title":"Auto Start"}},"type":"object","required":["workflow_id","settings","theme","position","button_text","button_color","size","auto_start"],"title":"EmbedConfigResponse","description":"Response model for embed configuration"},"EmbedTokenRequest":{"properties":{"allowed_domains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Allowed Domains"},"settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Settings"},"usage_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Usage Limit"},"expires_in_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires In Days","default":30}},"type":"object","title":"EmbedTokenRequest"},"EmbedTokenResponse":{"properties":{"id":{"type":"integer","title":"Id"},"token":{"type":"string","title":"Token"},"allowed_domains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Allowed Domains"},"settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Settings"},"is_active":{"type":"boolean","title":"Is Active"},"usage_count":{"type":"integer","title":"Usage Count"},"usage_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Usage Limit"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"embed_script":{"type":"string","title":"Embed Script"}},"type":"object","required":["id","token","allowed_domains","settings","is_active","usage_count","usage_limit","expires_at","created_at","embed_script"],"title":"EmbedTokenResponse"},"EndCallConfig":{"properties":{"messageType":{"type":"string","enum":["none","custom","audio"],"title":"Messagetype","description":"Type of goodbye message","default":"none"},"customMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custommessage","description":"Custom message to play before ending the call"},"audioRecordingId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Audiorecordingid","description":"Recording ID for audio goodbye message"},"endCallReason":{"type":"boolean","title":"Endcallreason","description":"When enabled, LLM must provide a reason for ending the call. The reason is set as call disposition and added to call tags.","default":false},"endCallReasonDescription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endcallreasondescription","description":"Description shown to the LLM for the reason parameter. Used only when endCallReason is enabled."}},"type":"object","title":"EndCallConfig","description":"Configuration for End Call tools."},"EndCallToolDefinition":{"properties":{"schema_version":{"type":"integer","title":"Schema Version","description":"Schema version","default":1},"type":{"type":"string","const":"end_call","title":"Type","description":"Tool type"},"config":{"$ref":"#/components/schemas/EndCallConfig","description":"End Call configuration"}},"type":"object","required":["type","config"],"title":"EndCallToolDefinition","description":"Tool definition for End Call tools."},"FileDescriptor":{"properties":{"filename":{"type":"string","title":"Filename","description":"Original filename of the audio file"},"mime_type":{"type":"string","title":"Mime Type","description":"MIME type of the audio file","default":"audio/wav"},"file_size":{"type":"integer","maximum":5242880.0,"exclusiveMinimum":0.0,"title":"File Size","description":"File size in bytes (max 5MB)"}},"type":"object","required":["filename","file_size"],"title":"FileDescriptor","description":"Descriptor for a single file in a batch upload request."},"FileMetadataResponse":{"properties":{"key":{"type":"string","title":"Key"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["key","metadata"],"title":"FileMetadataResponse"},"GraphConstraints":{"properties":{"min_incoming":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Incoming"},"max_incoming":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Incoming"},"min_outgoing":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Outgoing"},"max_outgoing":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Outgoing"}},"additionalProperties":false,"type":"object","title":"GraphConstraints","description":"Per-node-type graph rules. WorkflowGraph enforces these at validation."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"properties":{"status":{"type":"string","title":"Status"},"version":{"type":"string","title":"Version"},"backend_api_endpoint":{"type":"string","title":"Backend Api Endpoint"},"deployment_mode":{"type":"string","title":"Deployment Mode"},"auth_provider":{"type":"string","title":"Auth Provider"},"turn_enabled":{"type":"boolean","title":"Turn Enabled"},"force_turn_relay":{"type":"boolean","title":"Force Turn Relay"}},"type":"object","required":["status","version","backend_api_endpoint","deployment_mode","auth_provider","turn_enabled","force_turn_relay"],"title":"HealthResponse"},"HttpApiConfig":{"properties":{"method":{"type":"string","title":"Method","description":"HTTP method (GET, POST, PUT, PATCH, DELETE)"},"url":{"type":"string","title":"Url","description":"Target URL"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","description":"Static headers to include"},"credential_uuid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credential Uuid","description":"Reference to ExternalCredentialModel for auth"},"parameters":{"anyOf":[{"items":{"$ref":"#/components/schemas/ToolParameter"},"type":"array"},{"type":"null"}],"title":"Parameters","description":"Parameters that the tool accepts from LLM"},"preset_parameters":{"anyOf":[{"items":{"$ref":"#/components/schemas/PresetToolParameter"},"type":"array"},{"type":"null"}],"title":"Preset Parameters","description":"Parameters injected by Dograh from fixed values or workflow context templates"},"timeout_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout Ms","description":"Request timeout in milliseconds","default":5000},"customMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custommessage","description":"Custom message to play after tool execution"},"customMessageType":{"anyOf":[{"type":"string","enum":["text","audio"]},{"type":"null"}],"title":"Custommessagetype","description":"Type of custom message: text or audio"},"customMessageRecordingId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custommessagerecordingid","description":"Recording ID for audio custom message"}},"type":"object","required":["method","url"],"title":"HttpApiConfig","description":"Configuration for HTTP API tools."},"HttpApiToolDefinition":{"properties":{"schema_version":{"type":"integer","title":"Schema Version","description":"Schema version","default":1},"type":{"type":"string","const":"http_api","title":"Type","description":"Tool type"},"config":{"$ref":"#/components/schemas/HttpApiConfig","description":"HTTP API configuration"}},"type":"object","required":["type","config"],"title":"HttpApiToolDefinition","description":"Tool definition for HTTP API tools."},"ImpersonateRequest":{"properties":{"provider_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider User Id"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"}},"type":"object","title":"ImpersonateRequest","description":"Request payload for superadmin impersonation.\n\nEither ``provider_user_id`` **or** ``user_id`` must be supplied. If both are\nprovided, ``provider_user_id`` takes precedence."},"ImpersonateResponse":{"properties":{"refresh_token":{"type":"string","title":"Refresh Token"},"access_token":{"type":"string","title":"Access Token"}},"type":"object","required":["refresh_token","access_token"],"title":"ImpersonateResponse"},"InitEmbedRequest":{"properties":{"token":{"type":"string","title":"Token"},"context_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Context Variables"}},"type":"object","required":["token"],"title":"InitEmbedRequest","description":"Request model for initializing an embed session"},"InitEmbedResponse":{"properties":{"session_token":{"type":"string","title":"Session Token"},"workflow_run_id":{"type":"integer","title":"Workflow Run Id"},"config":{"additionalProperties":true,"type":"object","title":"Config"}},"type":"object","required":["session_token","workflow_run_id","config"],"title":"InitEmbedResponse","description":"Response model for embed initialization"},"InitiateCallRequest":{"properties":{"workflow_id":{"type":"integer","title":"Workflow Id"},"workflow_run_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Workflow Run Id"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"telephony_configuration_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Telephony Configuration Id"},"from_phone_number_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"From Phone Number Id"}},"type":"object","required":["workflow_id"],"title":"InitiateCallRequest"},"IntegrationResponse":{"properties":{"id":{"type":"integer","title":"Id"},"integration_id":{"type":"string","title":"Integration Id"},"organisation_id":{"type":"integer","title":"Organisation Id"},"created_by":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Created By"},"provider":{"type":"string","title":"Provider"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"type":"string","title":"Created At"},"action":{"type":"string","title":"Action"},"provider_data":{"additionalProperties":true,"type":"object","title":"Provider Data"}},"type":"object","required":["id","integration_id","organisation_id","created_by","provider","is_active","created_at","action","provider_data"],"title":"IntegrationResponse"},"ItemKind":{"type":"string","enum":["node","edge","workflow"],"title":"ItemKind"},"LangfuseCredentialsRequest":{"properties":{"host":{"type":"string","title":"Host"},"public_key":{"type":"string","title":"Public Key"},"secret_key":{"type":"string","title":"Secret Key"}},"type":"object","required":["host","public_key","secret_key"],"title":"LangfuseCredentialsRequest"},"LangfuseCredentialsResponse":{"properties":{"host":{"type":"string","title":"Host","default":""},"public_key":{"type":"string","title":"Public Key","default":""},"secret_key":{"type":"string","title":"Secret Key","default":""},"configured":{"type":"boolean","title":"Configured","default":false}},"type":"object","title":"LangfuseCredentialsResponse"},"LastCampaignSettingsResponse":{"properties":{"retry_config":{"anyOf":[{"$ref":"#/components/schemas/RetryConfigResponse"},{"type":"null"}]},"max_concurrency":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Concurrency"},"schedule_config":{"anyOf":[{"$ref":"#/components/schemas/ScheduleConfigResponse"},{"type":"null"}]},"circuit_breaker":{"anyOf":[{"$ref":"#/components/schemas/CircuitBreakerConfigResponse"},{"type":"null"}]}},"type":"object","title":"LastCampaignSettingsResponse"},"LoginRequest":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"}},"type":"object","required":["email","password"],"title":"LoginRequest"},"MPSCreditsResponse":{"properties":{"total_credits_used":{"type":"number","title":"Total Credits Used"},"remaining_credits":{"type":"number","title":"Remaining Credits"},"total_quota":{"type":"number","title":"Total Quota"}},"type":"object","required":["total_credits_used","remaining_credits","total_quota"],"title":"MPSCreditsResponse"},"NodeCategory":{"type":"string","enum":["call_node","global_node","trigger","integration"],"title":"NodeCategory","description":"Drives grouping in the AddNodePanel UI."},"NodeExample":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"data":{"additionalProperties":true,"type":"object","title":"Data"}},"additionalProperties":false,"type":"object","required":["name","data"],"title":"NodeExample","description":"A worked example LLMs can pattern-match. Keep small and realistic."},"NodeSpec":{"properties":{"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"},"description":{"type":"string","minLength":1,"title":"Description","description":"Human-facing explanation shown in AddNodePanel."},"llm_hint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Llm Hint","description":"LLM-only guidance; omitted from the UI."},"category":{"$ref":"#/components/schemas/NodeCategory"},"icon":{"type":"string","title":"Icon"},"version":{"type":"string","title":"Version","default":"1.0.0"},"properties":{"items":{"$ref":"#/components/schemas/PropertySpec"},"type":"array","title":"Properties"},"examples":{"items":{"$ref":"#/components/schemas/NodeExample"},"type":"array","title":"Examples"},"graph_constraints":{"anyOf":[{"$ref":"#/components/schemas/GraphConstraints"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["name","display_name","description","category","icon","properties"],"title":"NodeSpec","description":"Single source of truth for a node type."},"NodeTypesResponse":{"properties":{"spec_version":{"type":"string","title":"Spec Version"},"node_types":{"items":{"$ref":"#/components/schemas/NodeSpec"},"type":"array","title":"Node Types"}},"type":"object","required":["spec_version","node_types"],"title":"NodeTypesResponse"},"PhoneNumberCreateRequest":{"properties":{"address":{"type":"string","maxLength":255,"minLength":1,"title":"Address"},"country_code":{"anyOf":[{"type":"string","maxLength":2,"minLength":2},{"type":"null"}],"title":"Country Code"},"label":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Label"},"inbound_workflow_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Inbound Workflow Id"},"is_active":{"type":"boolean","title":"Is Active","default":true},"is_default_caller_id":{"type":"boolean","title":"Is Default Caller Id","default":false},"extra_metadata":{"additionalProperties":true,"type":"object","title":"Extra Metadata"}},"type":"object","required":["address"],"title":"PhoneNumberCreateRequest","description":"Create a new phone number under a telephony configuration.\n\n``address_normalized`` and ``address_type`` are computed server-side from\n``address`` (and ``country_code`` if PSTN). ``address`` itself is stored\nverbatim for display."},"PhoneNumberListResponse":{"properties":{"phone_numbers":{"items":{"$ref":"#/components/schemas/PhoneNumberResponse"},"type":"array","title":"Phone Numbers"}},"type":"object","required":["phone_numbers"],"title":"PhoneNumberListResponse"},"PhoneNumberResponse":{"properties":{"id":{"type":"integer","title":"Id"},"telephony_configuration_id":{"type":"integer","title":"Telephony Configuration Id"},"address":{"type":"string","title":"Address"},"address_normalized":{"type":"string","title":"Address Normalized"},"address_type":{"type":"string","title":"Address Type"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"inbound_workflow_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Inbound Workflow Id"},"inbound_workflow_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inbound Workflow Name"},"is_active":{"type":"boolean","title":"Is Active"},"is_default_caller_id":{"type":"boolean","title":"Is Default Caller Id"},"extra_metadata":{"additionalProperties":true,"type":"object","title":"Extra Metadata"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"provider_sync":{"anyOf":[{"$ref":"#/components/schemas/ProviderSyncStatus"},{"type":"null"}]}},"type":"object","required":["id","telephony_configuration_id","address","address_normalized","address_type","is_active","is_default_caller_id","extra_metadata","created_at","updated_at"],"title":"PhoneNumberResponse"},"PhoneNumberUpdateRequest":{"properties":{"label":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Label"},"inbound_workflow_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Inbound Workflow Id"},"clear_inbound_workflow":{"type":"boolean","title":"Clear Inbound Workflow","default":false},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"country_code":{"anyOf":[{"type":"string","maxLength":2,"minLength":2},{"type":"null"}],"title":"Country Code"},"extra_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Extra Metadata"}},"type":"object","title":"PhoneNumberUpdateRequest","description":"Partial update. ``address`` is intentionally immutable \u2014 to change a\nnumber, delete the row and create a new one."},"PlivoConfigurationRequest":{"properties":{"provider":{"type":"string","const":"plivo","title":"Provider","default":"plivo"},"auth_id":{"type":"string","title":"Auth Id","description":"Plivo Auth ID"},"auth_token":{"type":"string","title":"Auth Token","description":"Plivo Auth Token"},"application_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Id","description":"Plivo Application ID. The application's answer_url is updated when inbound workflows are attached to numbers on this account. If omitted, an application is auto-created on save and its id is stored on the configuration."},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Plivo phone numbers"}},"type":"object","required":["auth_id","auth_token"],"title":"PlivoConfigurationRequest","description":"Request schema for Plivo configuration."},"PlivoConfigurationResponse":{"properties":{"provider":{"type":"string","const":"plivo","title":"Provider","default":"plivo"},"auth_id":{"type":"string","title":"Auth Id"},"auth_token":{"type":"string","title":"Auth Token"},"application_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Id"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["auth_id","auth_token","from_numbers"],"title":"PlivoConfigurationResponse","description":"Response schema for Plivo configuration with masked sensitive fields."},"PresetToolParameter":{"properties":{"name":{"type":"string","title":"Name","description":"Parameter name (used as key in request body)"},"type":{"type":"string","title":"Type","description":"Parameter type: string, number, or boolean"},"value_template":{"type":"string","title":"Value Template","description":"Fixed value or template, e.g. {{initial_context.phone_number}}"},"required":{"type":"boolean","title":"Required","description":"Whether the parameter must resolve to a non-empty value","default":true}},"type":"object","required":["name","type","value_template"],"title":"PresetToolParameter","description":"A parameter injected by Dograh at runtime."},"PresignedUploadUrlRequest":{"properties":{"file_name":{"type":"string","pattern":".*\\.csv$","title":"File Name","description":"CSV filename"},"file_size":{"type":"integer","maximum":10485760.0,"exclusiveMinimum":0.0,"title":"File Size","description":"File size in bytes (max 10MB)"},"content_type":{"type":"string","title":"Content Type","description":"File content type","default":"text/csv"}},"type":"object","required":["file_name","file_size"],"title":"PresignedUploadUrlRequest"},"PresignedUploadUrlResponse":{"properties":{"upload_url":{"type":"string","title":"Upload Url"},"file_key":{"type":"string","title":"File Key"},"expires_in":{"type":"integer","title":"Expires In"}},"type":"object","required":["upload_url","file_key","expires_in"],"title":"PresignedUploadUrlResponse"},"ProcessDocumentRequestSchema":{"properties":{"document_uuid":{"type":"string","title":"Document Uuid","description":"Document UUID to process"},"s3_key":{"type":"string","title":"S3 Key","description":"S3 key of the uploaded file"},"retrieval_mode":{"type":"string","title":"Retrieval Mode","description":"Retrieval mode: 'chunked' for vector search or 'full_document' for full text retrieval","default":"chunked"}},"type":"object","required":["document_uuid","s3_key"],"title":"ProcessDocumentRequestSchema","description":"Request schema for triggering document processing."},"PropertyOption":{"properties":{"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"},{"type":"number"}],"title":"Value"},"label":{"type":"string","title":"Label"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"additionalProperties":false,"type":"object","required":["value","label"],"title":"PropertyOption","description":"An option in an `options` or `multi_options` dropdown."},"PropertySpec":{"properties":{"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/PropertyType"},"display_name":{"type":"string","title":"Display Name"},"description":{"type":"string","minLength":1,"title":"Description","description":"Human-facing explanation shown in the UI."},"llm_hint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Llm Hint","description":"LLM-only guidance; omitted from the UI."},"default":{"title":"Default"},"required":{"type":"boolean","title":"Required","default":false},"placeholder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Placeholder"},"display_options":{"anyOf":[{"$ref":"#/components/schemas/DisplayOptions"},{"type":"null"}]},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyOption"},"type":"array"},{"type":"null"}],"title":"Options"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertySpec"},"type":"array"},{"type":"null"}],"title":"Properties"},"min_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Value"},"max_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Value"},"min_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Length"},"max_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Length"},"pattern":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pattern"},"editor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Editor"},"extra":{"additionalProperties":true,"type":"object","title":"Extra"}},"additionalProperties":false,"type":"object","required":["name","type","display_name","description"],"title":"PropertySpec","description":"Single field on a node.\n\n`description` is HUMAN-FACING \u2014 shown under the field in the edit\ndialog. Keep it concise and explain what the field does.\n\n`llm_hint` is LLM-FACING \u2014 appears only in the `get_node_type` MCP\nresponse and in SDK schema output. Use it for catalog tool references\n(e.g., \"Use `list_recordings`\"), array shape, expected value idioms,\nor anything that would be noise in the UI. Optional; omit when the\n`description` already suffices for both audiences."},"PropertyType":{"type":"string","enum":["string","number","boolean","options","multi_options","fixed_collection","json","tool_refs","document_refs","recording_ref","credential_ref","mention_textarea","url"],"title":"PropertyType","description":"Bounded vocabulary of property types the renderer dispatches on.\n\nAdding a value here requires a matching arm in the frontend\n`` switch and (where relevant) the SDK codegen template."},"ProviderSyncStatus":{"properties":{"ok":{"type":"boolean","title":"Ok"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"}},"type":"object","required":["ok"],"title":"ProviderSyncStatus","description":"Result of pushing a phone-number change to the upstream provider.\n\nReturned alongside create/update responses when the route attempted to\nsync inbound webhook configuration. ``ok=False`` is a warning, not a\nfatal error \u2014 the DB write succeeded."},"RecordingCreateRequestSchema":{"properties":{"recording_id":{"type":"string","title":"Recording Id","description":"Short recording ID from upload step"},"tts_provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Provider","description":"TTS provider (e.g. elevenlabs)"},"tts_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Model","description":"TTS model name"},"tts_voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Voice Id","description":"TTS voice identifier"},"transcript":{"type":"string","title":"Transcript","description":"User-provided transcript of the recording"},"storage_key":{"type":"string","title":"Storage Key","description":"Storage key from upload step"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"Optional metadata (file_size, duration, etc.)"}},"type":"object","required":["recording_id","transcript","storage_key"],"title":"RecordingCreateRequestSchema","description":"Request schema for creating a recording record after upload."},"RecordingListResponseSchema":{"properties":{"recordings":{"items":{"$ref":"#/components/schemas/RecordingResponseSchema"},"type":"array","title":"Recordings"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["recordings","total"],"title":"RecordingListResponseSchema","description":"Response schema for list of recordings."},"RecordingResponseSchema":{"properties":{"id":{"type":"integer","title":"Id"},"recording_id":{"type":"string","title":"Recording Id"},"workflow_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Workflow Id"},"organization_id":{"type":"integer","title":"Organization Id"},"tts_provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Provider"},"tts_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Model"},"tts_voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Voice Id"},"transcript":{"type":"string","title":"Transcript"},"storage_key":{"type":"string","title":"Storage Key"},"storage_backend":{"type":"string","title":"Storage Backend"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"created_by":{"type":"integer","title":"Created By"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"is_active":{"type":"boolean","title":"Is Active"}},"type":"object","required":["id","recording_id","organization_id","transcript","storage_key","storage_backend","metadata","created_by","created_at","is_active"],"title":"RecordingResponseSchema","description":"Response schema for a single recording."},"RecordingUpdateRequestSchema":{"properties":{"recording_id":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_-]+$","title":"Recording Id","description":"New descriptive recording ID (letters, numbers, hyphens, underscores only)"}},"type":"object","required":["recording_id"],"title":"RecordingUpdateRequestSchema","description":"Request schema for updating a recording's ID."},"RecordingUploadResponseSchema":{"properties":{"upload_url":{"type":"string","title":"Upload Url","description":"Presigned URL for uploading the audio"},"recording_id":{"type":"string","title":"Recording Id","description":"Short unique recording ID"},"storage_key":{"type":"string","title":"Storage Key","description":"Storage key where file will be uploaded"}},"type":"object","required":["upload_url","recording_id","storage_key"],"title":"RecordingUploadResponseSchema","description":"Response schema with presigned upload URL."},"RedialCampaignRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name","description":"Name for the redial campaign"},"retry_on_voicemail":{"type":"boolean","title":"Retry On Voicemail","default":true},"retry_on_no_answer":{"type":"boolean","title":"Retry On No Answer","default":true},"retry_on_busy":{"type":"boolean","title":"Retry On Busy","default":true},"retry_config":{"anyOf":[{"$ref":"#/components/schemas/RetryConfigRequest"},{"type":"null"}]}},"type":"object","title":"RedialCampaignRequest"},"RetryConfigRequest":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":true},"max_retries":{"type":"integer","maximum":10.0,"minimum":0.0,"title":"Max Retries","default":2},"retry_delay_seconds":{"type":"integer","maximum":3600.0,"minimum":30.0,"title":"Retry Delay Seconds","default":120},"retry_on_busy":{"type":"boolean","title":"Retry On Busy","default":true},"retry_on_no_answer":{"type":"boolean","title":"Retry On No Answer","default":true},"retry_on_voicemail":{"type":"boolean","title":"Retry On Voicemail","default":true}},"type":"object","title":"RetryConfigRequest"},"RetryConfigResponse":{"properties":{"enabled":{"type":"boolean","title":"Enabled"},"max_retries":{"type":"integer","title":"Max Retries"},"retry_delay_seconds":{"type":"integer","title":"Retry Delay Seconds"},"retry_on_busy":{"type":"boolean","title":"Retry On Busy"},"retry_on_no_answer":{"type":"boolean","title":"Retry On No Answer"},"retry_on_voicemail":{"type":"boolean","title":"Retry On Voicemail"}},"type":"object","required":["enabled","max_retries","retry_delay_seconds","retry_on_busy","retry_on_no_answer","retry_on_voicemail"],"title":"RetryConfigResponse"},"S3SignedUrlResponse":{"properties":{"url":{"type":"string","title":"Url"},"expires_in":{"type":"integer","title":"Expires In"}},"type":"object","required":["url","expires_in"],"title":"S3SignedUrlResponse"},"ScheduleConfigRequest":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":true},"timezone":{"type":"string","title":"Timezone","default":"UTC"},"slots":{"items":{"$ref":"#/components/schemas/TimeSlotRequest"},"type":"array","maxItems":50,"minItems":1,"title":"Slots"}},"type":"object","required":["slots"],"title":"ScheduleConfigRequest"},"ScheduleConfigResponse":{"properties":{"enabled":{"type":"boolean","title":"Enabled"},"timezone":{"type":"string","title":"Timezone"},"slots":{"items":{"$ref":"#/components/schemas/TimeSlotResponse"},"type":"array","title":"Slots"}},"type":"object","required":["enabled","timezone","slots"],"title":"ScheduleConfigResponse"},"ServiceKeyResponse":{"properties":{"name":{"type":"string","title":"Name"},"id":{"type":"integer","title":"Id"},"key_prefix":{"type":"string","title":"Key Prefix"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"}},"type":"object","required":["name","id","key_prefix","is_active","created_at"],"title":"ServiceKeyResponse"},"SessionResponse":{"properties":{"session_token":{"type":"string","title":"Session Token"},"expires_at":{"type":"string","title":"Expires At"}},"type":"object","required":["session_token","expires_at"],"title":"SessionResponse"},"SignupRequest":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["email","password"],"title":"SignupRequest"},"SuperuserWorkflowRunResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"workflow_id":{"type":"integer","title":"Workflow Id"},"workflow_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Name"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"organization_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Organization Id"},"organization_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organization Name"},"mode":{"type":"string","title":"Mode"},"is_completed":{"type":"boolean","title":"Is Completed"},"recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Url"},"transcript_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcript Url"},"usage_info":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Usage Info"},"cost_info":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Cost Info"},"initial_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Initial Context"},"gathered_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Gathered Context"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","name","workflow_id","workflow_name","user_id","organization_id","organization_name","mode","is_completed","recording_url","transcript_url","usage_info","cost_info","initial_context","gathered_context","created_at"],"title":"SuperuserWorkflowRunResponse"},"SuperuserWorkflowRunsListResponse":{"properties":{"workflow_runs":{"items":{"$ref":"#/components/schemas/SuperuserWorkflowRunResponse"},"type":"array","title":"Workflow Runs"},"total_count":{"type":"integer","title":"Total Count"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"},"total_pages":{"type":"integer","title":"Total Pages"}},"type":"object","required":["workflow_runs","total_count","page","limit","total_pages"],"title":"SuperuserWorkflowRunsListResponse"},"TelephonyConfigWarningsResponse":{"properties":{"telnyx_missing_webhook_public_key_count":{"type":"integer","title":"Telnyx Missing Webhook Public Key Count"}},"type":"object","required":["telnyx_missing_webhook_public_key_count"],"title":"TelephonyConfigWarningsResponse","description":"Aggregated telephony-configuration warning counts for the user's org.\n\nDrives the page banner and nav badge that nudge customers to finish\noptional-but-recommended configuration steps. Shape is a flat dict so\nnew warning types can be added without breaking the client."},"TelephonyConfigurationCreateRequest":{"properties":{"name":{"type":"string","maxLength":64,"minLength":1,"title":"Name"},"is_default_outbound":{"type":"boolean","title":"Is Default Outbound","default":false},"config":{"oneOf":[{"$ref":"#/components/schemas/ARIConfigurationRequest"},{"$ref":"#/components/schemas/CloudonixConfigurationRequest"},{"$ref":"#/components/schemas/PlivoConfigurationRequest"},{"$ref":"#/components/schemas/TelnyxConfigurationRequest"},{"$ref":"#/components/schemas/TwilioConfigurationRequest"},{"$ref":"#/components/schemas/VobizConfigurationRequest"},{"$ref":"#/components/schemas/VonageConfigurationRequest"}],"title":"Config","discriminator":{"propertyName":"provider","mapping":{"ari":"#/components/schemas/ARIConfigurationRequest","cloudonix":"#/components/schemas/CloudonixConfigurationRequest","plivo":"#/components/schemas/PlivoConfigurationRequest","telnyx":"#/components/schemas/TelnyxConfigurationRequest","twilio":"#/components/schemas/TwilioConfigurationRequest","vobiz":"#/components/schemas/VobizConfigurationRequest","vonage":"#/components/schemas/VonageConfigurationRequest"}}}},"type":"object","required":["name","config"],"title":"TelephonyConfigurationCreateRequest","description":"Body for ``POST /telephony-configs``.\n\n``config`` carries the provider-specific credential fields (the same\ndiscriminated union used by the legacy single-config endpoint). Any\n``from_numbers`` on the inner config are ignored \u2014 phone numbers are\nmanaged via the dedicated phone-numbers endpoints."},"TelephonyConfigurationDetail":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"provider":{"type":"string","title":"Provider"},"is_default_outbound":{"type":"boolean","title":"Is Default Outbound"},"credentials":{"additionalProperties":true,"type":"object","title":"Credentials"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","provider","is_default_outbound","credentials","created_at","updated_at"],"title":"TelephonyConfigurationDetail","description":"Body of ``GET /telephony-configs/{id}`` \u2014 credentials are masked."},"TelephonyConfigurationListItem":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"provider":{"type":"string","title":"Provider"},"is_default_outbound":{"type":"boolean","title":"Is Default Outbound"},"phone_number_count":{"type":"integer","title":"Phone Number Count","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","provider","is_default_outbound","created_at","updated_at"],"title":"TelephonyConfigurationListItem","description":"One row in ``GET /telephony-configs``."},"TelephonyConfigurationListResponse":{"properties":{"configurations":{"items":{"$ref":"#/components/schemas/TelephonyConfigurationListItem"},"type":"array","title":"Configurations"}},"type":"object","required":["configurations"],"title":"TelephonyConfigurationListResponse"},"TelephonyConfigurationResponse":{"properties":{"twilio":{"anyOf":[{"$ref":"#/components/schemas/TwilioConfigurationResponse"},{"type":"null"}]},"plivo":{"anyOf":[{"$ref":"#/components/schemas/PlivoConfigurationResponse"},{"type":"null"}]},"vonage":{"anyOf":[{"$ref":"#/components/schemas/VonageConfigurationResponse"},{"type":"null"}]},"vobiz":{"anyOf":[{"$ref":"#/components/schemas/VobizConfigurationResponse"},{"type":"null"}]},"cloudonix":{"anyOf":[{"$ref":"#/components/schemas/CloudonixConfigurationResponse"},{"type":"null"}]},"ari":{"anyOf":[{"$ref":"#/components/schemas/ARIConfigurationResponse"},{"type":"null"}]},"telnyx":{"anyOf":[{"$ref":"#/components/schemas/TelnyxConfigurationResponse"},{"type":"null"}]}},"type":"object","title":"TelephonyConfigurationResponse","description":"Top-level telephony configuration response.\n\nKeeps the per-provider field shape that the UI client depends on. When\nthe UI moves to metadata-driven forms, this can be replaced with a\nflat discriminated union."},"TelephonyConfigurationUpdateRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":64,"minLength":1},{"type":"null"}],"title":"Name"},"config":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/ARIConfigurationRequest"},{"$ref":"#/components/schemas/CloudonixConfigurationRequest"},{"$ref":"#/components/schemas/PlivoConfigurationRequest"},{"$ref":"#/components/schemas/TelnyxConfigurationRequest"},{"$ref":"#/components/schemas/TwilioConfigurationRequest"},{"$ref":"#/components/schemas/VobizConfigurationRequest"},{"$ref":"#/components/schemas/VonageConfigurationRequest"}],"discriminator":{"propertyName":"provider","mapping":{"ari":"#/components/schemas/ARIConfigurationRequest","cloudonix":"#/components/schemas/CloudonixConfigurationRequest","plivo":"#/components/schemas/PlivoConfigurationRequest","telnyx":"#/components/schemas/TelnyxConfigurationRequest","twilio":"#/components/schemas/TwilioConfigurationRequest","vobiz":"#/components/schemas/VobizConfigurationRequest","vonage":"#/components/schemas/VonageConfigurationRequest"}}},{"type":"null"}],"title":"Config"}},"type":"object","title":"TelephonyConfigurationUpdateRequest","description":"Body for ``PUT /telephony-configs/{id}``. Partial update."},"TelephonyProviderMetadata":{"properties":{"provider":{"type":"string","title":"Provider"},"display_name":{"type":"string","title":"Display Name"},"fields":{"items":{"$ref":"#/components/schemas/TelephonyProviderUIField"},"type":"array","title":"Fields"},"docs_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Docs Url"}},"type":"object","required":["provider","display_name","fields"],"title":"TelephonyProviderMetadata","description":"UI form metadata for a single telephony provider."},"TelephonyProviderUIField":{"properties":{"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"type":{"type":"string","title":"Type"},"required":{"type":"boolean","title":"Required"},"sensitive":{"type":"boolean","title":"Sensitive"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"placeholder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Placeholder"}},"type":"object","required":["name","label","type","required","sensitive"],"title":"TelephonyProviderUIField","description":"One form field on a telephony provider's configuration UI."},"TelephonyProvidersMetadataResponse":{"properties":{"providers":{"items":{"$ref":"#/components/schemas/TelephonyProviderMetadata"},"type":"array","title":"Providers"}},"type":"object","required":["providers"],"title":"TelephonyProvidersMetadataResponse","description":"List of UI form definitions used by the telephony-config screen."},"TelnyxConfigurationRequest":{"properties":{"provider":{"type":"string","const":"telnyx","title":"Provider","default":"telnyx"},"api_key":{"type":"string","title":"Api Key","description":"Telnyx API Key"},"connection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connection Id","description":"Telnyx Call Control Application ID (connection_id). If omitted, a Call Control Application is auto-created on save and its id is stored on the configuration."},"webhook_public_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Public Key","description":"Webhook public key from Mission Control Portal \u2192 Keys & Credentials \u2192 Public Key. Used to verify Telnyx webhook signatures."},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Telnyx phone numbers"}},"type":"object","required":["api_key"],"title":"TelnyxConfigurationRequest","description":"Request schema for Telnyx configuration."},"TelnyxConfigurationResponse":{"properties":{"provider":{"type":"string","const":"telnyx","title":"Provider","default":"telnyx"},"api_key":{"type":"string","title":"Api Key"},"connection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connection Id"},"webhook_public_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Public Key"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["api_key","from_numbers"],"title":"TelnyxConfigurationResponse","description":"Response schema for Telnyx configuration with masked sensitive fields."},"TimeSlotRequest":{"properties":{"day_of_week":{"type":"integer","maximum":6.0,"minimum":0.0,"title":"Day Of Week"},"start_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","title":"Start Time"},"end_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","title":"End Time"}},"type":"object","required":["day_of_week","start_time","end_time"],"title":"TimeSlotRequest"},"TimeSlotResponse":{"properties":{"day_of_week":{"type":"integer","title":"Day Of Week"},"start_time":{"type":"string","title":"Start Time"},"end_time":{"type":"string","title":"End Time"}},"type":"object","required":["day_of_week","start_time","end_time"],"title":"TimeSlotResponse"},"ToolParameter":{"properties":{"name":{"type":"string","title":"Name","description":"Parameter name (used as key in request body)"},"type":{"type":"string","title":"Type","description":"Parameter type: string, number, or boolean"},"description":{"type":"string","title":"Description","description":"Description of what this parameter is for"},"required":{"type":"boolean","title":"Required","description":"Whether this parameter is required","default":true}},"type":"object","required":["name","type","description"],"title":"ToolParameter","description":"A parameter that the tool accepts."},"ToolResponse":{"properties":{"id":{"type":"integer","title":"Id"},"tool_uuid":{"type":"string","title":"Tool Uuid"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"category":{"type":"string","title":"Category"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"icon_color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Color"},"status":{"type":"string","title":"Status"},"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedByResponse"},{"type":"null"}]}},"type":"object","required":["id","tool_uuid","name","description","category","icon","icon_color","status","definition","created_at","updated_at"],"title":"ToolResponse","description":"Response schema for a tool."},"TransferCallConfig":{"properties":{"destination":{"type":"string","title":"Destination","description":"Phone number or SIP endpoint to transfer the call to (E.164 format e.g., +1234567890, or SIP endpoint e.g., PJSIP/1234)"},"messageType":{"type":"string","enum":["none","custom","audio"],"title":"Messagetype","description":"Type of message to play before transfer","default":"none"},"customMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custommessage","description":"Custom message to play before transferring the call"},"audioRecordingId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Audiorecordingid","description":"Recording ID for audio message before transfer"},"timeout":{"type":"integer","maximum":120.0,"minimum":5.0,"title":"Timeout","description":"Maximum time in seconds to wait for destination to answer (5-120 seconds)","default":30}},"type":"object","required":["destination"],"title":"TransferCallConfig","description":"Configuration for Transfer Call tools."},"TransferCallToolDefinition":{"properties":{"schema_version":{"type":"integer","title":"Schema Version","description":"Schema version","default":1},"type":{"type":"string","const":"transfer_call","title":"Type","description":"Tool type"},"config":{"$ref":"#/components/schemas/TransferCallConfig","description":"Transfer Call configuration"}},"type":"object","required":["type","config"],"title":"TransferCallToolDefinition","description":"Tool definition for Transfer Call tools."},"TriggerCallRequest":{"properties":{"phone_number":{"type":"string","title":"Phone Number"},"initial_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Initial Context"},"telephony_configuration_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Telephony Configuration Id"}},"type":"object","required":["phone_number"],"title":"TriggerCallRequest","description":"Request model for triggering a call via API"},"TriggerCallResponse":{"properties":{"status":{"type":"string","title":"Status"},"workflow_run_id":{"type":"integer","title":"Workflow Run Id"},"workflow_run_name":{"type":"string","title":"Workflow Run Name"}},"type":"object","required":["status","workflow_run_id","workflow_run_name"],"title":"TriggerCallResponse","description":"Response model for successful call initiation"},"TurnCredentialsResponse":{"properties":{"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"ttl":{"type":"integer","title":"Ttl"},"uris":{"items":{"type":"string"},"type":"array","title":"Uris"}},"type":"object","required":["username","password","ttl","uris"],"title":"TurnCredentialsResponse","description":"Response model for TURN credentials."},"TwilioConfigurationRequest":{"properties":{"provider":{"type":"string","const":"twilio","title":"Provider","default":"twilio"},"account_sid":{"type":"string","title":"Account Sid","description":"Twilio Account SID"},"auth_token":{"type":"string","title":"Auth Token","description":"Twilio Auth Token"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Twilio phone numbers"}},"type":"object","required":["account_sid","auth_token"],"title":"TwilioConfigurationRequest","description":"Request schema for Twilio configuration."},"TwilioConfigurationResponse":{"properties":{"provider":{"type":"string","const":"twilio","title":"Provider","default":"twilio"},"account_sid":{"type":"string","title":"Account Sid"},"auth_token":{"type":"string","title":"Auth Token"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["account_sid","auth_token","from_numbers"],"title":"TwilioConfigurationResponse","description":"Response schema for Twilio configuration with masked sensitive fields."},"UpdateCampaignRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name"},"retry_config":{"anyOf":[{"$ref":"#/components/schemas/RetryConfigRequest"},{"type":"null"}]},"max_concurrency":{"anyOf":[{"type":"integer","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Max Concurrency"},"schedule_config":{"anyOf":[{"$ref":"#/components/schemas/ScheduleConfigRequest"},{"type":"null"}]},"circuit_breaker":{"anyOf":[{"$ref":"#/components/schemas/CircuitBreakerConfigRequest"},{"type":"null"}]}},"type":"object","title":"UpdateCampaignRequest"},"UpdateCredentialRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"credential_type":{"anyOf":[{"$ref":"#/components/schemas/WebhookCredentialType"},{"type":"null"}]},"credential_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Credential Data"}},"type":"object","title":"UpdateCredentialRequest","description":"Request schema for updating a webhook credential."},"UpdateIntegrationRequest":{"properties":{"selected_files":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Selected Files"}},"type":"object","required":["selected_files"],"title":"UpdateIntegrationRequest"},"UpdateToolRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"icon":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"title":"Icon"},"icon_color":{"anyOf":[{"type":"string","maxLength":7},{"type":"null"}],"title":"Icon Color"},"definition":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/HttpApiToolDefinition"},{"$ref":"#/components/schemas/EndCallToolDefinition"},{"$ref":"#/components/schemas/TransferCallToolDefinition"},{"$ref":"#/components/schemas/CalculatorToolDefinition"}],"discriminator":{"propertyName":"type","mapping":{"calculator":"#/components/schemas/CalculatorToolDefinition","end_call":"#/components/schemas/EndCallToolDefinition","http_api":"#/components/schemas/HttpApiToolDefinition","transfer_call":"#/components/schemas/TransferCallToolDefinition"}}},{"type":"null"}],"title":"Definition"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","title":"UpdateToolRequest","description":"Request schema for updating a tool."},"UpdateWorkflowRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"workflow_definition":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Workflow Definition"},"template_context_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Template Context Variables"},"workflow_configurations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Workflow Configurations"}},"type":"object","title":"UpdateWorkflowRequest"},"UpdateWorkflowStatusRequest":{"properties":{"status":{"type":"string","title":"Status"}},"type":"object","required":["status"],"title":"UpdateWorkflowStatusRequest"},"UsageHistoryResponse":{"properties":{"runs":{"items":{"$ref":"#/components/schemas/WorkflowRunUsageResponse"},"type":"array","title":"Runs"},"total_dograh_tokens":{"type":"number","title":"Total Dograh Tokens"},"total_duration_seconds":{"type":"integer","title":"Total Duration Seconds"},"total_count":{"type":"integer","title":"Total Count"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"},"total_pages":{"type":"integer","title":"Total Pages"}},"type":"object","required":["runs","total_dograh_tokens","total_duration_seconds","total_count","page","limit","total_pages"],"title":"UsageHistoryResponse"},"UserConfigurationRequestResponseSchema":{"properties":{"llm":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Llm"},"tts":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Tts"},"stt":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Stt"},"embeddings":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Embeddings"},"realtime":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Realtime"},"is_realtime":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Realtime"},"test_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Test Phone Number"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone"},"organization_pricing":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"}]},"type":"object"},{"type":"null"}],"title":"Organization Pricing"}},"type":"object","title":"UserConfigurationRequestResponseSchema"},"UserResponse":{"properties":{"id":{"type":"integer","title":"Id"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"organization_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Organization Id"},"provider_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Id"}},"type":"object","required":["id","email"],"title":"UserResponse"},"ValidateWorkflowResponse":{"properties":{"is_valid":{"type":"boolean","title":"Is Valid"},"errors":{"items":{"$ref":"#/components/schemas/WorkflowError"},"type":"array","title":"Errors"}},"type":"object","required":["is_valid","errors"],"title":"ValidateWorkflowResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VobizConfigurationRequest":{"properties":{"provider":{"type":"string","const":"vobiz","title":"Provider","default":"vobiz"},"auth_id":{"type":"string","title":"Auth Id","description":"Vobiz Account ID (e.g., MA_SYQRLN1K)"},"auth_token":{"type":"string","title":"Auth Token","description":"Vobiz Auth Token"},"application_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Id","description":"Vobiz Application ID. The application's answer_url is updated when inbound workflows are attached to numbers on this account. If omitted, an application is auto-created on save and its id is stored on the configuration."},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Vobiz phone numbers (E.164 without + prefix)"}},"type":"object","required":["auth_id","auth_token"],"title":"VobizConfigurationRequest","description":"Request schema for Vobiz configuration."},"VobizConfigurationResponse":{"properties":{"provider":{"type":"string","const":"vobiz","title":"Provider","default":"vobiz"},"auth_id":{"type":"string","title":"Auth Id"},"auth_token":{"type":"string","title":"Auth Token"},"application_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Id"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["auth_id","auth_token","from_numbers"],"title":"VobizConfigurationResponse","description":"Response schema for Vobiz configuration with masked sensitive fields."},"VoiceInfo":{"properties":{"voice_id":{"type":"string","title":"Voice Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"accent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accent"},"gender":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gender"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"preview_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Preview Url"}},"type":"object","required":["voice_id","name"],"title":"VoiceInfo"},"VoicesResponse":{"properties":{"provider":{"type":"string","title":"Provider"},"voices":{"items":{"$ref":"#/components/schemas/VoiceInfo"},"type":"array","title":"Voices"}},"type":"object","required":["provider","voices"],"title":"VoicesResponse"},"VonageConfigurationRequest":{"properties":{"provider":{"type":"string","const":"vonage","title":"Provider","default":"vonage"},"api_key":{"type":"string","title":"Api Key","description":"Vonage API Key"},"api_secret":{"type":"string","title":"Api Secret","description":"Vonage API Secret"},"application_id":{"type":"string","title":"Application Id","description":"Vonage Application ID"},"private_key":{"type":"string","title":"Private Key","description":"Private key for JWT generation"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Vonage phone numbers (without + prefix)"}},"type":"object","required":["api_key","api_secret","application_id","private_key"],"title":"VonageConfigurationRequest","description":"Request schema for Vonage configuration."},"VonageConfigurationResponse":{"properties":{"provider":{"type":"string","const":"vonage","title":"Provider","default":"vonage"},"application_id":{"type":"string","title":"Application Id"},"api_key":{"type":"string","title":"Api Key"},"api_secret":{"type":"string","title":"Api Secret"},"private_key":{"type":"string","title":"Private Key"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["application_id","api_key","api_secret","private_key","from_numbers"],"title":"VonageConfigurationResponse","description":"Response schema for Vonage configuration with masked sensitive fields."},"WebhookCredentialType":{"type":"string","enum":["none","api_key","bearer_token","basic_auth","custom_header"],"title":"WebhookCredentialType","description":"Webhook credential authentication types"},"WorkflowCountResponse":{"properties":{"total":{"type":"integer","title":"Total"},"active":{"type":"integer","title":"Active"},"archived":{"type":"integer","title":"Archived"}},"type":"object","required":["total","active","archived"],"title":"WorkflowCountResponse","description":"Response for workflow count endpoint."},"WorkflowError":{"properties":{"kind":{"$ref":"#/components/schemas/ItemKind"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field"},"message":{"type":"string","title":"Message"}},"type":"object","required":["kind","id","field","message"],"title":"WorkflowError"},"WorkflowListResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"status":{"type":"string","title":"Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"total_runs":{"type":"integer","title":"Total Runs"}},"type":"object","required":["id","name","status","created_at","total_runs"],"title":"WorkflowListResponse","description":"Lightweight response for workflow listings (excludes large fields)."},"WorkflowOption":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"WorkflowOption"},"WorkflowResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"status":{"type":"string","title":"Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"workflow_definition":{"additionalProperties":true,"type":"object","title":"Workflow Definition"},"current_definition_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Current Definition Id"},"template_context_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Template Context Variables"},"call_disposition_codes":{"anyOf":[{"$ref":"#/components/schemas/CallDispositionCodes"},{"type":"null"}]},"total_runs":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Runs"},"workflow_configurations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Workflow Configurations"},"version_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Number"},"version_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version Status"},"workflow_uuid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Uuid"}},"type":"object","required":["id","name","status","created_at","workflow_definition","current_definition_id"],"title":"WorkflowResponse"},"WorkflowRunDetail":{"properties":{"phone_number":{"type":"string","title":"Phone Number"},"disposition":{"type":"string","title":"Disposition"},"duration_seconds":{"type":"number","title":"Duration Seconds"},"workflow_id":{"type":"integer","title":"Workflow Id"},"run_id":{"type":"integer","title":"Run Id"},"workflow_name":{"type":"string","title":"Workflow Name"},"created_at":{"type":"string","title":"Created At"}},"type":"object","required":["phone_number","disposition","duration_seconds","workflow_id","run_id","workflow_name","created_at"],"title":"WorkflowRunDetail"},"WorkflowRunResponseSchema":{"properties":{"id":{"type":"integer","title":"Id"},"workflow_id":{"type":"integer","title":"Workflow Id"},"name":{"type":"string","title":"Name"},"mode":{"type":"string","title":"Mode"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"is_completed":{"type":"boolean","title":"Is Completed"},"transcript_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcript Url"},"recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Url"},"cost_info":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Cost Info"},"definition_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Definition Id"},"initial_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Initial Context"},"gathered_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Gathered Context"},"call_type":{"$ref":"#/components/schemas/CallType"},"logs":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Logs"},"annotations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Annotations"}},"type":"object","required":["id","workflow_id","name","mode","created_at","is_completed","transcript_url","recording_url","cost_info","definition_id","call_type"],"title":"WorkflowRunResponseSchema"},"WorkflowRunUsageResponse":{"properties":{"id":{"type":"integer","title":"Id"},"workflow_id":{"type":"integer","title":"Workflow Id"},"workflow_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Name"},"name":{"type":"string","title":"Name"},"created_at":{"type":"string","title":"Created At"},"dograh_token_usage":{"type":"number","title":"Dograh Token Usage"},"call_duration_seconds":{"type":"integer","title":"Call Duration Seconds"},"recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Url"},"transcript_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcript Url"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Deprecated. Use caller_number and called_number instead.","deprecated":true},"caller_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Caller Number"},"called_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Called Number"},"call_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Type"},"disposition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disposition"},"initial_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Initial Context"},"gathered_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Gathered Context"},"charge_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Charge Usd"}},"type":"object","required":["id","workflow_id","workflow_name","name","created_at","dograh_token_usage","call_duration_seconds"],"title":"WorkflowRunUsageResponse"},"WorkflowRunsResponse":{"properties":{"runs":{"items":{"$ref":"#/components/schemas/WorkflowRunResponseSchema"},"type":"array","title":"Runs"},"total_count":{"type":"integer","title":"Total Count"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"},"total_pages":{"type":"integer","title":"Total Pages"},"applied_filters":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Applied Filters"}},"type":"object","required":["runs","total_count","page","limit","total_pages"],"title":"WorkflowRunsResponse"},"WorkflowSummaryResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"WorkflowSummaryResponse"},"WorkflowTemplateResponse":{"properties":{"id":{"type":"integer","title":"Id"},"template_name":{"type":"string","title":"Template Name"},"template_description":{"type":"string","title":"Template Description"},"template_json":{"additionalProperties":true,"type":"object","title":"Template Json"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","template_name","template_description","template_json","created_at"],"title":"WorkflowTemplateResponse"},"WorkflowVersionResponse":{"properties":{"id":{"type":"integer","title":"Id"},"version_number":{"type":"integer","title":"Version Number"},"status":{"type":"string","title":"Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"published_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Published At"},"workflow_json":{"additionalProperties":true,"type":"object","title":"Workflow Json"},"workflow_configurations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Workflow Configurations"},"template_context_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Template Context Variables"}},"type":"object","required":["id","version_number","status","created_at","workflow_json"],"title":"WorkflowVersionResponse"}}}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Dograh API","description":"API for the Dograh app","version":"1.0.0"},"servers":[{"url":"https://app.dograh.com","description":"Production"},{"url":"http://localhost:8000","description":"Local development"}],"paths":{"/api/v1/telephony/initiate-call":{"post":{"tags":["main"],"summary":"Initiate Call","description":"Initiate a call using the configured telephony provider from web browser. This is\nsupposed to be a test call method for the draft version of the agent.","operationId":"initiate_call_api_v1_telephony_initiate_call_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateCallRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"test_phone_call","x-sdk-description":"Place a test call from a workflow to a phone number."}},"/api/v1/telephony/inbound/run":{"post":{"tags":["main"],"summary":"Handle Inbound Run","description":"Workflow-agnostic inbound dispatcher.\n\nAll providers can point a single webhook at this endpoint instead of one\nURL per workflow. The dispatcher resolves the org from the webhook's\naccount_id and the workflow from the called number's\n``inbound_workflow_id``. This is what ``configure_inbound`` writes into\neach provider's resource so per-workflow webhook bookkeeping disappears.\n\nProvider-specific signature/timestamp headers are not enumerated here \u2014\neach provider's ``verify_inbound_signature`` reads its own headers from\nthe dict, so adding a new provider doesn't require changes to this route.","operationId":"handle_inbound_run_api_v1_telephony_inbound_run_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"}}}},"/api/v1/telephony/inbound/fallback":{"post":{"tags":["main"],"summary":"Handle Inbound Fallback","description":"Fallback endpoint that returns audio message when calls cannot be processed.","operationId":"handle_inbound_fallback_api_v1_telephony_inbound_fallback_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"}}}},"/api/v1/telephony/inbound/{workflow_id}":{"post":{"tags":["main"],"summary":"Handle Inbound Telephony","description":"[LEGACY] Per-workflow inbound webhook.\n\nSuperseded by ``POST /inbound/run``, which resolves the workflow from\nthe called number's ``inbound_workflow_id`` and lets a single webhook\nURL serve every workflow in the org. New integrations should point\ntheir provider at ``/inbound/run``; this route is kept only for\nexisting provider configurations that still encode ``workflow_id``\nin the URL.","operationId":"handle_inbound_telephony_api_v1_telephony_inbound__workflow_id__post","deprecated":true,"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/transfer-result/{transfer_id}":{"post":{"tags":["main"],"summary":"Complete Transfer Function Call","description":"Webhook endpoint to complete the function call with transfer result.\n\nCalled by Twilio's StatusCallback when the transfer call status changes.","operationId":"complete_transfer_function_call_api_v1_telephony_transfer_result__transfer_id__post","parameters":[{"name":"transfer_id","in":"path","required":true,"schema":{"type":"string","title":"Transfer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/cloudonix/status-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Cloudonix Status Callback","description":"Handle Cloudonix-specific status callbacks.\n\nCloudonix sends call status updates to the callback URL specified during call initiation.","operationId":"handle_cloudonix_status_callback_api_v1_telephony_cloudonix_status_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/cloudonix/cdr":{"post":{"tags":["main"],"summary":"Handle Cloudonix Cdr","description":"Handle Cloudonix CDR (Call Detail Record) webhooks.\n\nCloudonix sends CDR records when calls complete. The CDR contains:\n- domain: Used to identify the organization\n- call_id: Used to find the workflow run\n- disposition: Call termination status (ANSWER, BUSY, CANCEL, FAILED, CONGESTION, NOANSWER)\n- duration/billsec: Call duration information","operationId":"handle_cloudonix_cdr_api_v1_telephony_cloudonix_cdr_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"}}}},"/api/v1/telephony/plivo/hangup-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Plivo Hangup Callback","description":"Handle Plivo hangup callbacks.","operationId":"handle_plivo_hangup_callback_api_v1_telephony_plivo_hangup_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}},{"name":"x-plivo-signature-v3","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-V3"}},{"name":"x-plivo-signature-ma-v3","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-Ma-V3"}},{"name":"x-plivo-signature-v3-nonce","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-V3-Nonce"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/plivo/ring-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Plivo Ring Callback","description":"Handle Plivo ring callbacks.","operationId":"handle_plivo_ring_callback_api_v1_telephony_plivo_ring_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}},{"name":"x-plivo-signature-v3","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-V3"}},{"name":"x-plivo-signature-ma-v3","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-Ma-V3"}},{"name":"x-plivo-signature-v3-nonce","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Plivo-Signature-V3-Nonce"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/telnyx/events/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Telnyx Events","description":"Handle Telnyx Call Control webhook events.\n\nTelnyx sends all call lifecycle events (call.initiated, call.answered,\ncall.hangup, streaming.started, streaming.stopped) as JSON POST requests.","operationId":"handle_telnyx_events_api_v1_telephony_telnyx_events__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/telnyx/transfer-result/{transfer_id}":{"post":{"tags":["main"],"summary":"Handle Telnyx Transfer Result","description":"Handle Telnyx Call Control events for the transfer destination leg.\n\nThe destination leg is dialed by :meth:`TelnyxProvider.transfer_call` with\nthis URL as ``webhook_url``. Telnyx sends every event for that leg here.\nOutcomes:\n\n- ``call.answered``: seed a conference with the destination's live\n ``call_control_id``, stamp ``conference_id`` onto the TransferContext,\n and publish ``DESTINATION_ANSWERED`` so ``transfer_call_handler`` can\n end the pipeline. ``TelnyxConferenceStrategy`` then joins the caller\n into this conference at pipeline teardown.\n- ``call.hangup`` pre-answer (no ``conference_id`` on the context):\n publish ``TRANSFER_FAILED`` so the LLM can recover.\n- ``call.hangup`` post-answer (``conference_id`` set): the destination\n left a bridged conference; hang up the caller's leg to tear down the\n empty bridge (Telnyx's create_conference doesn't accept\n ``end_conference_on_exit`` on the seed leg).\n\nEvent references:\n - call.answered: https://developers.telnyx.com/api-reference/callbacks/call-answered\n - call.hangup: https://developers.telnyx.com/api-reference/callbacks/call-hangup","operationId":"handle_telnyx_transfer_result_api_v1_telephony_telnyx_transfer_result__transfer_id__post","parameters":[{"name":"transfer_id","in":"path","required":true,"schema":{"type":"string","title":"Transfer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/twilio/status-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Twilio Status Callback","description":"Handle Twilio-specific status callbacks.","operationId":"handle_twilio_status_callback_api_v1_telephony_twilio_status_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}},{"name":"x-webhook-signature","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Webhook-Signature"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/vobiz/hangup-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Vobiz Hangup Callback","description":"Handle Vobiz hangup callback (sent when call ends).\n\nVobiz sends callbacks to hangup_url when the call terminates.\nThis includes call duration, status, and billing information.","operationId":"handle_vobiz_hangup_callback_api_v1_telephony_vobiz_hangup_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}},{"name":"x-vobiz-signature","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Signature"}},{"name":"x-vobiz-timestamp","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Timestamp"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/vobiz/ring-callback/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Vobiz Ring Callback","description":"Handle Vobiz ring callback (sent when call starts ringing).\n\nVobiz can send callbacks to ring_url when the call starts ringing.\nThis is optional and used for tracking ringing status.","operationId":"handle_vobiz_ring_callback_api_v1_telephony_vobiz_ring_callback__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}},{"name":"x-vobiz-signature","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Signature"}},{"name":"x-vobiz-timestamp","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Timestamp"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/vobiz/hangup-callback/workflow/{workflow_id}":{"post":{"tags":["main"],"summary":"Handle Vobiz Hangup Callback By Workflow","description":"Handle Vobiz hangup callback with workflow_id - finds workflow run by call_id.","operationId":"handle_vobiz_hangup_callback_by_workflow_api_v1_telephony_vobiz_hangup_callback_workflow__workflow_id__post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"x-vobiz-signature","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Signature"}},{"name":"x-vobiz-timestamp","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vobiz-Timestamp"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/telephony/vonage/events/{workflow_run_id}":{"post":{"tags":["main"],"summary":"Handle Vonage Events","description":"Handle Vonage-specific event webhooks.\n\nVonage sends all call events to a single endpoint.\nEvents include: started, ringing, answered, complete, failed, etc.","operationId":"handle_vonage_events_api_v1_telephony_vonage_events__workflow_run_id__post","parameters":[{"name":"workflow_run_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/superuser/impersonate":{"post":{"tags":["main","superuser"],"summary":"Impersonate","description":"Impersonate a user as a super-admin.\nInternally, Stack Auth requires the **provider user ID** (a UUID-ish string)\nto create an impersonation session.","operationId":"impersonate_api_v1_superuser_impersonate_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpersonateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpersonateResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/superuser/workflow-runs":{"get":{"tags":["main","superuser"],"summary":"Get Workflow Runs","description":"Get paginated list of all workflow runs with organization information.\nRequires superuser privileges.\n\nFilters should be provided as a JSON-encoded array of filter criteria.\nExample: [{\"field\": \"id\", \"type\": \"number\", \"value\": {\"value\": 680}}]","operationId":"get_workflow_runs_api_v1_superuser_workflow_runs_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number (starts from 1)","default":1,"title":"Page"},"description":"Page number (starts from 1)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of items per page","default":50,"title":"Limit"},"description":"Number of items per page"},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded filter criteria","title":"Filters"},"description":"JSON-encoded filter criteria"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Field to sort by (e.g., 'duration', 'created_at')","title":"Sort By"},"description":"Field to sort by (e.g., 'duration', 'created_at')"},{"name":"sort_order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort order ('asc' or 'desc')","default":"desc","title":"Sort Order"},"description":"Sort order ('asc' or 'desc')"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuperuserWorkflowRunsListResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/validate":{"post":{"tags":["main"],"summary":"Validate Workflow","description":"Validate all nodes in a workflow to ensure they have required fields.\n\nArgs:\n workflow_id: The ID of the workflow to validate\n user: The authenticated user\n\nReturns:\n Object indicating if workflow is valid and any invalid nodes/edges","operationId":"validate_workflow_api_v1_workflow__workflow_id__validate_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateWorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/create/definition":{"post":{"tags":["main"],"summary":"Create Workflow","description":"Create a new workflow from the client\n\nArgs:\n request: The create workflow request\n user: The user to create the workflow for","operationId":"create_workflow_api_v1_workflow_create_definition_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"create_workflow","x-sdk-description":"Create a new workflow from a workflow definition."}},"/api/v1/workflow/create/template":{"post":{"tags":["main"],"summary":"Create Workflow From Template","description":"Create a new workflow from a natural language template request.\n\nThis endpoint:\n1. Uses mps_service_key_client to call MPS workflow API\n2. Passes organization ID (authenticated mode) or created_by (OSS mode)\n3. Creates the workflow in the database\n\nArgs:\n request: The template creation request with call_type, use_case, and activity_description\n user: The authenticated user\n\nReturns:\n The created workflow\n\nRaises:\n HTTPException: If MPS API call fails","operationId":"create_workflow_from_template_api_v1_workflow_create_template_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowTemplateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/count":{"get":{"tags":["main"],"summary":"Get Workflow Count","description":"Get workflow counts for the authenticated user's organization.\n\nThis is a lightweight endpoint for checking if the user has workflows,\nuseful for redirect logic without fetching full workflow data.","operationId":"get_workflow_count_api_v1_workflow_count_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCountResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/fetch":{"get":{"tags":["main"],"summary":"Get Workflows","description":"Get all workflows for the authenticated user's organization.\n\nReturns a lightweight response with only essential fields for listing.\nUse GET /workflow/fetch/{workflow_id} to get full workflow details.","operationId":"get_workflows_api_v1_workflow_fetch_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by status - can be single value (active/archived) or comma-separated (active,archived)","title":"Status"},"description":"Filter by status - can be single value (active/archived) or comma-separated (active,archived)"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowListResponse"},"title":"Response Get Workflows Api V1 Workflow Fetch Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_workflows","x-sdk-description":"List all workflows in the authenticated organization."}},"/api/v1/workflow/fetch/{workflow_id}":{"get":{"tags":["main"],"summary":"Get Workflow","description":"Get a single workflow by ID.\n\nIf a draft version exists, returns the draft content for editing.\nOtherwise returns the published version's content.","operationId":"get_workflow_api_v1_workflow_fetch__workflow_id__get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"get_workflow","x-sdk-description":"Get a single workflow by ID (returns draft if one exists, else published)."}},"/api/v1/workflow/{workflow_id}/versions":{"get":{"tags":["main"],"summary":"Get Workflow Versions","description":"List versions for a workflow, newest first.\n\nPass `limit`/`offset` to page through long histories. With no `limit`,\nreturns every version (legacy behavior).","operationId":"get_workflow_versions_api_v1_workflow__workflow_id__versions_get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":100,"minimum":1},{"type":"null"}],"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowVersionResponse"},"title":"Response Get Workflow Versions Api V1 Workflow Workflow Id Versions Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/publish":{"post":{"tags":["main"],"summary":"Publish Workflow","description":"Publish the current draft version of a workflow.\n\nDrafts are allowed to be incomplete (so the editor can save mid-edit),\nbut a published version is what runtime executes \u2014 so this is the gate\nwhere the full DTO + graph + trigger-conflict checks must pass.","operationId":"publish_workflow_api_v1_workflow__workflow_id__publish_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/create-draft":{"post":{"tags":["main"],"summary":"Create Workflow Draft","description":"Create a draft version from the current published version.\n\nIf a draft already exists, returns the existing draft.","operationId":"create_workflow_draft_api_v1_workflow__workflow_id__create_draft_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowVersionResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/summary":{"get":{"tags":["main"],"summary":"Get Workflows Summary","description":"Get minimal workflow information (id and name only) for all workflows","operationId":"get_workflows_summary_api_v1_workflow_summary_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by status (e.g. 'active' or 'archived'). Omit to return all.","title":"Status"},"description":"Filter by status (e.g. 'active' or 'archived'). Omit to return all."},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowSummaryResponse"},"title":"Response Get Workflows Summary Api V1 Workflow Summary Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/status":{"put":{"tags":["main"],"summary":"Update Workflow Status","description":"Update the status of a workflow (e.g., archive/unarchive).\n\nArgs:\n workflow_id: The ID of the workflow to update\n request: The status update request\n\nReturns:\n The updated workflow","operationId":"update_workflow_status_api_v1_workflow__workflow_id__status_put","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkflowStatusRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}":{"put":{"tags":["main"],"summary":"Update Workflow","description":"Update an existing workflow.\n\nArgs:\n workflow_id: The ID of the workflow to update\n request: The update request containing the new name and workflow definition\n\nReturns:\n The updated workflow\n\nRaises:\n HTTPException: If the workflow is not found or if there's a database error","operationId":"update_workflow_api_v1_workflow__workflow_id__put","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkflowRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"update_workflow","x-sdk-description":"Update a workflow's name and/or definition. Saves as a new draft."}},"/api/v1/workflow/{workflow_id}/duplicate":{"post":{"tags":["main"],"summary":"Duplicate Workflow Endpoint","description":"Duplicate a workflow including its definition, configuration, recordings, and triggers.","operationId":"duplicate_workflow_endpoint_api_v1_workflow__workflow_id__duplicate_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/runs":{"post":{"tags":["main"],"summary":"Create Workflow Run","description":"Create a new workflow run when the user decides to execute the workflow via chat or voice\n\nArgs:\n workflow_id: The ID of the workflow to run\n request: The create workflow run request\n user: The user to create the workflow run for","operationId":"create_workflow_run_api_v1_workflow__workflow_id__runs_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowRunRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowRunResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["main"],"summary":"Get Workflow Runs","description":"Get workflow runs with optional filtering and sorting.\n\nFilters should be provided as a JSON-encoded array of filter criteria.\nExample: [{\"attribute\": \"dateRange\", \"value\": {\"from\": \"2024-01-01\", \"to\": \"2024-01-31\"}}]","operationId":"get_workflow_runs_api_v1_workflow__workflow_id__runs_get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded filter criteria","title":"Filters"},"description":"JSON-encoded filter criteria"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Field to sort by (e.g., 'duration', 'created_at')","title":"Sort By"},"description":"Field to sort by (e.g., 'duration', 'created_at')"},{"name":"sort_order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort order ('asc' or 'desc')","default":"desc","title":"Sort Order"},"description":"Sort order ('asc' or 'desc')"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRunsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/runs/{run_id}":{"get":{"tags":["main"],"summary":"Get Workflow Run","operationId":"get_workflow_run_api_v1_workflow__workflow_id__runs__run_id__get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"run_id","in":"path","required":true,"schema":{"type":"integer","title":"Run Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowRunResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/report":{"get":{"tags":["main"],"summary":"Download Workflow Report","description":"Download a CSV report of completed runs for a workflow.","operationId":"download_workflow_report_api_v1_workflow__workflow_id__report_get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter runs created on or after this datetime (ISO 8601)","title":"Start Date"},"description":"Filter runs created on or after this datetime (ISO 8601)"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter runs created on or before this datetime (ISO 8601)","title":"End Date"},"description":"Filter runs created on or before this datetime (ISO 8601)"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/templates":{"get":{"tags":["main"],"summary":"Get Workflow Templates","description":"Get all available workflow templates.\n\nReturns:\n List of workflow templates","operationId":"get_workflow_templates_api_v1_workflow_templates_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/WorkflowTemplateResponse"},"type":"array","title":"Response Get Workflow Templates Api V1 Workflow Templates Get"}}}},"404":{"description":"Not found"}}}},"/api/v1/workflow/templates/duplicate":{"post":{"tags":["main"],"summary":"Duplicate Workflow Template","description":"Duplicate a workflow template to create a new workflow for the user.\n\nArgs:\n request: The duplicate template request\n user: The authenticated user\n\nReturns:\n The newly created workflow","operationId":"duplicate_workflow_template_api_v1_workflow_templates_duplicate_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateTemplateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/ambient-noise/upload-url":{"post":{"tags":["main"],"summary":"Get a presigned URL to upload a custom ambient noise audio file","description":"Generate a presigned PUT URL for uploading a custom ambient noise file.","operationId":"get_ambient_noise_upload_url_api_v1_workflow_ambient_noise_upload_url_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmbientNoiseUploadRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmbientNoiseUploadResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/configurations/defaults":{"get":{"tags":["main"],"summary":"Get Default Configurations","operationId":"get_default_configurations_api_v1_user_configurations_defaults_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultConfigurationsResponse"}}}},"404":{"description":"Not found"}}}},"/api/v1/user/auth/user":{"get":{"tags":["main"],"summary":"Get Auth User","operationId":"get_auth_user_api_v1_user_auth_user_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthUserResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/configurations/user":{"get":{"tags":["main"],"summary":"Get User Configurations","operationId":"get_user_configurations_api_v1_user_configurations_user_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserConfigurationRequestResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["main"],"summary":"Update User Configurations","operationId":"update_user_configurations_api_v1_user_configurations_user_put","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserConfigurationRequestResponseSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserConfigurationRequestResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/configurations/user/validate":{"get":{"tags":["main"],"summary":"Validate User Configurations","operationId":"validate_user_configurations_api_v1_user_configurations_user_validate_get","parameters":[{"name":"validity_ttl_seconds","in":"query","required":false,"schema":{"type":"integer","maximum":86400,"minimum":0,"default":60,"title":"Validity Ttl Seconds"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKeyStatusResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/api-keys":{"get":{"tags":["main"],"summary":"Get Api Keys","description":"Get all API keys for the user's selected organization.","operationId":"get_api_keys_api_v1_user_api_keys_get","parameters":[{"name":"include_archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Archived"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIKeyResponse"},"title":"Response Get Api Keys Api V1 User Api Keys Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main"],"summary":"Create Api Key","description":"Create a new API key for the user's selected organization.","operationId":"create_api_key_api_v1_user_api_keys_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIKeyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPIKeyResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/api-keys/{api_key_id}":{"delete":{"tags":["main"],"summary":"Archive Api Key","description":"Archive an API key (soft delete).","operationId":"archive_api_key_api_v1_user_api_keys__api_key_id__delete","parameters":[{"name":"api_key_id","in":"path","required":true,"schema":{"type":"integer","title":"Api Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Archive Api Key Api V1 User Api Keys Api Key Id Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/api-keys/{api_key_id}/reactivate":{"put":{"tags":["main"],"summary":"Reactivate Api Key","description":"Reactivate an archived API key.","operationId":"reactivate_api_key_api_v1_user_api_keys__api_key_id__reactivate_put","parameters":[{"name":"api_key_id","in":"path","required":true,"schema":{"type":"integer","title":"Api Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Reactivate Api Key Api V1 User Api Keys Api Key Id Reactivate Put"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/configurations/voices/{provider}":{"get":{"tags":["main"],"summary":"Get Voices","description":"Get available voices for a TTS provider.","operationId":"get_voices_api_v1_user_configurations_voices__provider__get","parameters":[{"name":"provider","in":"path","required":true,"schema":{"enum":["elevenlabs","deepgram","sarvam","cartesia","dograh","rime"],"type":"string","title":"Provider"}},{"name":"model","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"}},{"name":"language","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoicesResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/create":{"post":{"tags":["main"],"summary":"Create Campaign","description":"Create a new campaign","operationId":"create_campaign_api_v1_campaign_create_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/":{"get":{"tags":["main"],"summary":"Get Campaigns","description":"Get campaigns for user's organization","operationId":"get_campaigns_api_v1_campaign__get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}":{"get":{"tags":["main"],"summary":"Get Campaign","description":"Get campaign details","operationId":"get_campaign_api_v1_campaign__campaign_id__get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["main"],"summary":"Update Campaign","description":"Update campaign settings (name, retry config, max concurrency, schedule)","operationId":"update_campaign_api_v1_campaign__campaign_id__patch","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/start":{"post":{"tags":["main"],"summary":"Start Campaign","description":"Start campaign execution","operationId":"start_campaign_api_v1_campaign__campaign_id__start_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/pause":{"post":{"tags":["main"],"summary":"Pause Campaign","description":"Pause campaign execution","operationId":"pause_campaign_api_v1_campaign__campaign_id__pause_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/runs":{"get":{"tags":["main"],"summary":"Get Campaign Runs","description":"Get campaign workflow runs with pagination, filters and sorting","operationId":"get_campaign_runs_api_v1_campaign__campaign_id__runs_get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded filter criteria","title":"Filters"},"description":"JSON-encoded filter criteria"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Field to sort by (e.g., 'duration', 'created_at')","title":"Sort By"},"description":"Field to sort by (e.g., 'duration', 'created_at')"},{"name":"sort_order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort order ('asc' or 'desc')","default":"desc","title":"Sort Order"},"description":"Sort order ('asc' or 'desc')"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignRunsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/redial":{"post":{"tags":["main"],"summary":"Redial Campaign","description":"Create a new campaign that re-dials unique subscribers from a completed\ncampaign whose latest call resulted in voicemail, no-answer, or busy.\n\nThe new campaign is created in 'created' state with queued_runs pre-seeded\nfrom the parent's original initial contexts. A campaign can be redialed at\nmost once.","operationId":"redial_campaign_api_v1_campaign__campaign_id__redial_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedialCampaignRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/resume":{"post":{"tags":["main"],"summary":"Resume Campaign","description":"Resume a paused campaign","operationId":"resume_campaign_api_v1_campaign__campaign_id__resume_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/progress":{"get":{"tags":["main"],"summary":"Get Campaign Progress","description":"Get current campaign progress and statistics","operationId":"get_campaign_progress_api_v1_campaign__campaign_id__progress_get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignProgressResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/source-download-url":{"get":{"tags":["main"],"summary":"Get Campaign Source Download Url","description":"Get presigned download URL for campaign CSV source file\nValidates that the campaign belongs to the user's organization for security.","operationId":"get_campaign_source_download_url_api_v1_campaign__campaign_id__source_download_url_get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignSourceDownloadResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaign/{campaign_id}/report":{"get":{"tags":["main"],"summary":"Download Campaign Report","description":"Download a CSV report of completed campaign runs.","operationId":"download_campaign_report_api_v1_campaign__campaign_id__report_get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"integer","title":"Campaign Id"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter runs created on or after this datetime (ISO 8601)","title":"Start Date"},"description":"Filter runs created on or after this datetime (ISO 8601)"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter runs created on or before this datetime (ISO 8601)","title":"End Date"},"description":"Filter runs created on or before this datetime (ISO 8601)"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/credentials/":{"get":{"tags":["main"],"summary":"List Credentials","description":"List all webhook credentials for the user's organization.\n\nReturns:\n List of credentials (without sensitive data)","operationId":"list_credentials_api_v1_credentials__get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CredentialResponse"},"title":"Response List Credentials Api V1 Credentials Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_credentials","x-sdk-description":"List webhook credentials available to the authenticated organization."},"post":{"tags":["main"],"summary":"Create Credential","description":"Create a new webhook credential.\n\nArgs:\n request: The credential creation request\n\nReturns:\n The created credential (without sensitive data)","operationId":"create_credential_api_v1_credentials__post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/credentials/{credential_uuid}":{"get":{"tags":["main"],"summary":"Get Credential","description":"Get a specific webhook credential by UUID.\n\nArgs:\n credential_uuid: The UUID of the credential\n\nReturns:\n The credential (without sensitive data)","operationId":"get_credential_api_v1_credentials__credential_uuid__get","parameters":[{"name":"credential_uuid","in":"path","required":true,"schema":{"type":"string","title":"Credential Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["main"],"summary":"Update Credential","description":"Update a webhook credential.\n\nArgs:\n credential_uuid: The UUID of the credential to update\n request: The update request\n\nReturns:\n The updated credential (without sensitive data)","operationId":"update_credential_api_v1_credentials__credential_uuid__put","parameters":[{"name":"credential_uuid","in":"path","required":true,"schema":{"type":"string","title":"Credential Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCredentialRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main"],"summary":"Delete Credential","description":"Delete (soft delete) a webhook credential.\n\nArgs:\n credential_uuid: The UUID of the credential to delete\n\nReturns:\n Success message","operationId":"delete_credential_api_v1_credentials__credential_uuid__delete","parameters":[{"name":"credential_uuid","in":"path","required":true,"schema":{"type":"string","title":"Credential Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Credential Api V1 Credentials Credential Uuid Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tools/":{"get":{"tags":["main"],"summary":"List Tools","description":"List all tools for the user's organization.\n\nArgs:\n status: Optional filter by status (active, archived, draft)\n category: Optional filter by category (http_api, native, integration)\n\nReturns:\n List of tools","operationId":"list_tools_api_v1_tools__get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ToolResponse"},"title":"Response List Tools Api V1 Tools Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_tools","x-sdk-description":"List tools available to the authenticated organization."},"post":{"tags":["main"],"summary":"Create Tool","description":"Create a new tool.\n\nArgs:\n request: The tool creation request\n\nReturns:\n The created tool","operationId":"create_tool_api_v1_tools__post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateToolRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tools/{tool_uuid}":{"get":{"tags":["main"],"summary":"Get Tool","description":"Get a specific tool by UUID.\n\nArgs:\n tool_uuid: The UUID of the tool\n\nReturns:\n The tool","operationId":"get_tool_api_v1_tools__tool_uuid__get","parameters":[{"name":"tool_uuid","in":"path","required":true,"schema":{"type":"string","title":"Tool Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["main"],"summary":"Update Tool","description":"Update a tool.\n\nArgs:\n tool_uuid: The UUID of the tool to update\n request: The update request\n\nReturns:\n The updated tool","operationId":"update_tool_api_v1_tools__tool_uuid__put","parameters":[{"name":"tool_uuid","in":"path","required":true,"schema":{"type":"string","title":"Tool Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateToolRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main"],"summary":"Delete Tool","description":"Archive (soft delete) a tool.\n\nArgs:\n tool_uuid: The UUID of the tool to delete\n\nReturns:\n Success message","operationId":"delete_tool_api_v1_tools__tool_uuid__delete","parameters":[{"name":"tool_uuid","in":"path","required":true,"schema":{"type":"string","title":"Tool Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Tool Api V1 Tools Tool Uuid Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tools/{tool_uuid}/mcp/refresh":{"post":{"tags":["main"],"summary":"Refresh Mcp Tools","description":"Re-discover an MCP tool's server catalog and overwrite the cached\n``definition.config.discovered_tools``. Server down \u2192 200 with error\n(cache not overwritten on transient failure).","operationId":"refresh_mcp_tools_api_v1_tools__tool_uuid__mcp_refresh_post","parameters":[{"name":"tool_uuid","in":"path","required":true,"schema":{"type":"string","title":"Tool Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/McpRefreshResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tools/{tool_uuid}/unarchive":{"post":{"tags":["main"],"summary":"Unarchive Tool","description":"Unarchive a tool (restore from archived state).\n\nArgs:\n tool_uuid: The UUID of the tool to unarchive\n\nReturns:\n The unarchived tool","operationId":"unarchive_tool_api_v1_tools__tool_uuid__unarchive_post","parameters":[{"name":"tool_uuid","in":"path","required":true,"schema":{"type":"string","title":"Tool Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-providers/metadata":{"get":{"tags":["main","organizations"],"summary":"Get Telephony Providers Metadata","description":"Return the list of available telephony providers and their form schemas.\n\nThe UI uses this to render the configuration form generically instead of\nhard-coding fields per provider. Adding a new provider only requires\ndeclaring its ui_metadata in providers//__init__.py.","operationId":"get_telephony_providers_metadata_api_v1_organizations_telephony_providers_metadata_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyProvidersMetadataResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-config-warnings":{"get":{"tags":["main","organizations"],"summary":"Get Telephony Config Warnings","description":"Return aggregated warning counts for the current org's telephony configs.\n\nToday this surfaces only Telnyx configs missing ``webhook_public_key``;\nadditional warning types should be added as new fields on the response.","operationId":"get_telephony_config_warnings_api_v1_organizations_telephony_config_warnings_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigWarningsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs":{"get":{"tags":["main","organizations"],"summary":"List Telephony Configurations","description":"List the org's telephony configurations with phone-number counts.","operationId":"list_telephony_configurations_api_v1_organizations_telephony_configs_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationListResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main","organizations"],"summary":"Create Telephony Configuration","description":"Create a new telephony configuration for the org.","operationId":"create_telephony_configuration_api_v1_organizations_telephony_configs_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationDetail"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs/{config_id}":{"get":{"tags":["main","organizations"],"summary":"Get Telephony Configuration By Id","operationId":"get_telephony_configuration_by_id_api_v1_organizations_telephony_configs__config_id__get","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationDetail"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["main","organizations"],"summary":"Update Telephony Configuration","operationId":"update_telephony_configuration_api_v1_organizations_telephony_configs__config_id__put","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationDetail"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main","organizations"],"summary":"Delete Telephony Configuration","operationId":"delete_telephony_configuration_api_v1_organizations_telephony_configs__config_id__delete","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs/{config_id}/set-default-outbound":{"post":{"tags":["main","organizations"],"summary":"Set Default Outbound","operationId":"set_default_outbound_api_v1_organizations_telephony_configs__config_id__set_default_outbound_post","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationDetail"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs/{config_id}/phone-numbers":{"get":{"tags":["main","organizations"],"summary":"List Phone Numbers","operationId":"list_phone_numbers_api_v1_organizations_telephony_configs__config_id__phone_numbers_get","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberListResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main","organizations"],"summary":"Create Phone Number","operationId":"create_phone_number_api_v1_organizations_telephony_configs__config_id__phone_numbers_post","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}":{"get":{"tags":["main","organizations"],"summary":"Get Phone Number","operationId":"get_phone_number_api_v1_organizations_telephony_configs__config_id__phone_numbers__phone_number_id__get","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"integer","title":"Phone Number Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["main","organizations"],"summary":"Update Phone Number","operationId":"update_phone_number_api_v1_organizations_telephony_configs__config_id__phone_numbers__phone_number_id__put","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"integer","title":"Phone Number Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main","organizations"],"summary":"Delete Phone Number","operationId":"delete_phone_number_api_v1_organizations_telephony_configs__config_id__phone_numbers__phone_number_id__delete","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"integer","title":"Phone Number Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}/set-default-caller":{"post":{"tags":["main","organizations"],"summary":"Set Default Caller Id","operationId":"set_default_caller_id_api_v1_organizations_telephony_configs__config_id__phone_numbers__phone_number_id__set_default_caller_post","parameters":[{"name":"config_id","in":"path","required":true,"schema":{"type":"integer","title":"Config Id"}},{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"integer","title":"Phone Number Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/telephony-config":{"get":{"tags":["main","organizations"],"summary":"Get Telephony Configuration","description":"Legacy: returns the org's default config in the original per-provider\nresponse shape so the existing single-form UI keeps working. Prefer the\nmulti-config endpoints (``/telephony-configs``) for new clients.","operationId":"get_telephony_configuration_api_v1_organizations_telephony_config_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephonyConfigurationResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main","organizations"],"summary":"Save Telephony Configuration","description":"Legacy: upserts the org's default config (and its phone numbers) in the\noriginal payload shape so existing UI clients keep working. Prefer the\nmulti-config + phone-number endpoints for new clients.","operationId":"save_telephony_configuration_api_v1_organizations_telephony_config_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ARIConfigurationRequest"},{"$ref":"#/components/schemas/CloudonixConfigurationRequest"},{"$ref":"#/components/schemas/PlivoConfigurationRequest"},{"$ref":"#/components/schemas/TelnyxConfigurationRequest"},{"$ref":"#/components/schemas/TwilioConfigurationRequest"},{"$ref":"#/components/schemas/VobizConfigurationRequest"},{"$ref":"#/components/schemas/VonageConfigurationRequest"}],"discriminator":{"propertyName":"provider","mapping":{"ari":"#/components/schemas/ARIConfigurationRequest","cloudonix":"#/components/schemas/CloudonixConfigurationRequest","plivo":"#/components/schemas/PlivoConfigurationRequest","telnyx":"#/components/schemas/TelnyxConfigurationRequest","twilio":"#/components/schemas/TwilioConfigurationRequest","vobiz":"#/components/schemas/VobizConfigurationRequest","vonage":"#/components/schemas/VonageConfigurationRequest"}},"title":"Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/langfuse-credentials":{"get":{"tags":["main","organizations"],"summary":"Get Langfuse Credentials","description":"Get Langfuse credentials for the user's organization with masked sensitive fields.","operationId":"get_langfuse_credentials_api_v1_organizations_langfuse_credentials_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LangfuseCredentialsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main","organizations"],"summary":"Save Langfuse Credentials","description":"Save Langfuse credentials for the user's organization.","operationId":"save_langfuse_credentials_api_v1_organizations_langfuse_credentials_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LangfuseCredentialsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main","organizations"],"summary":"Delete Langfuse Credentials","description":"Delete Langfuse credentials for the user's organization.","operationId":"delete_langfuse_credentials_api_v1_organizations_langfuse_credentials_delete","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/campaign-defaults":{"get":{"tags":["main","organizations"],"summary":"Get Campaign Defaults","description":"Get campaign limits for the user's organization.\n\nReturns the organization's concurrent call limit and default retry configuration.","operationId":"get_campaign_defaults_api_v1_organizations_campaign_defaults_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignDefaultsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/s3/signed-url":{"get":{"tags":["main","s3"],"summary":"Generate a signed S3 URL","description":"Return a short-lived signed URL for a file stored on S3 / MinIO.\n\nAccess Control:\n* Keys that embed an organization ID (``{prefix}/{org_id}/...``) are\n authorized by matching the org_id against the requesting user's\n organization.\n* Legacy keys (``recordings/{run_id}.wav``, ``transcripts/{run_id}.txt``)\n are authorized via the workflow run they belong to.\n* Superusers can request any key.","operationId":"get_signed_url_api_v1_s3_signed_url_get","parameters":[{"name":"key","in":"query","required":true,"schema":{"type":"string","description":"S3 object key","title":"Key"},"description":"S3 object key"},{"name":"expires_in","in":"query","required":false,"schema":{"type":"integer","default":3600,"title":"Expires In"}},{"name":"inline","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Inline"}},{"name":"storage_backend","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Storage backend to use (e.g. 'minio', 's3'). When omitted the backend is inferred from the resource.","title":"Storage Backend"},"description":"Storage backend to use (e.g. 'minio', 's3'). When omitted the backend is inferred from the resource."},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/S3SignedUrlResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/s3/file-metadata":{"get":{"tags":["main","s3"],"summary":"Get file metadata for debugging","description":"Get file metadata including creation timestamp for debugging.\n\nAccess Control:\n* Superusers can request any key.\n* Regular users can only request resources belonging to **their** workflow runs.","operationId":"get_file_metadata_api_v1_s3_file_metadata_get","parameters":[{"name":"key","in":"query","required":true,"schema":{"type":"string","description":"S3 object key","title":"Key"},"description":"S3 object key"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileMetadataResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/s3/presigned-upload-url":{"post":{"tags":["main","s3"],"summary":"Generate a presigned URL for direct CSV upload","description":"Generate a presigned PUT URL for direct CSV file upload to S3/MinIO.\n\nThis endpoint enables browser-to-storage uploads without passing through the backend\n\nAccess Control:\n* All authenticated users can upload CSV files scoped to their organization.\n* Files are stored with organization-scoped keys for multi-tenancy.\n\nReturns:\n* upload_url: Presigned URL (valid for 15 minutes) for PUT request\n* file_key: Unique storage key to use as source_id in campaign creation\n* expires_in: URL expiration time in seconds","operationId":"get_presigned_upload_url_api_v1_s3_presigned_upload_url_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresignedUploadUrlRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresignedUploadUrlResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/service-keys":{"get":{"tags":["main"],"summary":"Get Service Keys","description":"Get all service keys for the user's organization.","operationId":"get_service_keys_api_v1_user_service_keys_get","parameters":[{"name":"include_archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Archived"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServiceKeyResponse"},"title":"Response Get Service Keys Api V1 User Service Keys Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["main"],"summary":"Create Service Key","description":"Create a new service key for the user's organization.","operationId":"create_service_key_api_v1_user_service_keys_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceKeyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceKeyResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/service-keys/{service_key_id}":{"delete":{"tags":["main"],"summary":"Archive Service Key","description":"Archive a service key.","operationId":"archive_service_key_api_v1_user_service_keys__service_key_id__delete","parameters":[{"name":"service_key_id","in":"path","required":true,"schema":{"type":"string","title":"Service Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/user/service-keys/{service_key_id}/reactivate":{"put":{"tags":["main"],"summary":"Reactivate Service Key","description":"Reactivate an archived service key.\n\nNote: This endpoint is provided for API compatibility but service key\nreactivation is not supported by MPS. Once archived, a service key\ncannot be reactivated and a new key must be created instead.","operationId":"reactivate_service_key_api_v1_user_service_keys__service_key_id__reactivate_put","parameters":[{"name":"service_key_id","in":"path","required":true,"schema":{"type":"string","title":"Service Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/usage/current-period":{"get":{"tags":["main"],"summary":"Get Current Period Usage","description":"Get current billing period usage for the user's organization.","operationId":"get_current_period_usage_api_v1_organizations_usage_current_period_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentUsageResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/usage/mps-credits":{"get":{"tags":["main"],"summary":"Get Mps Credits","description":"Get aggregated usage and quota from MPS.\n\nOSS users: queries by provider_id (created_by).\nHosted users: queries by organization_id.","operationId":"get_mps_credits_api_v1_organizations_usage_mps_credits_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MPSCreditsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/usage/runs":{"get":{"tags":["main"],"summary":"Get Usage History","description":"Get paginated workflow runs with usage for the organization.","operationId":"get_usage_history_api_v1_organizations_usage_runs_get","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 date-time string (UTC). Lower bound (inclusive) on `created_at`.","examples":["2026-04-01T00:00:00Z"],"title":"Start Date"},"description":"ISO 8601 date-time string (UTC). Lower bound (inclusive) on `created_at`."},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 date-time string (UTC). Upper bound (inclusive) on `created_at`.","examples":["2026-05-01T00:00:00Z"],"title":"End Date"},"description":"ISO 8601 date-time string (UTC). Upper bound (inclusive) on `created_at`."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded array of filter objects. Each object has the shape:\n\n```json\n{ \"attribute\": \"\", \"type\": \"\", \"value\": }\n```\n\nSupported `attribute` / `type` / `value` combinations:\n\n| attribute | type | value shape | matches |\n|-----------------|---------------|----------------------------------------------|------------------------------------------------------|\n| `runId` | `number` | `{ \"value\": 12345 }` | exact run id |\n| `workflowId` | `number` | `{ \"value\": 42 }` | exact agent (workflow) id |\n| `campaignId` | `number` | `{ \"value\": 7 }` | exact campaign id |\n| `callerNumber` | `text` | `{ \"value\": \"415555\" }` | substring match on `initial_context.caller_number` |\n| `calledNumber` | `text` | `{ \"value\": \"9911848\" }` | substring match on `initial_context.called_number` |\n| `dispositionCode` | `multiSelect` | `{ \"codes\": [\"XFER\", \"DNC\"] }` | any of the codes in `gathered_context.mapped_call_disposition` |\n| `duration` | `numberRange` | `{ \"min\": 60, \"max\": 300 }` | call duration (seconds), inclusive bounds |\n\nUnknown attributes and unsupported `type` values are silently ignored.\n\nDate filtering on this endpoint is done via the dedicated `start_date` / `end_date` query params, not via a `dateRange` filter object.\n","examples":["[{\"attribute\":\"callerNumber\",\"type\":\"text\",\"value\":{\"value\":\"415555\"}}]","[{\"attribute\":\"campaignId\",\"type\":\"number\",\"value\":{\"value\":7}},{\"attribute\":\"duration\",\"type\":\"numberRange\",\"value\":{\"min\":60,\"max\":300}}]","[{\"attribute\":\"dispositionCode\",\"type\":\"multiSelect\",\"value\":{\"codes\":[\"XFER\",\"DNC\"]}}]"],"title":"Filters"},"description":"JSON-encoded array of filter objects. Each object has the shape:\n\n```json\n{ \"attribute\": \"\", \"type\": \"\", \"value\": }\n```\n\nSupported `attribute` / `type` / `value` combinations:\n\n| attribute | type | value shape | matches |\n|-----------------|---------------|----------------------------------------------|------------------------------------------------------|\n| `runId` | `number` | `{ \"value\": 12345 }` | exact run id |\n| `workflowId` | `number` | `{ \"value\": 42 }` | exact agent (workflow) id |\n| `campaignId` | `number` | `{ \"value\": 7 }` | exact campaign id |\n| `callerNumber` | `text` | `{ \"value\": \"415555\" }` | substring match on `initial_context.caller_number` |\n| `calledNumber` | `text` | `{ \"value\": \"9911848\" }` | substring match on `initial_context.called_number` |\n| `dispositionCode` | `multiSelect` | `{ \"codes\": [\"XFER\", \"DNC\"] }` | any of the codes in `gathered_context.mapped_call_disposition` |\n| `duration` | `numberRange` | `{ \"min\": 60, \"max\": 300 }` | call duration (seconds), inclusive bounds |\n\nUnknown attributes and unsupported `type` values are silently ignored.\n\nDate filtering on this endpoint is done via the dedicated `start_date` / `end_date` query params, not via a `dateRange` filter object.\n"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageHistoryResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/usage/runs/report":{"get":{"tags":["main"],"summary":"Download Usage Runs Report","description":"Download a CSV of runs matching the same filters as `/usage/runs`.","operationId":"download_usage_runs_report_api_v1_organizations_usage_runs_report_get","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 date-time string (UTC). Lower bound (inclusive) on `created_at`.","title":"Start Date"},"description":"ISO 8601 date-time string (UTC). Lower bound (inclusive) on `created_at`."},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 date-time string (UTC). Upper bound (inclusive) on `created_at`.","title":"End Date"},"description":"ISO 8601 date-time string (UTC). Upper bound (inclusive) on `created_at`."},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded array of filter objects. Each object has the shape:\n\n```json\n{ \"attribute\": \"\", \"type\": \"\", \"value\": }\n```\n\nSupported `attribute` / `type` / `value` combinations:\n\n| attribute | type | value shape | matches |\n|-----------------|---------------|----------------------------------------------|------------------------------------------------------|\n| `runId` | `number` | `{ \"value\": 12345 }` | exact run id |\n| `workflowId` | `number` | `{ \"value\": 42 }` | exact agent (workflow) id |\n| `campaignId` | `number` | `{ \"value\": 7 }` | exact campaign id |\n| `callerNumber` | `text` | `{ \"value\": \"415555\" }` | substring match on `initial_context.caller_number` |\n| `calledNumber` | `text` | `{ \"value\": \"9911848\" }` | substring match on `initial_context.called_number` |\n| `dispositionCode` | `multiSelect` | `{ \"codes\": [\"XFER\", \"DNC\"] }` | any of the codes in `gathered_context.mapped_call_disposition` |\n| `duration` | `numberRange` | `{ \"min\": 60, \"max\": 300 }` | call duration (seconds), inclusive bounds |\n\nUnknown attributes and unsupported `type` values are silently ignored.\n\nDate filtering on this endpoint is done via the dedicated `start_date` / `end_date` query params, not via a `dateRange` filter object.\n","title":"Filters"},"description":"JSON-encoded array of filter objects. Each object has the shape:\n\n```json\n{ \"attribute\": \"\", \"type\": \"\", \"value\": }\n```\n\nSupported `attribute` / `type` / `value` combinations:\n\n| attribute | type | value shape | matches |\n|-----------------|---------------|----------------------------------------------|------------------------------------------------------|\n| `runId` | `number` | `{ \"value\": 12345 }` | exact run id |\n| `workflowId` | `number` | `{ \"value\": 42 }` | exact agent (workflow) id |\n| `campaignId` | `number` | `{ \"value\": 7 }` | exact campaign id |\n| `callerNumber` | `text` | `{ \"value\": \"415555\" }` | substring match on `initial_context.caller_number` |\n| `calledNumber` | `text` | `{ \"value\": \"9911848\" }` | substring match on `initial_context.called_number` |\n| `dispositionCode` | `multiSelect` | `{ \"codes\": [\"XFER\", \"DNC\"] }` | any of the codes in `gathered_context.mapped_call_disposition` |\n| `duration` | `numberRange` | `{ \"min\": 60, \"max\": 300 }` | call duration (seconds), inclusive bounds |\n\nUnknown attributes and unsupported `type` values are silently ignored.\n\nDate filtering on this endpoint is done via the dedicated `start_date` / `end_date` query params, not via a `dateRange` filter object.\n"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/usage/daily-breakdown":{"get":{"tags":["main"],"summary":"Get Daily Usage Breakdown","description":"Get daily usage breakdown for the last N days. Only available for organizations with pricing.","operationId":"get_daily_usage_breakdown_api_v1_organizations_usage_daily_breakdown_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":30,"minimum":1,"description":"Number of days to include","default":7,"title":"Days"},"description":"Number of days to include"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailyUsageBreakdownResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/reports/daily":{"get":{"tags":["main"],"summary":"Get Daily Report","description":"Get daily report for the specified date and timezone.\nIf workflow_id is provided, filters results to that specific workflow.\nIf workflow_id is None, includes all workflows for the organization.","operationId":"get_daily_report_api_v1_organizations_reports_daily_get","parameters":[{"name":"date","in":"query","required":true,"schema":{"type":"string","description":"Date in YYYY-MM-DD format","title":"Date"},"description":"Date in YYYY-MM-DD format"},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA timezone (e.g., 'America/New_York')","title":"Timezone"},"description":"IANA timezone (e.g., 'America/New_York')"},{"name":"workflow_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Optional workflow ID to filter by","title":"Workflow Id"},"description":"Optional workflow ID to filter by"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailyReportResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/reports/workflows":{"get":{"tags":["main"],"summary":"Get Workflow Options","description":"Get all workflows for the user's organization.\nUsed to populate the workflow selector dropdown in the reports page.","operationId":"get_workflow_options_api_v1_organizations_reports_workflows_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowOption"},"title":"Response Get Workflow Options Api V1 Organizations Reports Workflows Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/reports/daily/runs":{"get":{"tags":["main"],"summary":"Get Daily Runs Detail","description":"Get detailed workflow runs for the specified date.\nUsed for CSV export functionality.","operationId":"get_daily_runs_detail_api_v1_organizations_reports_daily_runs_get","parameters":[{"name":"date","in":"query","required":true,"schema":{"type":"string","description":"Date in YYYY-MM-DD format","title":"Date"},"description":"Date in YYYY-MM-DD format"},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA timezone (e.g., 'America/New_York')","title":"Timezone"},"description":"IANA timezone (e.g., 'America/New_York')"},{"name":"workflow_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Optional workflow ID to filter by","title":"Workflow Id"},"description":"Optional workflow ID to filter by"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowRunDetail"},"title":"Response Get Daily Runs Detail Api V1 Organizations Reports Daily Runs Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/turn/credentials":{"get":{"tags":["main","turn"],"summary":"Get Turn Credentials","description":"Get time-limited TURN credentials for WebRTC connections.\n\nThis endpoint generates ephemeral TURN credentials that are:\n- Valid for the configured TTL (default: 24 hours)\n- Cryptographically bound to the user via HMAC\n- Compatible with coturn's use-auth-secret mode\n\nReturns:\n TurnCredentialsResponse with username, password, ttl, and TURN URIs","operationId":"get_turn_credentials_api_v1_turn_credentials_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TurnCredentialsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/public/embed/init":{"post":{"tags":["main"],"summary":"Initialize Embed Session","description":"Initialize an embed session with token validation and domain checking.\n\nThis endpoint:\n1. Validates the embed token\n2. Checks domain whitelist\n3. Creates a workflow run\n4. Generates a temporary session token\n5. Returns configuration for the widget","operationId":"initialize_embed_session_api_v1_public_embed_init_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitEmbedRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitEmbedResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"options":{"tags":["main"],"summary":"Options Init","description":"Handle CORS preflight for init endpoint","operationId":"options_init_api_v1_public_embed_init_options","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"}}}},"/api/v1/public/embed/config/{token}":{"get":{"tags":["main"],"summary":"Get Embed Config","description":"Get embed configuration without creating a session.\n\nThis endpoint is used to fetch widget configuration for display purposes\nwithout actually starting a call session.","operationId":"get_embed_config_api_v1_public_embed_config__token__get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedConfigResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"options":{"tags":["main"],"summary":"Options Config","description":"Handle CORS preflight for config endpoint","operationId":"options_config_api_v1_public_embed_config__token__options","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/public/embed/turn-credentials/{session_token}":{"get":{"tags":["main"],"summary":"Get Public Turn Credentials","description":"Get TURN credentials for an embed session.\n\nThis endpoint allows embedded widgets to obtain TURN server credentials\nfor WebRTC connections without requiring authentication.\n\nArgs:\n session_token: The session token from embed initialization\n\nReturns:\n TurnCredentialsResponse with username, password, ttl, and TURN URIs","operationId":"get_public_turn_credentials_api_v1_public_embed_turn_credentials__session_token__get","parameters":[{"name":"session_token","in":"path","required":true,"schema":{"type":"string","title":"Session Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TurnCredentialsResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"options":{"tags":["main"],"summary":"Options Turn Credentials","description":"Handle CORS preflight for TURN credentials endpoint","operationId":"options_turn_credentials_api_v1_public_embed_turn_credentials__session_token__options","parameters":[{"name":"session_token","in":"path","required":true,"schema":{"type":"string","title":"Session Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/public/agent/{uuid}":{"post":{"tags":["main"],"summary":"Initiate Call","description":"Initiate a phone call against the published agent.\n\nExecutes the workflow's currently released definition.","operationId":"initiate_call_api_v1_public_agent__uuid__post","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","title":"Uuid"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCallRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCallResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/public/agent/test/{uuid}":{"post":{"tags":["main"],"summary":"Initiate Call Test","description":"Initiate a phone call against the latest draft of the agent.\n\nUseful for verifying changes before publishing. Falls back to the\npublished definition when no draft exists.","operationId":"initiate_call_test_api_v1_public_agent_test__uuid__post","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","title":"Uuid"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCallRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCallResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/public/download/workflow/{token}/{artifact_type}":{"get":{"tags":["main"],"summary":"Download Workflow Artifact","description":"Download a workflow recording or transcript via public access token.\n\nThis endpoint:\n1. Validates the public access token\n2. Looks up the corresponding workflow run\n3. Generates a signed URL for the requested artifact\n4. Redirects to the signed URL\n\nArgs:\n token: The public access token (UUID format)\n artifact_type: Type of artifact - \"recording\" or \"transcript\"\n inline: If true, sets Content-Disposition to inline for browser preview\n\nReturns:\n RedirectResponse to the signed URL (302 redirect)\n\nRaises:\n HTTPException 404: If token is invalid or artifact not found","operationId":"download_workflow_artifact_api_v1_public_download_workflow__token___artifact_type__get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}},{"name":"artifact_type","in":"path","required":true,"schema":{"enum":["recording","transcript"],"type":"string","title":"Artifact Type"}},{"name":"inline","in":"query","required":false,"schema":{"type":"boolean","description":"Display inline in browser instead of download","default":false,"title":"Inline"},"description":"Display inline in browser instead of download"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow/{workflow_id}/embed-token":{"post":{"tags":["main"],"summary":"Create Or Update Embed Token","description":"Create or update an embed token for a workflow.\nEach workflow can have only one active embed token.","operationId":"create_or_update_embed_token_api_v1_workflow__workflow_id__embed_token_post","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedTokenRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedTokenResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["main"],"summary":"Get Embed Token","description":"Get the embed token for a workflow if it exists.","operationId":"get_embed_token_api_v1_workflow__workflow_id__embed_token_get","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/EmbedTokenResponse"},{"type":"null"}],"title":"Response Get Embed Token Api V1 Workflow Workflow Id Embed Token Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main"],"summary":"Deactivate Embed Token","description":"Deactivate the embed token for a workflow.","operationId":"deactivate_embed_token_api_v1_workflow__workflow_id__embed_token_delete","parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"integer","title":"Workflow Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Deactivate Embed Token Api V1 Workflow Workflow Id Embed Token Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/knowledge-base/upload-url":{"post":{"tags":["main","knowledge-base"],"summary":"Get presigned URL for document upload","description":"Generate a presigned PUT URL for uploading a document.\n\nThis endpoint:\n1. Generates a unique document UUID for organizing the S3 key\n2. Generates a presigned S3/MinIO URL for uploading the file\n3. Returns the upload URL and document metadata\n\nAfter uploading to the returned URL, call /process-document to create\nthe document record and trigger processing.\n\nAccess Control:\n* All authenticated users can upload documents scoped to their organization.","operationId":"get_upload_url_api_v1_knowledge_base_upload_url_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUploadRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUploadResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/knowledge-base/process-document":{"post":{"tags":["main","knowledge-base"],"summary":"Trigger document processing","description":"Trigger asynchronous processing of an uploaded document.\n\nThis endpoint should be called after successfully uploading a file to the presigned URL.\nIt will:\n1. Create a document record in the database with the specified UUID\n2. Enqueue a background task to process the document (chunking and embedding)\n\nThe document status will be updated from 'pending' -> 'processing' -> 'completed' or 'failed'.\n\nEmbedding:\nUses OpenAI text-embedding-3-small (1536-dimensional embeddings, requires API key configured in Model Configurations).\n\nAccess Control:\n* Users can only process documents in their organization.","operationId":"process_document_api_v1_knowledge_base_process_document_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessDocumentRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/knowledge-base/documents":{"get":{"tags":["main","knowledge-base"],"summary":"List documents","description":"List all documents for the user's organization.\n\nAccess Control:\n* Users can only see documents from their organization.","operationId":"list_documents_api_v1_knowledge_base_documents_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by processing status","title":"Status"},"description":"Filter by processing status"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentListResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_documents","x-sdk-description":"List knowledge base documents available to the authenticated organization."}},"/api/v1/knowledge-base/documents/{document_uuid}":{"get":{"tags":["main","knowledge-base"],"summary":"Get document details","description":"Get details of a specific document.\n\nAccess Control:\n* Users can only access documents from their organization.","operationId":"get_document_api_v1_knowledge_base_documents__document_uuid__get","parameters":[{"name":"document_uuid","in":"path","required":true,"schema":{"type":"string","title":"Document Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["main","knowledge-base"],"summary":"Delete document","description":"Soft delete a document and its chunks.\n\nAccess Control:\n* Users can only delete documents from their organization.","operationId":"delete_document_api_v1_knowledge_base_documents__document_uuid__delete","parameters":[{"name":"document_uuid","in":"path","required":true,"schema":{"type":"string","title":"Document Uuid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/knowledge-base/search":{"post":{"tags":["main","knowledge-base"],"summary":"Search for similar chunks","description":"Search for document chunks similar to the query.\n\nThis endpoint uses vector similarity search to find relevant chunks.\nResults are returned without threshold filtering - apply similarity\nthresholds at the application layer after optional reranking.\n\nAccess Control:\n* Users can only search documents from their organization.","operationId":"search_chunks_api_v1_knowledge_base_search_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunkSearchRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunkSearchResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow-recordings/upload-url":{"post":{"tags":["main","workflow-recordings"],"summary":"Get presigned URLs for recording uploads","description":"Generate presigned PUT URLs for uploading one or more audio recordings.","operationId":"get_upload_urls_api_v1_workflow_recordings_upload_url_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRecordingUploadRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRecordingUploadResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow-recordings/":{"post":{"tags":["main","workflow-recordings"],"summary":"Create recording records after upload","description":"Create one or more recording records after audio files have been uploaded.","operationId":"create_recordings_api_v1_workflow_recordings__post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRecordingCreateRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRecordingCreateResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["main","workflow-recordings"],"summary":"List recordings","description":"List recordings for the organization, optionally filtered.","operationId":"list_recordings_api_v1_workflow_recordings__get","parameters":[{"name":"workflow_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by workflow ID","title":"Workflow Id"},"description":"Filter by workflow ID"},{"name":"tts_provider","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by TTS provider","title":"Tts Provider"},"description":"Filter by TTS provider"},{"name":"tts_model","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by TTS model","title":"Tts Model"},"description":"Filter by TTS model"},{"name":"tts_voice_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by TTS voice ID","title":"Tts Voice Id"},"description":"Filter by TTS voice ID"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordingListResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_recordings","x-sdk-description":"List workflow recordings available to the authenticated organization."}},"/api/v1/workflow-recordings/{recording_id}":{"delete":{"tags":["main","workflow-recordings"],"summary":"Delete a recording","description":"Soft delete a recording.","operationId":"delete_recording_api_v1_workflow_recordings__recording_id__delete","parameters":[{"name":"recording_id","in":"path","required":true,"schema":{"type":"string","title":"Recording Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow-recordings/{id}":{"patch":{"tags":["main","workflow-recordings"],"summary":"Update a recording's Recording ID","description":"Update the recording_id (descriptive name) of a recording.","operationId":"update_recording_api_v1_workflow_recordings__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","title":"Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordingUpdateRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordingResponseSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workflow-recordings/transcribe":{"post":{"tags":["main","workflow-recordings"],"summary":"Transcribe an audio file","description":"Transcribe an uploaded audio file using MPS STT.","operationId":"transcribe_audio_api_v1_workflow_recordings_transcribe_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_transcribe_audio_api_v1_workflow_recordings_transcribe_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/auth/signup":{"post":{"tags":["main","auth"],"summary":"Signup","operationId":"signup_api_v1_auth_signup_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignupRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/auth/login":{"post":{"tags":["main","auth"],"summary":"Login","operationId":"login_api_v1_auth_login_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/auth/me":{"get":{"tags":["main","auth"],"summary":"Get Current User","operationId":"get_current_user_api_v1_auth_me_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/node-types":{"get":{"tags":["main"],"summary":"List Node Types","description":"List every registered NodeSpec.\n\nSDK clients should pin to `spec_version` and warn if the server reports\na higher version than what they were generated against.","operationId":"list_node_types_api_v1_node_types_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeTypesResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"list_node_types","x-sdk-description":"List every registered node type with its spec. Pinned to spec_version."}},"/api/v1/node-types/{name}":{"get":{"tags":["main"],"summary":"Get Node Type","operationId":"get_node_type_api_v1_node_types__name__get","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeSpec"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-sdk-method":"get_node_type","x-sdk-description":"Fetch a single node spec by name."}},"/api/v1/health":{"get":{"tags":["main"],"summary":"Health","operationId":"health_api_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}},"404":{"description":"Not found"}}}}},"components":{"schemas":{"APIKeyResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"key_prefix":{"type":"string","title":"Key Prefix"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"}},"type":"object","required":["id","name","key_prefix","is_active","created_at"],"title":"APIKeyResponse"},"APIKeyStatus":{"properties":{"model":{"type":"string","title":"Model"},"message":{"type":"string","title":"Message"}},"type":"object","required":["model","message"],"title":"APIKeyStatus"},"APIKeyStatusResponse":{"properties":{"status":{"items":{"$ref":"#/components/schemas/APIKeyStatus"},"type":"array","title":"Status"}},"type":"object","required":["status"],"title":"APIKeyStatusResponse"},"ARIConfigurationRequest":{"properties":{"provider":{"type":"string","const":"ari","title":"Provider","default":"ari"},"ari_endpoint":{"type":"string","title":"Ari Endpoint","description":"ARI base URL (e.g., http://asterisk.example.com:8088)"},"app_name":{"type":"string","title":"App Name","description":"Stasis application name registered in Asterisk"},"app_password":{"type":"string","title":"App Password","description":"ARI user password"},"ws_client_name":{"type":"string","title":"Ws Client Name","description":"websocket_client.conf connection name for externalMedia (e.g., dograh_staging)","default":""},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of SIP extensions/numbers for outbound calls (optional)"}},"type":"object","required":["ari_endpoint","app_name","app_password"],"title":"ARIConfigurationRequest","description":"Request schema for Asterisk ARI configuration."},"ARIConfigurationResponse":{"properties":{"provider":{"type":"string","const":"ari","title":"Provider","default":"ari"},"ari_endpoint":{"type":"string","title":"Ari Endpoint"},"app_name":{"type":"string","title":"App Name"},"app_password":{"type":"string","title":"App Password"},"ws_client_name":{"type":"string","title":"Ws Client Name","default":""},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["ari_endpoint","app_name","app_password","from_numbers"],"title":"ARIConfigurationResponse","description":"Response schema for ARI configuration with masked sensitive fields."},"AmbientNoiseUploadRequest":{"properties":{"workflow_id":{"type":"integer","title":"Workflow Id"},"filename":{"type":"string","title":"Filename"},"mime_type":{"type":"string","title":"Mime Type","default":"audio/wav"},"file_size":{"type":"integer","maximum":10485760.0,"exclusiveMinimum":0.0,"title":"File Size","description":"Max 10MB"}},"type":"object","required":["workflow_id","filename","file_size"],"title":"AmbientNoiseUploadRequest"},"AmbientNoiseUploadResponse":{"properties":{"upload_url":{"type":"string","title":"Upload Url"},"storage_key":{"type":"string","title":"Storage Key"},"storage_backend":{"type":"string","title":"Storage Backend"}},"type":"object","required":["upload_url","storage_key","storage_backend"],"title":"AmbientNoiseUploadResponse"},"AuthResponse":{"properties":{"token":{"type":"string","title":"Token"},"user":{"$ref":"#/components/schemas/UserResponse"}},"type":"object","required":["token","user"],"title":"AuthResponse"},"AuthUserResponse":{"properties":{"id":{"type":"integer","title":"Id"},"is_superuser":{"type":"boolean","title":"Is Superuser"}},"type":"object","required":["id","is_superuser"],"title":"AuthUserResponse"},"BatchRecordingCreateRequestSchema":{"properties":{"recordings":{"items":{"$ref":"#/components/schemas/RecordingCreateRequestSchema"},"type":"array","maxItems":20,"minItems":1,"title":"Recordings","description":"List of recordings to create"}},"type":"object","required":["recordings"],"title":"BatchRecordingCreateRequestSchema","description":"Request schema for creating one or more recording records after upload."},"BatchRecordingCreateResponseSchema":{"properties":{"recordings":{"items":{"$ref":"#/components/schemas/RecordingResponseSchema"},"type":"array","title":"Recordings","description":"Created recording records"}},"type":"object","required":["recordings"],"title":"BatchRecordingCreateResponseSchema","description":"Response schema for recording creation."},"BatchRecordingUploadRequestSchema":{"properties":{"files":{"items":{"$ref":"#/components/schemas/FileDescriptor"},"type":"array","maxItems":20,"minItems":1,"title":"Files","description":"List of files to upload"}},"type":"object","required":["files"],"title":"BatchRecordingUploadRequestSchema","description":"Request schema for getting presigned upload URLs for one or more files."},"BatchRecordingUploadResponseSchema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/RecordingUploadResponseSchema"},"type":"array","title":"Items","description":"Upload URLs for each file"}},"type":"object","required":["items"],"title":"BatchRecordingUploadResponseSchema","description":"Response schema with presigned upload URLs."},"Body_transcribe_audio_api_v1_workflow_recordings_transcribe_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"language":{"type":"string","title":"Language","default":"en"}},"type":"object","required":["file"],"title":"Body_transcribe_audio_api_v1_workflow_recordings_transcribe_post"},"CalculatorToolDefinition":{"properties":{"schema_version":{"type":"integer","title":"Schema Version","description":"Schema version","default":1},"type":{"type":"string","const":"calculator","title":"Type","description":"Tool type"}},"type":"object","required":["type"],"title":"CalculatorToolDefinition","description":"Tool definition for Calculator tools (no configuration needed)."},"CallDispositionCodes":{"properties":{"disposition_codes":{"items":{"type":"string"},"type":"array","title":"Disposition Codes","default":[]}},"type":"object","title":"CallDispositionCodes"},"CallType":{"type":"string","enum":["inbound","outbound"],"title":"CallType"},"CampaignDefaultsResponse":{"properties":{"concurrent_call_limit":{"type":"integer","title":"Concurrent Call Limit"},"from_numbers_count":{"type":"integer","title":"From Numbers Count"},"default_retry_config":{"$ref":"#/components/schemas/RetryConfigResponse"},"last_campaign_settings":{"anyOf":[{"$ref":"#/components/schemas/LastCampaignSettingsResponse"},{"type":"null"}]}},"type":"object","required":["concurrent_call_limit","from_numbers_count","default_retry_config"],"title":"CampaignDefaultsResponse"},"CampaignLogEntryResponse":{"properties":{"ts":{"type":"string","title":"Ts"},"level":{"type":"string","title":"Level"},"event":{"type":"string","title":"Event"},"message":{"type":"string","title":"Message"},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details"}},"type":"object","required":["ts","level","event","message"],"title":"CampaignLogEntryResponse","description":"A single timestamped entry from the campaign's append-only log.\n\nSurfaced in the UI so operators can see why a campaign moved to\npaused / failed without digging through server logs."},"CampaignProgressResponse":{"properties":{"campaign_id":{"type":"integer","title":"Campaign Id"},"state":{"type":"string","title":"State"},"total_rows":{"type":"integer","title":"Total Rows"},"processed_rows":{"type":"integer","title":"Processed Rows"},"failed_calls":{"type":"integer","title":"Failed Calls"},"progress_percentage":{"type":"number","title":"Progress Percentage"},"source_sync":{"additionalProperties":true,"type":"object","title":"Source Sync"},"rate_limit":{"type":"integer","title":"Rate Limit"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"}},"type":"object","required":["campaign_id","state","total_rows","processed_rows","failed_calls","progress_percentage","source_sync","rate_limit","started_at","completed_at"],"title":"CampaignProgressResponse"},"CampaignResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"workflow_id":{"type":"integer","title":"Workflow Id"},"workflow_name":{"type":"string","title":"Workflow Name"},"state":{"type":"string","title":"State"},"source_type":{"type":"string","title":"Source Type"},"source_id":{"type":"string","title":"Source Id"},"total_rows":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Rows"},"processed_rows":{"type":"integer","title":"Processed Rows"},"failed_rows":{"type":"integer","title":"Failed Rows"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"retry_config":{"$ref":"#/components/schemas/RetryConfigResponse"},"max_concurrency":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Concurrency"},"schedule_config":{"anyOf":[{"$ref":"#/components/schemas/ScheduleConfigResponse"},{"type":"null"}]},"circuit_breaker":{"anyOf":[{"$ref":"#/components/schemas/CircuitBreakerConfigResponse"},{"type":"null"}]},"executed_count":{"type":"integer","title":"Executed Count","default":0},"total_queued_count":{"type":"integer","title":"Total Queued Count","default":0},"parent_campaign_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent Campaign Id"},"redialed_campaign_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Redialed Campaign Id"},"telephony_configuration_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Telephony Configuration Id"},"telephony_configuration_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Telephony Configuration Name"},"logs":{"items":{"$ref":"#/components/schemas/CampaignLogEntryResponse"},"type":"array","title":"Logs"}},"type":"object","required":["id","name","workflow_id","workflow_name","state","source_type","source_id","total_rows","processed_rows","failed_rows","created_at","started_at","completed_at","retry_config"],"title":"CampaignResponse"},"CampaignRunsResponse":{"properties":{"runs":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Runs"},"total_count":{"type":"integer","title":"Total Count"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"},"total_pages":{"type":"integer","title":"Total Pages"}},"type":"object","required":["runs","total_count","page","limit","total_pages"],"title":"CampaignRunsResponse","description":"Paginated response for campaign workflow runs"},"CampaignSourceDownloadResponse":{"properties":{"download_url":{"type":"string","title":"Download Url"},"expires_in":{"type":"integer","title":"Expires In"}},"type":"object","required":["download_url","expires_in"],"title":"CampaignSourceDownloadResponse"},"CampaignsResponse":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignResponse"},"type":"array","title":"Campaigns"}},"type":"object","required":["campaigns"],"title":"CampaignsResponse"},"ChunkResponseSchema":{"properties":{"id":{"type":"integer","title":"Id"},"document_id":{"type":"integer","title":"Document Id"},"chunk_text":{"type":"string","title":"Chunk Text"},"contextualized_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contextualized Text"},"chunk_index":{"type":"integer","title":"Chunk Index"},"chunk_metadata":{"additionalProperties":true,"type":"object","title":"Chunk Metadata"},"filename":{"type":"string","title":"Filename"},"document_uuid":{"type":"string","title":"Document Uuid"},"similarity":{"type":"number","title":"Similarity"}},"type":"object","required":["id","document_id","chunk_text","contextualized_text","chunk_index","chunk_metadata","filename","document_uuid","similarity"],"title":"ChunkResponseSchema","description":"Response schema for a document chunk."},"ChunkSearchRequestSchema":{"properties":{"query":{"type":"string","title":"Query","description":"Search query text"},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Maximum number of results","default":5},"document_uuids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Document Uuids","description":"Filter by specific document UUIDs"},"min_similarity":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Min Similarity","description":"Minimum similarity threshold"}},"type":"object","required":["query"],"title":"ChunkSearchRequestSchema","description":"Request schema for searching similar chunks."},"ChunkSearchResponseSchema":{"properties":{"chunks":{"items":{"$ref":"#/components/schemas/ChunkResponseSchema"},"type":"array","title":"Chunks"},"query":{"type":"string","title":"Query"},"total_results":{"type":"integer","title":"Total Results"}},"type":"object","required":["chunks","query","total_results"],"title":"ChunkSearchResponseSchema","description":"Response schema for chunk search results."},"CircuitBreakerConfigRequest":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":true},"failure_threshold":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Failure Threshold","default":0.5},"window_seconds":{"type":"integer","maximum":600.0,"minimum":30.0,"title":"Window Seconds","default":120},"min_calls_in_window":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Min Calls In Window","default":5}},"type":"object","title":"CircuitBreakerConfigRequest"},"CircuitBreakerConfigResponse":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false},"failure_threshold":{"type":"number","title":"Failure Threshold","default":0.5},"window_seconds":{"type":"integer","title":"Window Seconds","default":120},"min_calls_in_window":{"type":"integer","title":"Min Calls In Window","default":5}},"type":"object","title":"CircuitBreakerConfigResponse"},"CloudonixConfigurationRequest":{"properties":{"provider":{"type":"string","const":"cloudonix","title":"Provider","default":"cloudonix"},"bearer_token":{"type":"string","title":"Bearer Token","description":"Cloudonix API Bearer Token"},"domain_id":{"type":"string","title":"Domain Id","description":"Cloudonix Domain ID"},"application_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Name","description":"Cloudonix Voice Application name. The application's url is updated when inbound workflows are attached to numbers on this domain. If omitted, an application is auto-created on save and its name is stored on the configuration."},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Cloudonix phone numbers (optional)"}},"type":"object","required":["bearer_token","domain_id"],"title":"CloudonixConfigurationRequest","description":"Request schema for Cloudonix configuration."},"CloudonixConfigurationResponse":{"properties":{"provider":{"type":"string","const":"cloudonix","title":"Provider","default":"cloudonix"},"bearer_token":{"type":"string","title":"Bearer Token"},"domain_id":{"type":"string","title":"Domain Id"},"application_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Name"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["bearer_token","domain_id","from_numbers"],"title":"CloudonixConfigurationResponse","description":"Response schema for Cloudonix configuration with masked sensitive fields."},"CreateAPIKeyRequest":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"CreateAPIKeyRequest"},"CreateAPIKeyResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"key_prefix":{"type":"string","title":"Key Prefix"},"api_key":{"type":"string","title":"Api Key"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","name","key_prefix","api_key","created_at"],"title":"CreateAPIKeyResponse"},"CreateCampaignRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name"},"workflow_id":{"type":"integer","title":"Workflow Id"},"source_type":{"type":"string","pattern":"^csv$","title":"Source Type"},"source_id":{"type":"string","title":"Source Id"},"telephony_configuration_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Telephony Configuration Id"},"retry_config":{"anyOf":[{"$ref":"#/components/schemas/RetryConfigRequest"},{"type":"null"}]},"max_concurrency":{"anyOf":[{"type":"integer","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Max Concurrency"},"schedule_config":{"anyOf":[{"$ref":"#/components/schemas/ScheduleConfigRequest"},{"type":"null"}]},"circuit_breaker":{"anyOf":[{"$ref":"#/components/schemas/CircuitBreakerConfigRequest"},{"type":"null"}]}},"type":"object","required":["name","workflow_id","source_type","source_id"],"title":"CreateCampaignRequest"},"CreateCredentialRequest":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"credential_type":{"$ref":"#/components/schemas/WebhookCredentialType"},"credential_data":{"additionalProperties":true,"type":"object","title":"Credential Data"}},"type":"object","required":["name","credential_type","credential_data"],"title":"CreateCredentialRequest","description":"Request schema for creating a webhook credential."},"CreateServiceKeyRequest":{"properties":{"name":{"type":"string","title":"Name"},"expires_in_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires In Days","default":90}},"type":"object","required":["name"],"title":"CreateServiceKeyRequest"},"CreateServiceKeyResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"service_key":{"type":"string","title":"Service Key"},"key_prefix":{"type":"string","title":"Key Prefix"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"}},"type":"object","required":["id","name","service_key","key_prefix"],"title":"CreateServiceKeyResponse"},"CreateToolRequest":{"properties":{"name":{"type":"string","maxLength":255,"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"category":{"type":"string","title":"Category","default":"http_api"},"icon":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"title":"Icon","default":"globe"},"icon_color":{"anyOf":[{"type":"string","maxLength":7},{"type":"null"}],"title":"Icon Color","default":"#3B82F6"},"definition":{"oneOf":[{"$ref":"#/components/schemas/HttpApiToolDefinition"},{"$ref":"#/components/schemas/EndCallToolDefinition"},{"$ref":"#/components/schemas/TransferCallToolDefinition"},{"$ref":"#/components/schemas/CalculatorToolDefinition"},{"$ref":"#/components/schemas/McpToolDefinition"}],"title":"Definition","discriminator":{"propertyName":"type","mapping":{"calculator":"#/components/schemas/CalculatorToolDefinition","end_call":"#/components/schemas/EndCallToolDefinition","http_api":"#/components/schemas/HttpApiToolDefinition","mcp":"#/components/schemas/McpToolDefinition","transfer_call":"#/components/schemas/TransferCallToolDefinition"}}}},"type":"object","required":["name","definition"],"title":"CreateToolRequest","description":"Request schema for creating a tool."},"CreateWorkflowRequest":{"properties":{"name":{"type":"string","title":"Name"},"workflow_definition":{"additionalProperties":true,"type":"object","title":"Workflow Definition"}},"type":"object","required":["name","workflow_definition"],"title":"CreateWorkflowRequest"},"CreateWorkflowRunRequest":{"properties":{"mode":{"type":"string","title":"Mode"},"name":{"type":"string","title":"Name"}},"type":"object","required":["mode","name"],"title":"CreateWorkflowRunRequest"},"CreateWorkflowRunResponse":{"properties":{"id":{"type":"integer","title":"Id"},"workflow_id":{"type":"integer","title":"Workflow Id"},"name":{"type":"string","title":"Name"},"mode":{"type":"string","title":"Mode"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"definition_id":{"type":"integer","title":"Definition Id"},"initial_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Initial Context"}},"type":"object","required":["id","workflow_id","name","mode","created_at","definition_id"],"title":"CreateWorkflowRunResponse"},"CreateWorkflowTemplateRequest":{"properties":{"call_type":{"type":"string","enum":["inbound","outbound"],"title":"Call Type"},"use_case":{"type":"string","title":"Use Case"},"activity_description":{"type":"string","title":"Activity Description"}},"type":"object","required":["call_type","use_case","activity_description"],"title":"CreateWorkflowTemplateRequest"},"CreatedByResponse":{"properties":{"id":{"type":"integer","title":"Id"},"provider_id":{"type":"string","title":"Provider Id"}},"type":"object","required":["id","provider_id"],"title":"CreatedByResponse","description":"Response schema for the user who created a tool."},"CredentialResponse":{"properties":{"uuid":{"type":"string","title":"Uuid"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"credential_type":{"type":"string","title":"Credential Type"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["uuid","name","description","credential_type","created_at","updated_at"],"title":"CredentialResponse","description":"Response schema for a webhook credential (never includes sensitive data)."},"CurrentUsageResponse":{"properties":{"period_start":{"type":"string","title":"Period Start"},"period_end":{"type":"string","title":"Period End"},"used_dograh_tokens":{"type":"number","title":"Used Dograh Tokens"},"quota_dograh_tokens":{"type":"integer","title":"Quota Dograh Tokens"},"percentage_used":{"type":"number","title":"Percentage Used"},"next_refresh_date":{"type":"string","title":"Next Refresh Date"},"quota_enabled":{"type":"boolean","title":"Quota Enabled"},"total_duration_seconds":{"type":"integer","title":"Total Duration Seconds"},"used_amount_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Used Amount Usd"},"quota_amount_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quota Amount Usd"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"price_per_second_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price Per Second Usd"}},"type":"object","required":["period_start","period_end","used_dograh_tokens","quota_dograh_tokens","percentage_used","next_refresh_date","quota_enabled","total_duration_seconds"],"title":"CurrentUsageResponse"},"DailyReportResponse":{"properties":{"date":{"type":"string","title":"Date"},"timezone":{"type":"string","title":"Timezone"},"workflow_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Workflow Id"},"metrics":{"additionalProperties":{"type":"integer"},"type":"object","title":"Metrics"},"disposition_distribution":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Disposition Distribution"},"call_duration_distribution":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Call Duration Distribution"}},"type":"object","required":["date","timezone","workflow_id","metrics","disposition_distribution","call_duration_distribution"],"title":"DailyReportResponse"},"DailyUsageBreakdownResponse":{"properties":{"breakdown":{"items":{"$ref":"#/components/schemas/DailyUsageItem"},"type":"array","title":"Breakdown"},"total_minutes":{"type":"number","title":"Total Minutes"},"total_cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Cost Usd"},"total_dograh_tokens":{"type":"number","title":"Total Dograh Tokens"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"}},"type":"object","required":["breakdown","total_minutes","total_dograh_tokens"],"title":"DailyUsageBreakdownResponse"},"DailyUsageItem":{"properties":{"date":{"type":"string","title":"Date"},"minutes":{"type":"number","title":"Minutes"},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cost Usd"},"dograh_tokens":{"type":"number","title":"Dograh Tokens"},"call_count":{"type":"integer","title":"Call Count"}},"type":"object","required":["date","minutes","dograh_tokens","call_count"],"title":"DailyUsageItem"},"DefaultConfigurationsResponse":{"properties":{"llm":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Llm"},"tts":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Tts"},"stt":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Stt"},"embeddings":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Embeddings"},"realtime":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Realtime"},"default_providers":{"additionalProperties":{"type":"string"},"type":"object","title":"Default Providers"}},"type":"object","required":["llm","tts","stt","embeddings","realtime","default_providers"],"title":"DefaultConfigurationsResponse"},"DisplayOptions":{"properties":{"show":{"anyOf":[{"additionalProperties":{"items":{},"type":"array"},"type":"object"},{"type":"null"}],"title":"Show"},"hide":{"anyOf":[{"additionalProperties":{"items":{},"type":"array"},"type":"object"},{"type":"null"}],"title":"Hide"}},"additionalProperties":false,"type":"object","title":"DisplayOptions","description":"Conditional visibility rules.\n\n`show` keys are AND-combined: this property is visible only when EVERY\nreferenced field's value matches one of the listed values.\n\n`hide` keys are OR-combined: this property is hidden when ANY referenced\nfield's value matches one of the listed values.\n\nExample:\n DisplayOptions(show={\"extraction_enabled\": [True]})\n DisplayOptions(show={\"greeting_type\": [\"audio\"]})"},"DocumentListResponseSchema":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/DocumentResponseSchema"},"type":"array","title":"Documents"},"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["documents","total","limit","offset"],"title":"DocumentListResponseSchema","description":"Response schema for list of documents."},"DocumentResponseSchema":{"properties":{"id":{"type":"integer","title":"Id"},"document_uuid":{"type":"string","title":"Document Uuid"},"filename":{"type":"string","title":"Filename"},"file_size_bytes":{"type":"integer","title":"File Size Bytes"},"file_hash":{"type":"string","title":"File Hash"},"mime_type":{"type":"string","title":"Mime Type"},"processing_status":{"type":"string","title":"Processing Status"},"processing_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processing Error"},"total_chunks":{"type":"integer","title":"Total Chunks"},"retrieval_mode":{"type":"string","title":"Retrieval Mode","default":"chunked"},"custom_metadata":{"additionalProperties":true,"type":"object","title":"Custom Metadata"},"docling_metadata":{"additionalProperties":true,"type":"object","title":"Docling Metadata"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"organization_id":{"type":"integer","title":"Organization Id"},"created_by":{"type":"integer","title":"Created By"},"is_active":{"type":"boolean","title":"Is Active"}},"type":"object","required":["id","document_uuid","filename","file_size_bytes","file_hash","mime_type","processing_status","total_chunks","custom_metadata","docling_metadata","created_at","updated_at","organization_id","created_by","is_active"],"title":"DocumentResponseSchema","description":"Response schema for document metadata."},"DocumentUploadRequestSchema":{"properties":{"filename":{"type":"string","title":"Filename","description":"Name of the file to upload"},"mime_type":{"type":"string","title":"Mime Type","description":"MIME type of the file"},"custom_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Metadata","description":"Optional custom metadata"}},"type":"object","required":["filename","mime_type"],"title":"DocumentUploadRequestSchema","description":"Request schema for initiating document upload."},"DocumentUploadResponseSchema":{"properties":{"upload_url":{"type":"string","title":"Upload Url","description":"Signed URL for uploading the file"},"document_uuid":{"type":"string","title":"Document Uuid","description":"Unique identifier for the document"},"s3_key":{"type":"string","title":"S3 Key","description":"S3 key where file should be uploaded"}},"type":"object","required":["upload_url","document_uuid","s3_key"],"title":"DocumentUploadResponseSchema","description":"Response schema containing upload URL and document metadata."},"DuplicateTemplateRequest":{"properties":{"template_id":{"type":"integer","title":"Template Id"},"workflow_name":{"type":"string","title":"Workflow Name"}},"type":"object","required":["template_id","workflow_name"],"title":"DuplicateTemplateRequest"},"EmbedConfigResponse":{"properties":{"workflow_id":{"type":"integer","title":"Workflow Id"},"settings":{"additionalProperties":true,"type":"object","title":"Settings"},"theme":{"type":"string","title":"Theme"},"position":{"type":"string","title":"Position"},"button_text":{"type":"string","title":"Button Text"},"button_color":{"type":"string","title":"Button Color"},"size":{"type":"string","title":"Size"},"auto_start":{"type":"boolean","title":"Auto Start"}},"type":"object","required":["workflow_id","settings","theme","position","button_text","button_color","size","auto_start"],"title":"EmbedConfigResponse","description":"Response model for embed configuration"},"EmbedTokenRequest":{"properties":{"allowed_domains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Allowed Domains"},"settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Settings"},"usage_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Usage Limit"},"expires_in_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires In Days","default":30}},"type":"object","title":"EmbedTokenRequest"},"EmbedTokenResponse":{"properties":{"id":{"type":"integer","title":"Id"},"token":{"type":"string","title":"Token"},"allowed_domains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Allowed Domains"},"settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Settings"},"is_active":{"type":"boolean","title":"Is Active"},"usage_count":{"type":"integer","title":"Usage Count"},"usage_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Usage Limit"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"embed_script":{"type":"string","title":"Embed Script"}},"type":"object","required":["id","token","allowed_domains","settings","is_active","usage_count","usage_limit","expires_at","created_at","embed_script"],"title":"EmbedTokenResponse"},"EndCallConfig":{"properties":{"messageType":{"type":"string","enum":["none","custom","audio"],"title":"Messagetype","description":"Type of goodbye message","default":"none"},"customMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custommessage","description":"Custom message to play before ending the call"},"audioRecordingId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Audiorecordingid","description":"Recording ID for audio goodbye message"},"endCallReason":{"type":"boolean","title":"Endcallreason","description":"When enabled, LLM must provide a reason for ending the call. The reason is set as call disposition and added to call tags.","default":false},"endCallReasonDescription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endcallreasondescription","description":"Description shown to the LLM for the reason parameter. Used only when endCallReason is enabled."}},"type":"object","title":"EndCallConfig","description":"Configuration for End Call tools."},"EndCallToolDefinition":{"properties":{"schema_version":{"type":"integer","title":"Schema Version","description":"Schema version","default":1},"type":{"type":"string","const":"end_call","title":"Type","description":"Tool type"},"config":{"$ref":"#/components/schemas/EndCallConfig","description":"End Call configuration"}},"type":"object","required":["type","config"],"title":"EndCallToolDefinition","description":"Tool definition for End Call tools."},"FileDescriptor":{"properties":{"filename":{"type":"string","title":"Filename","description":"Original filename of the audio file"},"mime_type":{"type":"string","title":"Mime Type","description":"MIME type of the audio file","default":"audio/wav"},"file_size":{"type":"integer","maximum":5242880.0,"exclusiveMinimum":0.0,"title":"File Size","description":"File size in bytes (max 5MB)"}},"type":"object","required":["filename","file_size"],"title":"FileDescriptor","description":"Descriptor for a single file in a batch upload request."},"FileMetadataResponse":{"properties":{"key":{"type":"string","title":"Key"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["key","metadata"],"title":"FileMetadataResponse"},"GraphConstraints":{"properties":{"min_incoming":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Incoming"},"max_incoming":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Incoming"},"min_outgoing":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Outgoing"},"max_outgoing":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Outgoing"}},"additionalProperties":false,"type":"object","title":"GraphConstraints","description":"Per-node-type graph rules. WorkflowGraph enforces these at validation."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"properties":{"status":{"type":"string","title":"Status"},"version":{"type":"string","title":"Version"},"backend_api_endpoint":{"type":"string","title":"Backend Api Endpoint"},"deployment_mode":{"type":"string","title":"Deployment Mode"},"auth_provider":{"type":"string","title":"Auth Provider"},"turn_enabled":{"type":"boolean","title":"Turn Enabled"},"force_turn_relay":{"type":"boolean","title":"Force Turn Relay"}},"type":"object","required":["status","version","backend_api_endpoint","deployment_mode","auth_provider","turn_enabled","force_turn_relay"],"title":"HealthResponse"},"HttpApiConfig":{"properties":{"method":{"type":"string","title":"Method","description":"HTTP method (GET, POST, PUT, PATCH, DELETE)"},"url":{"type":"string","title":"Url","description":"Target URL"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","description":"Static headers to include"},"credential_uuid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credential Uuid","description":"Reference to ExternalCredentialModel for auth"},"parameters":{"anyOf":[{"items":{"$ref":"#/components/schemas/ToolParameter"},"type":"array"},{"type":"null"}],"title":"Parameters","description":"Parameters that the tool accepts from LLM"},"preset_parameters":{"anyOf":[{"items":{"$ref":"#/components/schemas/PresetToolParameter"},"type":"array"},{"type":"null"}],"title":"Preset Parameters","description":"Parameters injected by Dograh from fixed values or workflow context templates"},"timeout_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout Ms","description":"Request timeout in milliseconds","default":5000},"customMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custommessage","description":"Custom message to play after tool execution"},"customMessageType":{"anyOf":[{"type":"string","enum":["text","audio"]},{"type":"null"}],"title":"Custommessagetype","description":"Type of custom message: text or audio"},"customMessageRecordingId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custommessagerecordingid","description":"Recording ID for audio custom message"}},"type":"object","required":["method","url"],"title":"HttpApiConfig","description":"Configuration for HTTP API tools."},"HttpApiToolDefinition":{"properties":{"schema_version":{"type":"integer","title":"Schema Version","description":"Schema version","default":1},"type":{"type":"string","const":"http_api","title":"Type","description":"Tool type"},"config":{"$ref":"#/components/schemas/HttpApiConfig","description":"HTTP API configuration"}},"type":"object","required":["type","config"],"title":"HttpApiToolDefinition","description":"Tool definition for HTTP API tools."},"ImpersonateRequest":{"properties":{"provider_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider User Id"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"}},"type":"object","title":"ImpersonateRequest","description":"Request payload for superadmin impersonation.\n\nEither ``provider_user_id`` **or** ``user_id`` must be supplied. If both are\nprovided, ``provider_user_id`` takes precedence."},"ImpersonateResponse":{"properties":{"refresh_token":{"type":"string","title":"Refresh Token"},"access_token":{"type":"string","title":"Access Token"}},"type":"object","required":["refresh_token","access_token"],"title":"ImpersonateResponse"},"InitEmbedRequest":{"properties":{"token":{"type":"string","title":"Token"},"context_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Context Variables"}},"type":"object","required":["token"],"title":"InitEmbedRequest","description":"Request model for initializing an embed session"},"InitEmbedResponse":{"properties":{"session_token":{"type":"string","title":"Session Token"},"workflow_run_id":{"type":"integer","title":"Workflow Run Id"},"config":{"additionalProperties":true,"type":"object","title":"Config"}},"type":"object","required":["session_token","workflow_run_id","config"],"title":"InitEmbedResponse","description":"Response model for embed initialization"},"InitiateCallRequest":{"properties":{"workflow_id":{"type":"integer","title":"Workflow Id"},"workflow_run_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Workflow Run Id"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"telephony_configuration_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Telephony Configuration Id"},"from_phone_number_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"From Phone Number Id"}},"type":"object","required":["workflow_id"],"title":"InitiateCallRequest"},"ItemKind":{"type":"string","enum":["node","edge","workflow"],"title":"ItemKind"},"LangfuseCredentialsRequest":{"properties":{"host":{"type":"string","title":"Host"},"public_key":{"type":"string","title":"Public Key"},"secret_key":{"type":"string","title":"Secret Key"}},"type":"object","required":["host","public_key","secret_key"],"title":"LangfuseCredentialsRequest"},"LangfuseCredentialsResponse":{"properties":{"host":{"type":"string","title":"Host","default":""},"public_key":{"type":"string","title":"Public Key","default":""},"secret_key":{"type":"string","title":"Secret Key","default":""},"configured":{"type":"boolean","title":"Configured","default":false}},"type":"object","title":"LangfuseCredentialsResponse"},"LastCampaignSettingsResponse":{"properties":{"retry_config":{"anyOf":[{"$ref":"#/components/schemas/RetryConfigResponse"},{"type":"null"}]},"max_concurrency":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Concurrency"},"schedule_config":{"anyOf":[{"$ref":"#/components/schemas/ScheduleConfigResponse"},{"type":"null"}]},"circuit_breaker":{"anyOf":[{"$ref":"#/components/schemas/CircuitBreakerConfigResponse"},{"type":"null"}]}},"type":"object","title":"LastCampaignSettingsResponse"},"LoginRequest":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"}},"type":"object","required":["email","password"],"title":"LoginRequest"},"MPSCreditsResponse":{"properties":{"total_credits_used":{"type":"number","title":"Total Credits Used"},"remaining_credits":{"type":"number","title":"Remaining Credits"},"total_quota":{"type":"number","title":"Total Quota"}},"type":"object","required":["total_credits_used","remaining_credits","total_quota"],"title":"MPSCreditsResponse"},"McpRefreshResponse":{"properties":{"tool_uuid":{"type":"string","title":"Tool Uuid"},"discovered_tools":{"items":{},"type":"array","title":"Discovered Tools"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["tool_uuid"],"title":"McpRefreshResponse","description":"Result of re-discovering an MCP server's tool catalog."},"McpToolConfig":{"properties":{"transport":{"type":"string","const":"streamable_http","title":"Transport","description":"MCP transport protocol","default":"streamable_http"},"url":{"type":"string","title":"Url","description":"MCP server URL (must be http:// or https://)"},"credential_uuid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credential Uuid","description":"Reference to ExternalCredentialModel for auth"},"tools_filter":{"items":{"type":"string"},"type":"array","title":"Tools Filter","description":"Allowlist of MCP tool names to expose (empty = all tools)"},"timeout_secs":{"type":"integer","title":"Timeout Secs","description":"Connection timeout in seconds","default":30},"sse_read_timeout_secs":{"type":"integer","title":"Sse Read Timeout Secs","description":"SSE read timeout in seconds","default":300},"discovered_tools":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Discovered Tools","description":"Server-managed cache of the MCP server's tool catalog [{name, description}]. Populated best-effort by the backend."}},"type":"object","required":["url"],"title":"McpToolConfig","description":"Configuration for an MCP tool definition."},"McpToolDefinition":{"properties":{"schema_version":{"type":"integer","title":"Schema Version","description":"Schema version","default":1},"type":{"type":"string","const":"mcp","title":"Type","description":"Tool type"},"config":{"$ref":"#/components/schemas/McpToolConfig","description":"MCP server configuration"}},"type":"object","required":["type","config"],"title":"McpToolDefinition","description":"Persisted MCP tool definition."},"NodeCategory":{"type":"string","enum":["call_node","global_node","trigger","integration"],"title":"NodeCategory","description":"Drives grouping in the AddNodePanel UI."},"NodeExample":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"data":{"additionalProperties":true,"type":"object","title":"Data"}},"additionalProperties":false,"type":"object","required":["name","data"],"title":"NodeExample","description":"A worked example LLMs can pattern-match. Keep small and realistic."},"NodeSpec":{"properties":{"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"},"description":{"type":"string","minLength":1,"title":"Description","description":"Human-facing explanation shown in AddNodePanel."},"llm_hint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Llm Hint","description":"LLM-only guidance; omitted from the UI."},"category":{"$ref":"#/components/schemas/NodeCategory"},"icon":{"type":"string","title":"Icon"},"version":{"type":"string","title":"Version","default":"1.0.0"},"properties":{"items":{"$ref":"#/components/schemas/PropertySpec"},"type":"array","title":"Properties"},"examples":{"items":{"$ref":"#/components/schemas/NodeExample"},"type":"array","title":"Examples"},"graph_constraints":{"anyOf":[{"$ref":"#/components/schemas/GraphConstraints"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["name","display_name","description","category","icon","properties"],"title":"NodeSpec","description":"Single source of truth for a node type."},"NodeTypesResponse":{"properties":{"spec_version":{"type":"string","title":"Spec Version"},"node_types":{"items":{"$ref":"#/components/schemas/NodeSpec"},"type":"array","title":"Node Types"}},"type":"object","required":["spec_version","node_types"],"title":"NodeTypesResponse"},"PhoneNumberCreateRequest":{"properties":{"address":{"type":"string","maxLength":255,"minLength":1,"title":"Address"},"country_code":{"anyOf":[{"type":"string","maxLength":2,"minLength":2},{"type":"null"}],"title":"Country Code"},"label":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Label"},"inbound_workflow_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Inbound Workflow Id"},"is_active":{"type":"boolean","title":"Is Active","default":true},"is_default_caller_id":{"type":"boolean","title":"Is Default Caller Id","default":false},"extra_metadata":{"additionalProperties":true,"type":"object","title":"Extra Metadata"}},"type":"object","required":["address"],"title":"PhoneNumberCreateRequest","description":"Create a new phone number under a telephony configuration.\n\n``address_normalized`` and ``address_type`` are computed server-side from\n``address`` (and ``country_code`` if PSTN). ``address`` itself is stored\nverbatim for display."},"PhoneNumberListResponse":{"properties":{"phone_numbers":{"items":{"$ref":"#/components/schemas/PhoneNumberResponse"},"type":"array","title":"Phone Numbers"}},"type":"object","required":["phone_numbers"],"title":"PhoneNumberListResponse"},"PhoneNumberResponse":{"properties":{"id":{"type":"integer","title":"Id"},"telephony_configuration_id":{"type":"integer","title":"Telephony Configuration Id"},"address":{"type":"string","title":"Address"},"address_normalized":{"type":"string","title":"Address Normalized"},"address_type":{"type":"string","title":"Address Type"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"inbound_workflow_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Inbound Workflow Id"},"inbound_workflow_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inbound Workflow Name"},"is_active":{"type":"boolean","title":"Is Active"},"is_default_caller_id":{"type":"boolean","title":"Is Default Caller Id"},"extra_metadata":{"additionalProperties":true,"type":"object","title":"Extra Metadata"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"provider_sync":{"anyOf":[{"$ref":"#/components/schemas/ProviderSyncStatus"},{"type":"null"}]}},"type":"object","required":["id","telephony_configuration_id","address","address_normalized","address_type","is_active","is_default_caller_id","extra_metadata","created_at","updated_at"],"title":"PhoneNumberResponse"},"PhoneNumberUpdateRequest":{"properties":{"label":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Label"},"inbound_workflow_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Inbound Workflow Id"},"clear_inbound_workflow":{"type":"boolean","title":"Clear Inbound Workflow","default":false},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"country_code":{"anyOf":[{"type":"string","maxLength":2,"minLength":2},{"type":"null"}],"title":"Country Code"},"extra_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Extra Metadata"}},"type":"object","title":"PhoneNumberUpdateRequest","description":"Partial update. ``address`` is intentionally immutable \u2014 to change a\nnumber, delete the row and create a new one."},"PlivoConfigurationRequest":{"properties":{"provider":{"type":"string","const":"plivo","title":"Provider","default":"plivo"},"auth_id":{"type":"string","title":"Auth Id","description":"Plivo Auth ID"},"auth_token":{"type":"string","title":"Auth Token","description":"Plivo Auth Token"},"application_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Id","description":"Plivo Application ID. The application's answer_url is updated when inbound workflows are attached to numbers on this account. If omitted, an application is auto-created on save and its id is stored on the configuration."},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Plivo phone numbers"}},"type":"object","required":["auth_id","auth_token"],"title":"PlivoConfigurationRequest","description":"Request schema for Plivo configuration."},"PlivoConfigurationResponse":{"properties":{"provider":{"type":"string","const":"plivo","title":"Provider","default":"plivo"},"auth_id":{"type":"string","title":"Auth Id"},"auth_token":{"type":"string","title":"Auth Token"},"application_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Id"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["auth_id","auth_token","from_numbers"],"title":"PlivoConfigurationResponse","description":"Response schema for Plivo configuration with masked sensitive fields."},"PresetToolParameter":{"properties":{"name":{"type":"string","title":"Name","description":"Parameter name (used as key in request body)"},"type":{"type":"string","title":"Type","description":"Parameter type: string, number, or boolean"},"value_template":{"type":"string","title":"Value Template","description":"Fixed value or template, e.g. {{initial_context.phone_number}}"},"required":{"type":"boolean","title":"Required","description":"Whether the parameter must resolve to a non-empty value","default":true}},"type":"object","required":["name","type","value_template"],"title":"PresetToolParameter","description":"A parameter injected by Dograh at runtime."},"PresignedUploadUrlRequest":{"properties":{"file_name":{"type":"string","pattern":".*\\.csv$","title":"File Name","description":"CSV filename"},"file_size":{"type":"integer","maximum":10485760.0,"exclusiveMinimum":0.0,"title":"File Size","description":"File size in bytes (max 10MB)"},"content_type":{"type":"string","title":"Content Type","description":"File content type","default":"text/csv"}},"type":"object","required":["file_name","file_size"],"title":"PresignedUploadUrlRequest"},"PresignedUploadUrlResponse":{"properties":{"upload_url":{"type":"string","title":"Upload Url"},"file_key":{"type":"string","title":"File Key"},"expires_in":{"type":"integer","title":"Expires In"}},"type":"object","required":["upload_url","file_key","expires_in"],"title":"PresignedUploadUrlResponse"},"ProcessDocumentRequestSchema":{"properties":{"document_uuid":{"type":"string","title":"Document Uuid","description":"Document UUID to process"},"s3_key":{"type":"string","title":"S3 Key","description":"S3 key of the uploaded file"},"retrieval_mode":{"type":"string","title":"Retrieval Mode","description":"Retrieval mode: 'chunked' for vector search or 'full_document' for full text retrieval","default":"chunked"}},"type":"object","required":["document_uuid","s3_key"],"title":"ProcessDocumentRequestSchema","description":"Request schema for triggering document processing."},"PropertyOption":{"properties":{"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"},{"type":"number"}],"title":"Value"},"label":{"type":"string","title":"Label"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"additionalProperties":false,"type":"object","required":["value","label"],"title":"PropertyOption","description":"An option in an `options` or `multi_options` dropdown."},"PropertySpec":{"properties":{"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/PropertyType"},"display_name":{"type":"string","title":"Display Name"},"description":{"type":"string","minLength":1,"title":"Description","description":"Human-facing explanation shown in the UI."},"llm_hint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Llm Hint","description":"LLM-only guidance; omitted from the UI."},"default":{"title":"Default"},"required":{"type":"boolean","title":"Required","default":false},"placeholder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Placeholder"},"display_options":{"anyOf":[{"$ref":"#/components/schemas/DisplayOptions"},{"type":"null"}]},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyOption"},"type":"array"},{"type":"null"}],"title":"Options"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertySpec"},"type":"array"},{"type":"null"}],"title":"Properties"},"min_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Value"},"max_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Value"},"min_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Length"},"max_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Length"},"pattern":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pattern"},"editor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Editor"},"extra":{"additionalProperties":true,"type":"object","title":"Extra"}},"additionalProperties":false,"type":"object","required":["name","type","display_name","description"],"title":"PropertySpec","description":"Single field on a node.\n\n`description` is HUMAN-FACING \u2014 shown under the field in the edit\ndialog. Keep it concise and explain what the field does.\n\n`llm_hint` is LLM-FACING \u2014 appears only in the `get_node_type` MCP\nresponse and in SDK schema output. Use it for catalog tool references\n(e.g., \"Use `list_recordings`\"), array shape, expected value idioms,\nor anything that would be noise in the UI. Optional; omit when the\n`description` already suffices for both audiences."},"PropertyType":{"type":"string","enum":["string","number","boolean","options","multi_options","fixed_collection","json","tool_refs","document_refs","recording_ref","credential_ref","mention_textarea","url"],"title":"PropertyType","description":"Bounded vocabulary of property types the renderer dispatches on.\n\nAdding a value here requires a matching arm in the frontend\n`` switch and (where relevant) the SDK codegen template."},"ProviderSyncStatus":{"properties":{"ok":{"type":"boolean","title":"Ok"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"}},"type":"object","required":["ok"],"title":"ProviderSyncStatus","description":"Result of pushing a phone-number change to the upstream provider.\n\nReturned alongside create/update responses when the route attempted to\nsync inbound webhook configuration. ``ok=False`` is a warning, not a\nfatal error \u2014 the DB write succeeded."},"RecordingCreateRequestSchema":{"properties":{"recording_id":{"type":"string","title":"Recording Id","description":"Short recording ID from upload step"},"tts_provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Provider","description":"TTS provider (e.g. elevenlabs)"},"tts_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Model","description":"TTS model name"},"tts_voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Voice Id","description":"TTS voice identifier"},"transcript":{"type":"string","title":"Transcript","description":"User-provided transcript of the recording"},"storage_key":{"type":"string","title":"Storage Key","description":"Storage key from upload step"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"Optional metadata (file_size, duration, etc.)"}},"type":"object","required":["recording_id","transcript","storage_key"],"title":"RecordingCreateRequestSchema","description":"Request schema for creating a recording record after upload."},"RecordingListResponseSchema":{"properties":{"recordings":{"items":{"$ref":"#/components/schemas/RecordingResponseSchema"},"type":"array","title":"Recordings"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["recordings","total"],"title":"RecordingListResponseSchema","description":"Response schema for list of recordings."},"RecordingResponseSchema":{"properties":{"id":{"type":"integer","title":"Id"},"recording_id":{"type":"string","title":"Recording Id"},"workflow_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Workflow Id"},"organization_id":{"type":"integer","title":"Organization Id"},"tts_provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Provider"},"tts_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Model"},"tts_voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Voice Id"},"transcript":{"type":"string","title":"Transcript"},"storage_key":{"type":"string","title":"Storage Key"},"storage_backend":{"type":"string","title":"Storage Backend"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"created_by":{"type":"integer","title":"Created By"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"is_active":{"type":"boolean","title":"Is Active"}},"type":"object","required":["id","recording_id","organization_id","transcript","storage_key","storage_backend","metadata","created_by","created_at","is_active"],"title":"RecordingResponseSchema","description":"Response schema for a single recording."},"RecordingUpdateRequestSchema":{"properties":{"recording_id":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_-]+$","title":"Recording Id","description":"New descriptive recording ID (letters, numbers, hyphens, underscores only)"}},"type":"object","required":["recording_id"],"title":"RecordingUpdateRequestSchema","description":"Request schema for updating a recording's ID."},"RecordingUploadResponseSchema":{"properties":{"upload_url":{"type":"string","title":"Upload Url","description":"Presigned URL for uploading the audio"},"recording_id":{"type":"string","title":"Recording Id","description":"Short unique recording ID"},"storage_key":{"type":"string","title":"Storage Key","description":"Storage key where file will be uploaded"}},"type":"object","required":["upload_url","recording_id","storage_key"],"title":"RecordingUploadResponseSchema","description":"Response schema with presigned upload URL."},"RedialCampaignRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name","description":"Name for the redial campaign"},"retry_on_voicemail":{"type":"boolean","title":"Retry On Voicemail","default":true},"retry_on_no_answer":{"type":"boolean","title":"Retry On No Answer","default":true},"retry_on_busy":{"type":"boolean","title":"Retry On Busy","default":true},"retry_config":{"anyOf":[{"$ref":"#/components/schemas/RetryConfigRequest"},{"type":"null"}]}},"type":"object","title":"RedialCampaignRequest"},"RetryConfigRequest":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":true},"max_retries":{"type":"integer","maximum":10.0,"minimum":0.0,"title":"Max Retries","default":2},"retry_delay_seconds":{"type":"integer","maximum":3600.0,"minimum":30.0,"title":"Retry Delay Seconds","default":120},"retry_on_busy":{"type":"boolean","title":"Retry On Busy","default":true},"retry_on_no_answer":{"type":"boolean","title":"Retry On No Answer","default":true},"retry_on_voicemail":{"type":"boolean","title":"Retry On Voicemail","default":true}},"type":"object","title":"RetryConfigRequest"},"RetryConfigResponse":{"properties":{"enabled":{"type":"boolean","title":"Enabled"},"max_retries":{"type":"integer","title":"Max Retries"},"retry_delay_seconds":{"type":"integer","title":"Retry Delay Seconds"},"retry_on_busy":{"type":"boolean","title":"Retry On Busy"},"retry_on_no_answer":{"type":"boolean","title":"Retry On No Answer"},"retry_on_voicemail":{"type":"boolean","title":"Retry On Voicemail"}},"type":"object","required":["enabled","max_retries","retry_delay_seconds","retry_on_busy","retry_on_no_answer","retry_on_voicemail"],"title":"RetryConfigResponse"},"S3SignedUrlResponse":{"properties":{"url":{"type":"string","title":"Url"},"expires_in":{"type":"integer","title":"Expires In"}},"type":"object","required":["url","expires_in"],"title":"S3SignedUrlResponse"},"ScheduleConfigRequest":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":true},"timezone":{"type":"string","title":"Timezone","default":"UTC"},"slots":{"items":{"$ref":"#/components/schemas/TimeSlotRequest"},"type":"array","maxItems":50,"minItems":1,"title":"Slots"}},"type":"object","required":["slots"],"title":"ScheduleConfigRequest"},"ScheduleConfigResponse":{"properties":{"enabled":{"type":"boolean","title":"Enabled"},"timezone":{"type":"string","title":"Timezone"},"slots":{"items":{"$ref":"#/components/schemas/TimeSlotResponse"},"type":"array","title":"Slots"}},"type":"object","required":["enabled","timezone","slots"],"title":"ScheduleConfigResponse"},"ServiceKeyResponse":{"properties":{"name":{"type":"string","title":"Name"},"id":{"type":"integer","title":"Id"},"key_prefix":{"type":"string","title":"Key Prefix"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"}},"type":"object","required":["name","id","key_prefix","is_active","created_at"],"title":"ServiceKeyResponse"},"SignupRequest":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["email","password"],"title":"SignupRequest"},"SuperuserWorkflowRunResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"workflow_id":{"type":"integer","title":"Workflow Id"},"workflow_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Name"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"organization_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Organization Id"},"organization_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organization Name"},"mode":{"type":"string","title":"Mode"},"is_completed":{"type":"boolean","title":"Is Completed"},"recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Url"},"transcript_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcript Url"},"usage_info":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Usage Info"},"cost_info":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Cost Info"},"initial_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Initial Context"},"gathered_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Gathered Context"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","name","workflow_id","workflow_name","user_id","organization_id","organization_name","mode","is_completed","recording_url","transcript_url","usage_info","cost_info","initial_context","gathered_context","created_at"],"title":"SuperuserWorkflowRunResponse"},"SuperuserWorkflowRunsListResponse":{"properties":{"workflow_runs":{"items":{"$ref":"#/components/schemas/SuperuserWorkflowRunResponse"},"type":"array","title":"Workflow Runs"},"total_count":{"type":"integer","title":"Total Count"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"},"total_pages":{"type":"integer","title":"Total Pages"}},"type":"object","required":["workflow_runs","total_count","page","limit","total_pages"],"title":"SuperuserWorkflowRunsListResponse"},"TelephonyConfigWarningsResponse":{"properties":{"telnyx_missing_webhook_public_key_count":{"type":"integer","title":"Telnyx Missing Webhook Public Key Count"}},"type":"object","required":["telnyx_missing_webhook_public_key_count"],"title":"TelephonyConfigWarningsResponse","description":"Aggregated telephony-configuration warning counts for the user's org.\n\nDrives the page banner and nav badge that nudge customers to finish\noptional-but-recommended configuration steps. Shape is a flat dict so\nnew warning types can be added without breaking the client."},"TelephonyConfigurationCreateRequest":{"properties":{"name":{"type":"string","maxLength":64,"minLength":1,"title":"Name"},"is_default_outbound":{"type":"boolean","title":"Is Default Outbound","default":false},"config":{"oneOf":[{"$ref":"#/components/schemas/ARIConfigurationRequest"},{"$ref":"#/components/schemas/CloudonixConfigurationRequest"},{"$ref":"#/components/schemas/PlivoConfigurationRequest"},{"$ref":"#/components/schemas/TelnyxConfigurationRequest"},{"$ref":"#/components/schemas/TwilioConfigurationRequest"},{"$ref":"#/components/schemas/VobizConfigurationRequest"},{"$ref":"#/components/schemas/VonageConfigurationRequest"}],"title":"Config","discriminator":{"propertyName":"provider","mapping":{"ari":"#/components/schemas/ARIConfigurationRequest","cloudonix":"#/components/schemas/CloudonixConfigurationRequest","plivo":"#/components/schemas/PlivoConfigurationRequest","telnyx":"#/components/schemas/TelnyxConfigurationRequest","twilio":"#/components/schemas/TwilioConfigurationRequest","vobiz":"#/components/schemas/VobizConfigurationRequest","vonage":"#/components/schemas/VonageConfigurationRequest"}}}},"type":"object","required":["name","config"],"title":"TelephonyConfigurationCreateRequest","description":"Body for ``POST /telephony-configs``.\n\n``config`` carries the provider-specific credential fields (the same\ndiscriminated union used by the legacy single-config endpoint). Any\n``from_numbers`` on the inner config are ignored \u2014 phone numbers are\nmanaged via the dedicated phone-numbers endpoints."},"TelephonyConfigurationDetail":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"provider":{"type":"string","title":"Provider"},"is_default_outbound":{"type":"boolean","title":"Is Default Outbound"},"credentials":{"additionalProperties":true,"type":"object","title":"Credentials"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","provider","is_default_outbound","credentials","created_at","updated_at"],"title":"TelephonyConfigurationDetail","description":"Body of ``GET /telephony-configs/{id}`` \u2014 credentials are masked."},"TelephonyConfigurationListItem":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"provider":{"type":"string","title":"Provider"},"is_default_outbound":{"type":"boolean","title":"Is Default Outbound"},"phone_number_count":{"type":"integer","title":"Phone Number Count","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","provider","is_default_outbound","created_at","updated_at"],"title":"TelephonyConfigurationListItem","description":"One row in ``GET /telephony-configs``."},"TelephonyConfigurationListResponse":{"properties":{"configurations":{"items":{"$ref":"#/components/schemas/TelephonyConfigurationListItem"},"type":"array","title":"Configurations"}},"type":"object","required":["configurations"],"title":"TelephonyConfigurationListResponse"},"TelephonyConfigurationResponse":{"properties":{"twilio":{"anyOf":[{"$ref":"#/components/schemas/TwilioConfigurationResponse"},{"type":"null"}]},"plivo":{"anyOf":[{"$ref":"#/components/schemas/PlivoConfigurationResponse"},{"type":"null"}]},"vonage":{"anyOf":[{"$ref":"#/components/schemas/VonageConfigurationResponse"},{"type":"null"}]},"vobiz":{"anyOf":[{"$ref":"#/components/schemas/VobizConfigurationResponse"},{"type":"null"}]},"cloudonix":{"anyOf":[{"$ref":"#/components/schemas/CloudonixConfigurationResponse"},{"type":"null"}]},"ari":{"anyOf":[{"$ref":"#/components/schemas/ARIConfigurationResponse"},{"type":"null"}]},"telnyx":{"anyOf":[{"$ref":"#/components/schemas/TelnyxConfigurationResponse"},{"type":"null"}]}},"type":"object","title":"TelephonyConfigurationResponse","description":"Top-level telephony configuration response.\n\nKeeps the per-provider field shape that the UI client depends on. When\nthe UI moves to metadata-driven forms, this can be replaced with a\nflat discriminated union."},"TelephonyConfigurationUpdateRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":64,"minLength":1},{"type":"null"}],"title":"Name"},"config":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/ARIConfigurationRequest"},{"$ref":"#/components/schemas/CloudonixConfigurationRequest"},{"$ref":"#/components/schemas/PlivoConfigurationRequest"},{"$ref":"#/components/schemas/TelnyxConfigurationRequest"},{"$ref":"#/components/schemas/TwilioConfigurationRequest"},{"$ref":"#/components/schemas/VobizConfigurationRequest"},{"$ref":"#/components/schemas/VonageConfigurationRequest"}],"discriminator":{"propertyName":"provider","mapping":{"ari":"#/components/schemas/ARIConfigurationRequest","cloudonix":"#/components/schemas/CloudonixConfigurationRequest","plivo":"#/components/schemas/PlivoConfigurationRequest","telnyx":"#/components/schemas/TelnyxConfigurationRequest","twilio":"#/components/schemas/TwilioConfigurationRequest","vobiz":"#/components/schemas/VobizConfigurationRequest","vonage":"#/components/schemas/VonageConfigurationRequest"}}},{"type":"null"}],"title":"Config"}},"type":"object","title":"TelephonyConfigurationUpdateRequest","description":"Body for ``PUT /telephony-configs/{id}``. Partial update."},"TelephonyProviderMetadata":{"properties":{"provider":{"type":"string","title":"Provider"},"display_name":{"type":"string","title":"Display Name"},"fields":{"items":{"$ref":"#/components/schemas/TelephonyProviderUIField"},"type":"array","title":"Fields"},"docs_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Docs Url"}},"type":"object","required":["provider","display_name","fields"],"title":"TelephonyProviderMetadata","description":"UI form metadata for a single telephony provider."},"TelephonyProviderUIField":{"properties":{"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"type":{"type":"string","title":"Type"},"required":{"type":"boolean","title":"Required"},"sensitive":{"type":"boolean","title":"Sensitive"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"placeholder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Placeholder"}},"type":"object","required":["name","label","type","required","sensitive"],"title":"TelephonyProviderUIField","description":"One form field on a telephony provider's configuration UI."},"TelephonyProvidersMetadataResponse":{"properties":{"providers":{"items":{"$ref":"#/components/schemas/TelephonyProviderMetadata"},"type":"array","title":"Providers"}},"type":"object","required":["providers"],"title":"TelephonyProvidersMetadataResponse","description":"List of UI form definitions used by the telephony-config screen."},"TelnyxConfigurationRequest":{"properties":{"provider":{"type":"string","const":"telnyx","title":"Provider","default":"telnyx"},"api_key":{"type":"string","title":"Api Key","description":"Telnyx API Key"},"connection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connection Id","description":"Telnyx Call Control Application ID (connection_id). If omitted, a Call Control Application is auto-created on save and its id is stored on the configuration."},"webhook_public_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Public Key","description":"Webhook public key from Mission Control Portal \u2192 Keys & Credentials \u2192 Public Key. Used to verify Telnyx webhook signatures."},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Telnyx phone numbers"}},"type":"object","required":["api_key"],"title":"TelnyxConfigurationRequest","description":"Request schema for Telnyx configuration."},"TelnyxConfigurationResponse":{"properties":{"provider":{"type":"string","const":"telnyx","title":"Provider","default":"telnyx"},"api_key":{"type":"string","title":"Api Key"},"connection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connection Id"},"webhook_public_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Public Key"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["api_key","from_numbers"],"title":"TelnyxConfigurationResponse","description":"Response schema for Telnyx configuration with masked sensitive fields."},"TimeSlotRequest":{"properties":{"day_of_week":{"type":"integer","maximum":6.0,"minimum":0.0,"title":"Day Of Week"},"start_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","title":"Start Time"},"end_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","title":"End Time"}},"type":"object","required":["day_of_week","start_time","end_time"],"title":"TimeSlotRequest"},"TimeSlotResponse":{"properties":{"day_of_week":{"type":"integer","title":"Day Of Week"},"start_time":{"type":"string","title":"Start Time"},"end_time":{"type":"string","title":"End Time"}},"type":"object","required":["day_of_week","start_time","end_time"],"title":"TimeSlotResponse"},"ToolParameter":{"properties":{"name":{"type":"string","title":"Name","description":"Parameter name (used as key in request body)"},"type":{"type":"string","title":"Type","description":"Parameter type: string, number, or boolean"},"description":{"type":"string","title":"Description","description":"Description of what this parameter is for"},"required":{"type":"boolean","title":"Required","description":"Whether this parameter is required","default":true}},"type":"object","required":["name","type","description"],"title":"ToolParameter","description":"A parameter that the tool accepts."},"ToolResponse":{"properties":{"id":{"type":"integer","title":"Id"},"tool_uuid":{"type":"string","title":"Tool Uuid"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"category":{"type":"string","title":"Category"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"icon_color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Color"},"status":{"type":"string","title":"Status"},"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedByResponse"},{"type":"null"}]}},"type":"object","required":["id","tool_uuid","name","description","category","icon","icon_color","status","definition","created_at","updated_at"],"title":"ToolResponse","description":"Response schema for a tool."},"TransferCallConfig":{"properties":{"destination":{"type":"string","title":"Destination","description":"Phone number or SIP endpoint to transfer the call to (E.164 format e.g., +1234567890, or SIP endpoint e.g., PJSIP/1234)"},"messageType":{"type":"string","enum":["none","custom","audio"],"title":"Messagetype","description":"Type of message to play before transfer","default":"none"},"customMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custommessage","description":"Custom message to play before transferring the call"},"audioRecordingId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Audiorecordingid","description":"Recording ID for audio message before transfer"},"timeout":{"type":"integer","maximum":120.0,"minimum":5.0,"title":"Timeout","description":"Maximum time in seconds to wait for destination to answer (5-120 seconds)","default":30}},"type":"object","required":["destination"],"title":"TransferCallConfig","description":"Configuration for Transfer Call tools."},"TransferCallToolDefinition":{"properties":{"schema_version":{"type":"integer","title":"Schema Version","description":"Schema version","default":1},"type":{"type":"string","const":"transfer_call","title":"Type","description":"Tool type"},"config":{"$ref":"#/components/schemas/TransferCallConfig","description":"Transfer Call configuration"}},"type":"object","required":["type","config"],"title":"TransferCallToolDefinition","description":"Tool definition for Transfer Call tools."},"TriggerCallRequest":{"properties":{"phone_number":{"type":"string","title":"Phone Number"},"initial_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Initial Context"},"telephony_configuration_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Telephony Configuration Id"}},"type":"object","required":["phone_number"],"title":"TriggerCallRequest","description":"Request model for triggering a call via API"},"TriggerCallResponse":{"properties":{"status":{"type":"string","title":"Status"},"workflow_run_id":{"type":"integer","title":"Workflow Run Id"},"workflow_run_name":{"type":"string","title":"Workflow Run Name"}},"type":"object","required":["status","workflow_run_id","workflow_run_name"],"title":"TriggerCallResponse","description":"Response model for successful call initiation"},"TurnCredentialsResponse":{"properties":{"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"ttl":{"type":"integer","title":"Ttl"},"uris":{"items":{"type":"string"},"type":"array","title":"Uris"}},"type":"object","required":["username","password","ttl","uris"],"title":"TurnCredentialsResponse","description":"Response model for TURN credentials."},"TwilioConfigurationRequest":{"properties":{"provider":{"type":"string","const":"twilio","title":"Provider","default":"twilio"},"account_sid":{"type":"string","title":"Account Sid","description":"Twilio Account SID"},"auth_token":{"type":"string","title":"Auth Token","description":"Twilio Auth Token"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Twilio phone numbers"}},"type":"object","required":["account_sid","auth_token"],"title":"TwilioConfigurationRequest","description":"Request schema for Twilio configuration."},"TwilioConfigurationResponse":{"properties":{"provider":{"type":"string","const":"twilio","title":"Provider","default":"twilio"},"account_sid":{"type":"string","title":"Account Sid"},"auth_token":{"type":"string","title":"Auth Token"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["account_sid","auth_token","from_numbers"],"title":"TwilioConfigurationResponse","description":"Response schema for Twilio configuration with masked sensitive fields."},"UpdateCampaignRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name"},"retry_config":{"anyOf":[{"$ref":"#/components/schemas/RetryConfigRequest"},{"type":"null"}]},"max_concurrency":{"anyOf":[{"type":"integer","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Max Concurrency"},"schedule_config":{"anyOf":[{"$ref":"#/components/schemas/ScheduleConfigRequest"},{"type":"null"}]},"circuit_breaker":{"anyOf":[{"$ref":"#/components/schemas/CircuitBreakerConfigRequest"},{"type":"null"}]}},"type":"object","title":"UpdateCampaignRequest"},"UpdateCredentialRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"credential_type":{"anyOf":[{"$ref":"#/components/schemas/WebhookCredentialType"},{"type":"null"}]},"credential_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Credential Data"}},"type":"object","title":"UpdateCredentialRequest","description":"Request schema for updating a webhook credential."},"UpdateToolRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"icon":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"title":"Icon"},"icon_color":{"anyOf":[{"type":"string","maxLength":7},{"type":"null"}],"title":"Icon Color"},"definition":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/HttpApiToolDefinition"},{"$ref":"#/components/schemas/EndCallToolDefinition"},{"$ref":"#/components/schemas/TransferCallToolDefinition"},{"$ref":"#/components/schemas/CalculatorToolDefinition"},{"$ref":"#/components/schemas/McpToolDefinition"}],"discriminator":{"propertyName":"type","mapping":{"calculator":"#/components/schemas/CalculatorToolDefinition","end_call":"#/components/schemas/EndCallToolDefinition","http_api":"#/components/schemas/HttpApiToolDefinition","mcp":"#/components/schemas/McpToolDefinition","transfer_call":"#/components/schemas/TransferCallToolDefinition"}}},{"type":"null"}],"title":"Definition"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","title":"UpdateToolRequest","description":"Request schema for updating a tool."},"UpdateWorkflowRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"workflow_definition":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Workflow Definition"},"template_context_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Template Context Variables"},"workflow_configurations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Workflow Configurations"}},"type":"object","title":"UpdateWorkflowRequest"},"UpdateWorkflowStatusRequest":{"properties":{"status":{"type":"string","title":"Status"}},"type":"object","required":["status"],"title":"UpdateWorkflowStatusRequest"},"UsageHistoryResponse":{"properties":{"runs":{"items":{"$ref":"#/components/schemas/WorkflowRunUsageResponse"},"type":"array","title":"Runs"},"total_dograh_tokens":{"type":"number","title":"Total Dograh Tokens"},"total_duration_seconds":{"type":"integer","title":"Total Duration Seconds"},"total_count":{"type":"integer","title":"Total Count"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"},"total_pages":{"type":"integer","title":"Total Pages"}},"type":"object","required":["runs","total_dograh_tokens","total_duration_seconds","total_count","page","limit","total_pages"],"title":"UsageHistoryResponse"},"UserConfigurationRequestResponseSchema":{"properties":{"llm":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Llm"},"tts":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Tts"},"stt":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Stt"},"embeddings":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Embeddings"},"realtime":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Realtime"},"is_realtime":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Realtime"},"test_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Test Phone Number"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone"},"organization_pricing":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"}]},"type":"object"},{"type":"null"}],"title":"Organization Pricing"}},"type":"object","title":"UserConfigurationRequestResponseSchema"},"UserResponse":{"properties":{"id":{"type":"integer","title":"Id"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"organization_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Organization Id"},"provider_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Id"}},"type":"object","required":["id","email"],"title":"UserResponse"},"ValidateWorkflowResponse":{"properties":{"is_valid":{"type":"boolean","title":"Is Valid"},"errors":{"items":{"$ref":"#/components/schemas/WorkflowError"},"type":"array","title":"Errors"}},"type":"object","required":["is_valid","errors"],"title":"ValidateWorkflowResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VobizConfigurationRequest":{"properties":{"provider":{"type":"string","const":"vobiz","title":"Provider","default":"vobiz"},"auth_id":{"type":"string","title":"Auth Id","description":"Vobiz Account ID (e.g., MA_SYQRLN1K)"},"auth_token":{"type":"string","title":"Auth Token","description":"Vobiz Auth Token"},"application_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Id","description":"Vobiz Application ID. The application's answer_url is updated when inbound workflows are attached to numbers on this account. If omitted, an application is auto-created on save and its id is stored on the configuration."},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Vobiz phone numbers (E.164 without + prefix)"}},"type":"object","required":["auth_id","auth_token"],"title":"VobizConfigurationRequest","description":"Request schema for Vobiz configuration."},"VobizConfigurationResponse":{"properties":{"provider":{"type":"string","const":"vobiz","title":"Provider","default":"vobiz"},"auth_id":{"type":"string","title":"Auth Id"},"auth_token":{"type":"string","title":"Auth Token"},"application_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Id"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["auth_id","auth_token","from_numbers"],"title":"VobizConfigurationResponse","description":"Response schema for Vobiz configuration with masked sensitive fields."},"VoiceInfo":{"properties":{"voice_id":{"type":"string","title":"Voice Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"accent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accent"},"gender":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gender"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"preview_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Preview Url"}},"type":"object","required":["voice_id","name"],"title":"VoiceInfo"},"VoicesResponse":{"properties":{"provider":{"type":"string","title":"Provider"},"voices":{"items":{"$ref":"#/components/schemas/VoiceInfo"},"type":"array","title":"Voices"}},"type":"object","required":["provider","voices"],"title":"VoicesResponse"},"VonageConfigurationRequest":{"properties":{"provider":{"type":"string","const":"vonage","title":"Provider","default":"vonage"},"api_key":{"type":"string","title":"Api Key","description":"Vonage API Key"},"api_secret":{"type":"string","title":"Api Secret","description":"Vonage API Secret"},"application_id":{"type":"string","title":"Application Id","description":"Vonage Application ID"},"private_key":{"type":"string","title":"Private Key","description":"Private key for JWT generation"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers","description":"List of Vonage phone numbers (without + prefix)"}},"type":"object","required":["api_key","api_secret","application_id","private_key"],"title":"VonageConfigurationRequest","description":"Request schema for Vonage configuration."},"VonageConfigurationResponse":{"properties":{"provider":{"type":"string","const":"vonage","title":"Provider","default":"vonage"},"application_id":{"type":"string","title":"Application Id"},"api_key":{"type":"string","title":"Api Key"},"api_secret":{"type":"string","title":"Api Secret"},"private_key":{"type":"string","title":"Private Key"},"from_numbers":{"items":{"type":"string"},"type":"array","title":"From Numbers"}},"type":"object","required":["application_id","api_key","api_secret","private_key","from_numbers"],"title":"VonageConfigurationResponse","description":"Response schema for Vonage configuration with masked sensitive fields."},"WebhookCredentialType":{"type":"string","enum":["none","api_key","bearer_token","basic_auth","custom_header"],"title":"WebhookCredentialType","description":"Webhook credential authentication types"},"WorkflowCountResponse":{"properties":{"total":{"type":"integer","title":"Total"},"active":{"type":"integer","title":"Active"},"archived":{"type":"integer","title":"Archived"}},"type":"object","required":["total","active","archived"],"title":"WorkflowCountResponse","description":"Response for workflow count endpoint."},"WorkflowError":{"properties":{"kind":{"$ref":"#/components/schemas/ItemKind"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field"},"message":{"type":"string","title":"Message"}},"type":"object","required":["kind","id","field","message"],"title":"WorkflowError"},"WorkflowListResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"status":{"type":"string","title":"Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"total_runs":{"type":"integer","title":"Total Runs"}},"type":"object","required":["id","name","status","created_at","total_runs"],"title":"WorkflowListResponse","description":"Lightweight response for workflow listings (excludes large fields)."},"WorkflowOption":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"WorkflowOption"},"WorkflowResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"status":{"type":"string","title":"Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"workflow_definition":{"additionalProperties":true,"type":"object","title":"Workflow Definition"},"current_definition_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Current Definition Id"},"template_context_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Template Context Variables"},"call_disposition_codes":{"anyOf":[{"$ref":"#/components/schemas/CallDispositionCodes"},{"type":"null"}]},"total_runs":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Runs"},"workflow_configurations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Workflow Configurations"},"version_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version Number"},"version_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version Status"},"workflow_uuid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Uuid"}},"type":"object","required":["id","name","status","created_at","workflow_definition","current_definition_id"],"title":"WorkflowResponse"},"WorkflowRunDetail":{"properties":{"phone_number":{"type":"string","title":"Phone Number"},"disposition":{"type":"string","title":"Disposition"},"duration_seconds":{"type":"number","title":"Duration Seconds"},"workflow_id":{"type":"integer","title":"Workflow Id"},"run_id":{"type":"integer","title":"Run Id"},"workflow_name":{"type":"string","title":"Workflow Name"},"created_at":{"type":"string","title":"Created At"}},"type":"object","required":["phone_number","disposition","duration_seconds","workflow_id","run_id","workflow_name","created_at"],"title":"WorkflowRunDetail"},"WorkflowRunResponseSchema":{"properties":{"id":{"type":"integer","title":"Id"},"workflow_id":{"type":"integer","title":"Workflow Id"},"name":{"type":"string","title":"Name"},"mode":{"type":"string","title":"Mode"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"is_completed":{"type":"boolean","title":"Is Completed"},"transcript_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcript Url"},"recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Url"},"cost_info":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Cost Info"},"definition_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Definition Id"},"initial_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Initial Context"},"gathered_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Gathered Context"},"call_type":{"$ref":"#/components/schemas/CallType"},"logs":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Logs"},"annotations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Annotations"}},"type":"object","required":["id","workflow_id","name","mode","created_at","is_completed","transcript_url","recording_url","cost_info","definition_id","call_type"],"title":"WorkflowRunResponseSchema"},"WorkflowRunUsageResponse":{"properties":{"id":{"type":"integer","title":"Id"},"workflow_id":{"type":"integer","title":"Workflow Id"},"workflow_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Name"},"name":{"type":"string","title":"Name"},"created_at":{"type":"string","title":"Created At"},"dograh_token_usage":{"type":"number","title":"Dograh Token Usage"},"call_duration_seconds":{"type":"integer","title":"Call Duration Seconds"},"recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Url"},"transcript_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcript Url"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Deprecated. Use caller_number and called_number instead.","deprecated":true},"caller_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Caller Number"},"called_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Called Number"},"call_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Type"},"disposition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disposition"},"initial_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Initial Context"},"gathered_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Gathered Context"},"charge_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Charge Usd"}},"type":"object","required":["id","workflow_id","workflow_name","name","created_at","dograh_token_usage","call_duration_seconds"],"title":"WorkflowRunUsageResponse"},"WorkflowRunsResponse":{"properties":{"runs":{"items":{"$ref":"#/components/schemas/WorkflowRunResponseSchema"},"type":"array","title":"Runs"},"total_count":{"type":"integer","title":"Total Count"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"},"total_pages":{"type":"integer","title":"Total Pages"},"applied_filters":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Applied Filters"}},"type":"object","required":["runs","total_count","page","limit","total_pages"],"title":"WorkflowRunsResponse"},"WorkflowSummaryResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"WorkflowSummaryResponse"},"WorkflowTemplateResponse":{"properties":{"id":{"type":"integer","title":"Id"},"template_name":{"type":"string","title":"Template Name"},"template_description":{"type":"string","title":"Template Description"},"template_json":{"additionalProperties":true,"type":"object","title":"Template Json"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","template_name","template_description","template_json","created_at"],"title":"WorkflowTemplateResponse"},"WorkflowVersionResponse":{"properties":{"id":{"type":"integer","title":"Id"},"version_number":{"type":"integer","title":"Version Number"},"status":{"type":"string","title":"Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"published_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Published At"},"workflow_json":{"additionalProperties":true,"type":"object","title":"Workflow Json"},"workflow_configurations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Workflow Configurations"},"template_context_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Template Context Variables"}},"type":"object","required":["id","version_number","status","created_at","workflow_json"],"title":"WorkflowVersionResponse"}}}} \ No newline at end of file diff --git a/docs/docs.json b/docs/docs.json index 09b55f5..13fb7f9 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -71,7 +71,8 @@ { "group": "Custom Tools", "pages": [ - "voice-agent/tools/http-api" + "voice-agent/tools/http-api", + "voice-agent/tools/mcp-tool" ] } ] @@ -308,4 +309,4 @@ "linkedin": "https://linkedin.com/company/dograh" } } -} \ No newline at end of file +} diff --git a/docs/voice-agent/tools/http-api.mdx b/docs/voice-agent/tools/http-api.mdx index 255c778..4b38633 100644 --- a/docs/voice-agent/tools/http-api.mdx +++ b/docs/voice-agent/tools/http-api.mdx @@ -14,7 +14,7 @@ HTTP API tools allow you to attach extrernal REST API calls directly to workflow title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" - referrerPolicy="strict-origin-when-cross-origin" + referrerPolicy="strict-origin-when-cross-origin" allowFullScreen > diff --git a/docs/voice-agent/tools/introduction.mdx b/docs/voice-agent/tools/introduction.mdx index 1e10df5..2c6d035 100644 --- a/docs/voice-agent/tools/introduction.mdx +++ b/docs/voice-agent/tools/introduction.mdx @@ -3,7 +3,7 @@ title: "Tools" description: "Extend your voice agent's capabilities by giving it tools to perform actions during live conversations." --- -Tools let your AI agent take actions during a conversation — transfer calls, end calls, or call external APIs — based on the context of the conversation and your prompt instructions. +Tools let your AI agent take actions during a conversation — transfer calls, end calls, call external APIs, or invoke remote MCP servers — based on the context of the conversation and your prompt instructions. When a tool is attached to a workflow node, the LLM decides **when** to invoke it and **what parameters** to pass, based on the user's spoken intent and your node-level instructions. @@ -23,6 +23,7 @@ Pre-configured tools that handle common telephony operations out of the box: Tools you define to integrate with any external system: - [**HTTP API**](/voice-agent/tools/http-api) — Call any REST API endpoint during a conversation (e.g., CRM updates, data lookups, triggering automations) +- [**MCP Tool**](/voice-agent/tools/mcp-tool) — Connect an external MCP server and expose its remote tools to the LLM during a conversation ## How Tools Work diff --git a/docs/voice-agent/tools/mcp-tool.mdx b/docs/voice-agent/tools/mcp-tool.mdx new file mode 100644 index 0000000..3b9013e --- /dev/null +++ b/docs/voice-agent/tools/mcp-tool.mdx @@ -0,0 +1,90 @@ +--- +title: "MCP Tool" +description: "Connect an external MCP server to your voice agent so the LLM can call remote tools during a live conversation." +--- + + +This page is about using an external MCP server as a **tool inside a voice agent**. If you want Claude, Cursor, or another coding agent to control Dograh itself over MCP, see [Dograh MCP Server](/integrations/mcp). + + +MCP tools let a Dograh voice agent call tools exposed by a remote [Model Context Protocol](https://modelcontextprotocol.io/) server during a live conversation. Dograh discovers the remote tool catalog, turns those tools into LLM-callable functions, and forwards invocations to the MCP server over authenticated Streamable HTTP. + +## What to configure + +An MCP tool in Dograh has four important pieces: + +- **Name**: the server label shown in Dograh +- **Description**: tells the LLM when this MCP server is relevant +- **URL**: the remote MCP server endpoint (`http://` or `https://`) +- **Credential**: the auth Dograh should send when connecting to that server + +You can also set a **tool filter** to allow only specific remote MCP tools to be exposed. + +## Authentication + +Most hosted MCP servers expect: + +```http +Authorization: Bearer +``` + +So before creating the MCP tool, create a credential in Dograh with: + +- **Credential Type**: `Bearer Token` +- **Token**: the access token issued by your MCP server + +Then select that credential on the MCP tool. + + +If the remote MCP server documentation says to use Bearer auth, choose **Bearer Token** in the credential dialog. Dograh will translate that into the exact `Authorization: Bearer ` header on the MCP connection. + + +Dograh also supports other credential types, but **Bearer Token** is the default thing to try for third-party MCP servers unless their docs say otherwise. + +## How it works + +The runtime path is: + +1. When you save or refresh the MCP tool, Dograh opens a short-lived authenticated MCP session and fetches the remote tool catalog. +2. Dograh stores that catalog as the tool's discovered tools so the UI can show you which remote functions exist. +3. When a call starts, Dograh opens one live MCP session per attached MCP server and reuses your selected credential for that session. +4. For each node, Dograh exposes only the MCP tools allowed by the server-level filter and the node-level selection. +5. Dograh namespaces those remote tools into ordinary LLM function definitions so they can safely coexist with HTTP API tools, call transfer, end call, and other tools. +6. During the conversation, the LLM sees only the tool name, description, and argument schema. It does **not** see the secret. +7. When the LLM calls one of those tools, Dograh forwards the invocation to the MCP server over the active authenticated session, receives the result, and feeds that result back into the agent turn. + +In short: **Dograh handles discovery, authentication, session management, tool registration, and result plumbing; the LLM only decides when to call the tool and with which arguments.** + +## Creating an MCP tool + +1. Go to **Tools** and create a new tool. +2. Choose **MCP Server**. +3. Enter a clear name and a description that explains when the LLM should use this server. +4. Paste the MCP server URL. +5. Select the credential. In most cases this should be a **Bearer Token** credential. +6. Save the tool and confirm that Dograh discovered the remote tools. + +If the server exposes many tools, use filtering to keep only the ones your agent actually needs. + +## Attaching it to a node + +After the MCP tool is created: + +1. Open the workflow node where the tool should be available. +2. Add the MCP tool from the node's tool list. +3. Select only the remote MCP functions that should be callable on that node. +4. In the node prompt, tell the LLM exactly when to use those functions. + +The tighter the node-level selection and prompt guidance, the more reliable MCP tool usage becomes. + +## Best practices + +- Use one MCP server per logical integration when possible. +- Keep the tool description explicit about **when** the LLM should use that server. +- Expose only the minimum remote functions needed for each node. +- Prefer a **Bearer Token** credential unless the MCP server specifies another auth scheme. +- Test discovery first, then test a real phone/web call to confirm the LLM invokes the right MCP function with the right arguments. + + +If the remote MCP server is temporarily unavailable, Dograh degrades gracefully and the call can continue without those MCP tools rather than crashing the entire conversation. + diff --git a/pipecat b/pipecat index 13e98d0..6b4474c 160000 --- a/pipecat +++ b/pipecat @@ -1 +1 @@ -Subproject commit 13e98d0d94aa5db3185e36ba411bae0ffb443b7b +Subproject commit 6b4474c1b870eae5e42ef7c5eec1b7f37fcecc61 diff --git a/remote_up.sh b/remote_up.sh index 1b01ef1..29dc784 100755 --- a/remote_up.sh +++ b/remote_up.sh @@ -66,7 +66,14 @@ else fi if [[ "$MODE" == "build" ]]; then - exec "${COMPOSE_CMD[@]}" --profile remote up -d --build --force-recreate "${EXTRA_ARGS[@]}" + CMD=("${COMPOSE_CMD[@]}" --profile remote up -d --build --force-recreate) else - exec "${COMPOSE_CMD[@]}" --profile remote up -d --pull always --force-recreate "${EXTRA_ARGS[@]}" + CMD=("${COMPOSE_CMD[@]}" --profile remote up -d --pull always --force-recreate) fi + +# Bash 3.2 on macOS treats "${empty_array[@]}" as unbound under `set -u`. +if (( ${#EXTRA_ARGS[@]} )); then + CMD+=("${EXTRA_ARGS[@]}") +fi + +exec "${CMD[@]}" diff --git a/scripts/generate_sdk.sh b/scripts/generate_sdk.sh index da69408..56043d8 100755 --- a/scripts/generate_sdk.sh +++ b/scripts/generate_sdk.sh @@ -1,7 +1,8 @@ #!/usr/bin/env bash # Regenerate every file the SDKs derive from authoritative backend state: # -# 1. Typed node dataclasses / TS interfaces (from node_specs registry) +# 1. Typed node dataclasses / TS interfaces (from the model-backed +# node-spec registry) # 2. Filtered OpenAPI spec (routes tagged via @sdk_expose) # 3. Pydantic request/response models + TS interfaces (datamodel-codegen # / openapi-typescript) @@ -18,8 +19,9 @@ # is a devDependency of sdk/typescript; `npm install` in that dir is # done for you if node_modules is missing. # -# Invoked manually after editing any NodeSpec or after adding/removing an -# `@sdk_expose` decorator. CI runs this and asserts the git diff is empty. +# Invoked manually after editing workflow node models / node-spec metadata +# or after adding/removing an `@sdk_expose` decorator. CI runs this and +# asserts the git diff is empty. set -euo pipefail diff --git a/scripts/setup_local.ps1 b/scripts/setup_local.ps1 index 95b4c42..2958f30 100644 --- a/scripts/setup_local.ps1 +++ b/scripts/setup_local.ps1 @@ -167,6 +167,7 @@ if ([string]::IsNullOrEmpty($env:ENABLE_COTURN)) { $UseCoturn = Test-IsEnabled $EnableCoturn $TurnHost = $env:TURN_HOST $TurnSecret = $env:TURN_SECRET +$ForceTurnRelay = if ([string]::IsNullOrEmpty($env:FORCE_TURN_RELAY)) { 'false' } else { $env:FORCE_TURN_RELAY } if ($UseCoturn) { $defaultTurnHost = Get-DefaultLanIPv4 @@ -208,6 +209,7 @@ Write-Host " Coturn: $EnableCoturn" -ForegroundColor Blue if ($UseCoturn) { Write-Host " TURN Host: $TurnHost" -ForegroundColor Blue Write-Host ' TURN Secret: ********' -ForegroundColor Blue + Write-Host " Force relay: $ForceTurnRelay" -ForegroundColor Blue } Write-Host " Telemetry: $EnableTelemetry" -ForegroundColor Blue Write-Host " Registry: $Registry" -ForegroundColor Blue @@ -251,6 +253,9 @@ $envLines = @( '' '# Telemetry (set to false to disable)' "ENABLE_TELEMETRY=$EnableTelemetry" + '' + '# Relay-only ICE candidates for explicit TURN diagnostics' + "FORCE_TURN_RELAY=$ForceTurnRelay" ) if ($UseCoturn) { diff --git a/scripts/setup_local.sh b/scripts/setup_local.sh index 590b774..674185e 100755 --- a/scripts/setup_local.sh +++ b/scripts/setup_local.sh @@ -50,8 +50,8 @@ if [[ "${ENABLE_COTURN:-false}" == "true" ]]; then # Pick a TURN_HOST that's reachable from BOTH the browser (running on the # host) and the API container (running in docker). 127.0.0.1 is tempting # but doesn't work for the api container — its own loopback isn't where - # coturn lives, so aiortc can't allocate a relay and FORCE_TURN_RELAY - # ends up with an empty answer SDP. The host's LAN IP works for both. + # coturn lives, so aiortc can't allocate a relay. The host's LAN IP works + # for both. detect_lan_ip() { local ip="" if command -v ipconfig >/dev/null 2>&1; then @@ -102,16 +102,7 @@ if [[ "${ENABLE_COTURN:-false}" == "true" ]]; then fi fi -if [[ "${ENABLE_COTURN:-false}" != "true" ]]; then - FORCE_TURN_RELAY=false -elif [[ -z "${FORCE_TURN_RELAY:-}" ]]; then - if dograh_is_local_ipv4 "$TURN_HOST"; then - FORCE_TURN_RELAY=true - echo -e "${YELLOW}Detected a local/private TURN host IP; enabling FORCE_TURN_RELAY=true.${NC}" - else - FORCE_TURN_RELAY=false - fi -fi +FORCE_TURN_RELAY="${FORCE_TURN_RELAY:-false}" # Telemetry opt-out (default: true) ENABLE_TELEMETRY="${ENABLE_TELEMETRY:-true}" @@ -170,7 +161,7 @@ OSS_JWT_SECRET=$OSS_JWT_SECRET # Telemetry (set to false to disable) ENABLE_TELEMETRY=$ENABLE_TELEMETRY -# Relay-only ICE candidates (auto-enabled for local/private TURN host IPs) +# Relay-only ICE candidates for explicit TURN diagnostics FORCE_TURN_RELAY=$FORCE_TURN_RELAY ENV_EOF diff --git a/scripts/setup_pipecat.sh b/scripts/setup_pipecat.sh new file mode 100755 index 0000000..04821b0 --- /dev/null +++ b/scripts/setup_pipecat.sh @@ -0,0 +1,25 @@ +#!/bin/bash + +# Setup script for using pipecat as a git submodule + +# Get the project root directory (parent of scripts) +SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" +DOGRAH_DIR="$(dirname "$SCRIPT_DIR")" + +cd "$DOGRAH_DIR" + +echo "Setting up pipecat as a git submodule..." + +# Initialize and update submodules +echo "Initializing git submodules..." +git submodule update --init --recursive + +# Install other requirements first so pipecat submodule wins any version conflicts +echo "Installing dograh API requirements..." +pip install -r api/requirements.txt + +# Install pipecat from submodule last so it overrides any pipecat-ai pulled in by dependencies +echo "Installing pipecat dependencies..." +pip install -e ./pipecat[cartesia,deepgram,openai,elevenlabs,groq,google,azure,sarvam,soundfile,silero,webrtc,speechmatics,openrouter,camb] + +echo "Setup complete! Pipecat is now available as a git submodule." \ No newline at end of file diff --git a/scripts/setup_remote.sh b/scripts/setup_remote.sh index 073689f..d958b69 100755 --- a/scripts/setup_remote.sh +++ b/scripts/setup_remote.sh @@ -49,14 +49,7 @@ if ! dograh_is_ipv4 "$SERVER_IP"; then dograh_fail "Invalid IP address format" fi -if [[ -z "${FORCE_TURN_RELAY:-}" ]]; then - if dograh_is_local_ipv4 "$SERVER_IP"; then - FORCE_TURN_RELAY=true - dograh_warn "Detected a local/private server IP; enabling FORCE_TURN_RELAY=true." - else - FORCE_TURN_RELAY=false - fi -fi +FORCE_TURN_RELAY="${FORCE_TURN_RELAY:-false}" # Get the TURN secret (skip prompt if TURN_SECRET is already set) if [[ -z "${TURN_SECRET:-}" ]]; then @@ -260,7 +253,7 @@ echo -e "${BLUE}[4/$TOTAL] Creating environment file...${NC}" OSS_JWT_SECRET=$(openssl rand -hex 32) cat > .env << ENV_EOF -# Change environment from local to production so that coturn filters local IPs +# Remote deployments run with production signaling and HTTPS defaults ENVIRONMENT=production # Canonical public host/base URL for this install. @@ -277,6 +270,7 @@ MINIO_PUBLIC_ENDPOINT=https://$SERVER_IP # TURN Server Configuration (time-limited credentials via TURN REST API) TURN_HOST=$SERVER_IP TURN_SECRET=$TURN_SECRET +# Relay-only ICE candidates for explicit TURN diagnostics FORCE_TURN_RELAY=$FORCE_TURN_RELAY # JWT secret for OSS authentication diff --git a/scripts/setup_requirements.sh b/scripts/setup_requirements.sh index f38ed38..201b952 100755 --- a/scripts/setup_requirements.sh +++ b/scripts/setup_requirements.sh @@ -51,7 +51,7 @@ fi # Install pipecat in editable mode with all extras echo "Installing pipecat dependencies..." -pip install -e ./pipecat[cartesia,deepgram,openai,elevenlabs,groq,google,azure,sarvam,soundfile,silero,webrtc,speechmatics,openrouter,camb] +pip install -e ./pipecat[cartesia,deepgram,openai,elevenlabs,groq,google,azure,sarvam,soundfile,silero,webrtc,speechmatics,openrouter,camb,mcp] if [ "$DEV_MODE" -eq 1 ]; then echo "Installing pipecat dev dependencies..." diff --git a/sdk/python/src/dograh_sdk/_generated_models.py b/sdk/python/src/dograh_sdk/_generated_models.py index 7f09423..17a5fca 100644 --- a/sdk/python/src/dograh_sdk/_generated_models.py +++ b/sdk/python/src/dograh_sdk/_generated_models.py @@ -1,6 +1,6 @@ # generated by datamodel-codegen: -# filename: dograh-openapi-XXXXXX.json.UrxDUj7bBM -# timestamp: 2026-05-16T12:21:33+00:00 +# filename: dograh-openapi-XXXXXX.json.bGP2QR1Vrx +# timestamp: 2026-05-20T08:41:57+00:00 from __future__ import annotations diff --git a/sdk/python/src/dograh_sdk/codegen.py b/sdk/python/src/dograh_sdk/codegen.py index 9d5de7d..019b356 100644 --- a/sdk/python/src/dograh_sdk/codegen.py +++ b/sdk/python/src/dograh_sdk/codegen.py @@ -127,8 +127,8 @@ def _format_docstring(text: str, indent: int = 4) -> str: _FILE_HEADER = '''"""GENERATED — do not edit by hand. Regenerate with `python -m dograh_sdk.codegen` against the target -Dograh backend. Source of truth: each node's NodeSpec in the backend's -`api/services/workflow/node_specs/` directory. +Dograh backend. Source of truth: the backend's model-backed node-spec +catalog served from `/api/v1/node-types`. """ from __future__ import annotations diff --git a/sdk/python/src/dograh_sdk/typed/__init__.py b/sdk/python/src/dograh_sdk/typed/__init__.py index b5dcea3..f8811a9 100644 --- a/sdk/python/src/dograh_sdk/typed/__init__.py +++ b/sdk/python/src/dograh_sdk/typed/__init__.py @@ -10,6 +10,7 @@ from dograh_sdk.typed.global_node import GlobalNode from dograh_sdk.typed.qa import Qa from dograh_sdk.typed.start_call import StartCall from dograh_sdk.typed.trigger import Trigger +from dograh_sdk.typed.tuner import Tuner from dograh_sdk.typed.webhook import Webhook from dograh_sdk.typed._base import TypedNode @@ -20,6 +21,7 @@ __all__ = [ "Qa", "StartCall", "Trigger", + "Tuner", "TypedNode", "Webhook", ] diff --git a/sdk/python/src/dograh_sdk/typed/agent_node.py b/sdk/python/src/dograh_sdk/typed/agent_node.py index 3b8c21e..cdceb4b 100644 --- a/sdk/python/src/dograh_sdk/typed/agent_node.py +++ b/sdk/python/src/dograh_sdk/typed/agent_node.py @@ -1,8 +1,8 @@ """GENERATED — do not edit by hand. Regenerate with `python -m dograh_sdk.codegen` against the target -Dograh backend. Source of truth: each node's NodeSpec in the backend's -`api/services/workflow/node_specs/` directory. +Dograh backend. Source of truth: the backend's model-backed node-spec +catalog served from `/api/v1/node-types`. """ from __future__ import annotations @@ -16,8 +16,8 @@ from dograh_sdk.typed._base import TypedNode @dataclass(kw_only=True) class AgentNode_Extraction_variablesRow: """ - Each entry declares one variable to capture from the conversation, with - its name, type, and per-variable hint. + Each entry declares one variable to capture, with its name, data type, + and extraction hint. """ name: str @@ -70,8 +70,7 @@ class AgentNode(TypedNode): extraction_enabled: bool = False """ - When true, runs an LLM extraction pass on transition out of this node to - capture variables from the conversation. + When true, runs an LLM extraction pass for this node. """ extraction_prompt: Optional[str] = None @@ -81,8 +80,8 @@ class AgentNode(TypedNode): extraction_variables: list[AgentNode_Extraction_variablesRow] = field(default_factory=list) """ - Each entry declares one variable to capture from the conversation, with - its name, type, and per-variable hint. + Each entry declares one variable to capture, with its name, data type, + and extraction hint. """ tool_uuids: list[str] = field(default_factory=list) diff --git a/sdk/python/src/dograh_sdk/typed/end_call.py b/sdk/python/src/dograh_sdk/typed/end_call.py index 737205c..3c50772 100644 --- a/sdk/python/src/dograh_sdk/typed/end_call.py +++ b/sdk/python/src/dograh_sdk/typed/end_call.py @@ -1,8 +1,8 @@ """GENERATED — do not edit by hand. Regenerate with `python -m dograh_sdk.codegen` against the target -Dograh backend. Source of truth: each node's NodeSpec in the backend's -`api/services/workflow/node_specs/` directory. +Dograh backend. Source of truth: the backend's model-backed node-spec +catalog served from `/api/v1/node-types`. """ from __future__ import annotations @@ -26,11 +26,11 @@ class EndCall_Extraction_variablesRow: """ type: Literal['string', 'number', 'boolean'] = 'string' """ - The data type of the extracted value. + Data type of the extracted value. """ prompt: Optional[str] = None """ - Per-variable hint describing what to look for in the conversation. + Per-variable hint describing what to look for. """ @dataclass(kw_only=True) diff --git a/sdk/python/src/dograh_sdk/typed/global_node.py b/sdk/python/src/dograh_sdk/typed/global_node.py index 6453230..1cbf1b4 100644 --- a/sdk/python/src/dograh_sdk/typed/global_node.py +++ b/sdk/python/src/dograh_sdk/typed/global_node.py @@ -1,8 +1,8 @@ """GENERATED — do not edit by hand. Regenerate with `python -m dograh_sdk.codegen` against the target -Dograh backend. Source of truth: each node's NodeSpec in the backend's -`api/services/workflow/node_specs/` directory. +Dograh backend. Source of truth: the backend's model-backed node-spec +catalog served from `/api/v1/node-types`. """ from __future__ import annotations diff --git a/sdk/python/src/dograh_sdk/typed/qa.py b/sdk/python/src/dograh_sdk/typed/qa.py index 339e2af..f4d6d04 100644 --- a/sdk/python/src/dograh_sdk/typed/qa.py +++ b/sdk/python/src/dograh_sdk/typed/qa.py @@ -1,8 +1,8 @@ """GENERATED — do not edit by hand. Regenerate with `python -m dograh_sdk.codegen` against the target -Dograh backend. Source of truth: each node's NodeSpec in the backend's -`api/services/workflow/node_specs/` directory. +Dograh backend. Source of truth: the backend's model-backed node-spec +catalog served from `/api/v1/node-types`. """ from __future__ import annotations diff --git a/sdk/python/src/dograh_sdk/typed/start_call.py b/sdk/python/src/dograh_sdk/typed/start_call.py index b9e2562..33faae1 100644 --- a/sdk/python/src/dograh_sdk/typed/start_call.py +++ b/sdk/python/src/dograh_sdk/typed/start_call.py @@ -1,8 +1,8 @@ """GENERATED — do not edit by hand. Regenerate with `python -m dograh_sdk.codegen` against the target -Dograh backend. Source of truth: each node's NodeSpec in the backend's -`api/services/workflow/node_specs/` directory. +Dograh backend. Source of truth: the backend's model-backed node-spec +catalog served from `/api/v1/node-types`. """ from __future__ import annotations @@ -17,7 +17,7 @@ from dograh_sdk.typed._base import TypedNode class StartCall_Extraction_variablesRow: """ Each entry declares one variable to capture, with its name, data type, - and per-variable extraction hint. + and extraction hint. """ name: str @@ -97,8 +97,7 @@ class StartCall(TypedNode): extraction_enabled: bool = False """ - When true, runs an LLM extraction pass on transition out of this node to - capture variables from the opening turn. + When true, runs an LLM extraction pass for this node. """ extraction_prompt: Optional[str] = None @@ -109,7 +108,7 @@ class StartCall(TypedNode): extraction_variables: list[StartCall_Extraction_variablesRow] = field(default_factory=list) """ Each entry declares one variable to capture, with its name, data type, - and per-variable extraction hint. + and extraction hint. """ tool_uuids: list[str] = field(default_factory=list) diff --git a/sdk/python/src/dograh_sdk/typed/trigger.py b/sdk/python/src/dograh_sdk/typed/trigger.py index 3a6be4b..62b9ee7 100644 --- a/sdk/python/src/dograh_sdk/typed/trigger.py +++ b/sdk/python/src/dograh_sdk/typed/trigger.py @@ -1,8 +1,8 @@ """GENERATED — do not edit by hand. Regenerate with `python -m dograh_sdk.codegen` against the target -Dograh backend. Source of truth: each node's NodeSpec in the backend's -`api/services/workflow/node_specs/` directory. +Dograh backend. Source of truth: the backend's model-backed node-spec +catalog served from `/api/v1/node-types`. """ from __future__ import annotations diff --git a/sdk/python/src/dograh_sdk/typed/tuner.py b/sdk/python/src/dograh_sdk/typed/tuner.py new file mode 100644 index 0000000..331fa06 --- /dev/null +++ b/sdk/python/src/dograh_sdk/typed/tuner.py @@ -0,0 +1,50 @@ +"""GENERATED — do not edit by hand. + +Regenerate with `python -m dograh_sdk.codegen` against the target +Dograh backend. Source of truth: the backend's model-backed node-spec +catalog served from `/api/v1/node-types`. +""" + +from __future__ import annotations + +from dataclasses import dataclass, field +from typing import Any, ClassVar, Literal, Optional + +from dograh_sdk.typed._base import TypedNode + + +@dataclass(kw_only=True) +class Tuner(TypedNode): + """ + Export the completed call to Tuner for Agent Observability LLM hint: + Tuner is a post-call observability export. It does not participate in + the conversation graph and should not be connected to other nodes. + """ + + type: ClassVar[str] = 'tuner' + + tuner_agent_id: str + """ + The agent identifier registered in your Tuner workspace. + """ + + tuner_workspace_id: float + """ + Your numeric Tuner workspace ID. + """ + + tuner_api_key: str + """ + Bearer token used when posting completed calls to Tuner. + """ + + name: str = 'Tuner' + """ + Short identifier for this Tuner export configuration. + """ + + tuner_enabled: bool = True + """ + When false, Dograh skips exporting this call to Tuner. + """ + diff --git a/sdk/python/src/dograh_sdk/typed/webhook.py b/sdk/python/src/dograh_sdk/typed/webhook.py index 993a74e..305c0e4 100644 --- a/sdk/python/src/dograh_sdk/typed/webhook.py +++ b/sdk/python/src/dograh_sdk/typed/webhook.py @@ -1,8 +1,8 @@ """GENERATED — do not edit by hand. Regenerate with `python -m dograh_sdk.codegen` against the target -Dograh backend. Source of truth: each node's NodeSpec in the backend's -`api/services/workflow/node_specs/` directory. +Dograh backend. Source of truth: the backend's model-backed node-spec +catalog served from `/api/v1/node-types`. """ from __future__ import annotations diff --git a/sdk/typescript/scripts/codegen.mts b/sdk/typescript/scripts/codegen.mts index 954b1c0..cbde7e3 100644 --- a/sdk/typescript/scripts/codegen.mts +++ b/sdk/typescript/scripts/codegen.mts @@ -127,8 +127,8 @@ function renderSpecFile(spec: NodeSpec): string { const header = `// GENERATED — do not edit by hand. // // Regenerate with \`npm run codegen\` against the target Dograh backend. -// Source of truth: each node's NodeSpec in the backend's -// \`api/services/workflow/node_specs/\` directory. +// Source of truth: the backend's model-backed node-spec catalog served +// from \`/api/v1/node-types\`. `; const nested: string[] = []; diff --git a/sdk/typescript/src/typed/agent-node.ts b/sdk/typescript/src/typed/agent-node.ts index 2fd05e8..ec969e9 100644 --- a/sdk/typescript/src/typed/agent-node.ts +++ b/sdk/typescript/src/typed/agent-node.ts @@ -1,11 +1,11 @@ // GENERATED — do not edit by hand. // // Regenerate with `npm run codegen` against the target Dograh backend. -// Source of truth: each node's NodeSpec in the backend's -// `api/services/workflow/node_specs/` directory. +// Source of truth: the backend's model-backed node-spec catalog served +// from `/api/v1/node-types`. /** - * Each entry declares one variable to capture from the conversation, with its name, type, and per-variable hint. + * Each entry declares one variable to capture, with its name, data type, and extraction hint. */ export interface AgentNodeExtraction_variablesRow { /** @@ -46,7 +46,7 @@ export interface AgentNode { */ add_global_prompt?: boolean; /** - * When true, runs an LLM extraction pass on transition out of this node to capture variables from the conversation. + * When true, runs an LLM extraction pass for this node. */ extraction_enabled?: boolean; /** @@ -54,7 +54,7 @@ export interface AgentNode { */ extraction_prompt?: string; /** - * Each entry declares one variable to capture from the conversation, with its name, type, and per-variable hint. + * Each entry declares one variable to capture, with its name, data type, and extraction hint. */ extraction_variables?: Array; /** diff --git a/sdk/typescript/src/typed/end-call.ts b/sdk/typescript/src/typed/end-call.ts index 7d0aed6..3142792 100644 --- a/sdk/typescript/src/typed/end-call.ts +++ b/sdk/typescript/src/typed/end-call.ts @@ -1,8 +1,8 @@ // GENERATED — do not edit by hand. // // Regenerate with `npm run codegen` against the target Dograh backend. -// Source of truth: each node's NodeSpec in the backend's -// `api/services/workflow/node_specs/` directory. +// Source of truth: the backend's model-backed node-spec catalog served +// from `/api/v1/node-types`. /** * Each entry declares one variable to capture from the conversation, with its name, data type, and a per-variable extraction hint. @@ -13,11 +13,11 @@ export interface EndCallExtraction_variablesRow { */ name: string; /** - * The data type of the extracted value. + * Data type of the extracted value. */ type: "string" | "number" | "boolean"; /** - * Per-variable hint describing what to look for in the conversation. + * Per-variable hint describing what to look for. */ prompt?: string; } diff --git a/sdk/typescript/src/typed/global-node.ts b/sdk/typescript/src/typed/global-node.ts index 98140fd..812cae6 100644 --- a/sdk/typescript/src/typed/global-node.ts +++ b/sdk/typescript/src/typed/global-node.ts @@ -1,8 +1,8 @@ // GENERATED — do not edit by hand. // // Regenerate with `npm run codegen` against the target Dograh backend. -// Source of truth: each node's NodeSpec in the backend's -// `api/services/workflow/node_specs/` directory. +// Source of truth: the backend's model-backed node-spec catalog served +// from `/api/v1/node-types`. /** diff --git a/sdk/typescript/src/typed/index.ts b/sdk/typescript/src/typed/index.ts index 72450a8..d715891 100644 --- a/sdk/typescript/src/typed/index.ts +++ b/sdk/typescript/src/typed/index.ts @@ -9,6 +9,7 @@ export { type GlobalNode, globalNode } from "./global-node.js"; export { type Qa, qa } from "./qa.js"; export { type StartCall, startCall } from "./start-call.js"; export { type Trigger, trigger } from "./trigger.js"; +export { type Tuner, tuner } from "./tuner.js"; export { type Webhook, webhook } from "./webhook.js"; import type { @@ -18,8 +19,9 @@ import type { Qa, StartCall, Trigger, + Tuner, Webhook, } from "./index.js"; /** Discriminated union of every generated typed node. */ -export type TypedNode = AgentNode | EndCall | GlobalNode | Qa | StartCall | Trigger | Webhook; +export type TypedNode = AgentNode | EndCall | GlobalNode | Qa | StartCall | Trigger | Tuner | Webhook; diff --git a/sdk/typescript/src/typed/qa.ts b/sdk/typescript/src/typed/qa.ts index 7f93152..e7f5233 100644 --- a/sdk/typescript/src/typed/qa.ts +++ b/sdk/typescript/src/typed/qa.ts @@ -1,8 +1,8 @@ // GENERATED — do not edit by hand. // // Regenerate with `npm run codegen` against the target Dograh backend. -// Source of truth: each node's NodeSpec in the backend's -// `api/services/workflow/node_specs/` directory. +// Source of truth: the backend's model-backed node-spec catalog served +// from `/api/v1/node-types`. /** diff --git a/sdk/typescript/src/typed/start-call.ts b/sdk/typescript/src/typed/start-call.ts index f243850..5ed9bb2 100644 --- a/sdk/typescript/src/typed/start-call.ts +++ b/sdk/typescript/src/typed/start-call.ts @@ -1,11 +1,11 @@ // GENERATED — do not edit by hand. // // Regenerate with `npm run codegen` against the target Dograh backend. -// Source of truth: each node's NodeSpec in the backend's -// `api/services/workflow/node_specs/` directory. +// Source of truth: the backend's model-backed node-spec catalog served +// from `/api/v1/node-types`. /** - * Each entry declares one variable to capture, with its name, data type, and per-variable extraction hint. + * Each entry declares one variable to capture, with its name, data type, and extraction hint. */ export interface StartCallExtraction_variablesRow { /** @@ -68,7 +68,7 @@ export interface StartCall { */ delayed_start_duration?: number; /** - * When true, runs an LLM extraction pass on transition out of this node to capture variables from the opening turn. + * When true, runs an LLM extraction pass for this node. */ extraction_enabled?: boolean; /** @@ -76,7 +76,7 @@ export interface StartCall { */ extraction_prompt?: string; /** - * Each entry declares one variable to capture, with its name, data type, and per-variable extraction hint. + * Each entry declares one variable to capture, with its name, data type, and extraction hint. */ extraction_variables?: Array; /** diff --git a/sdk/typescript/src/typed/trigger.ts b/sdk/typescript/src/typed/trigger.ts index 2dbe27d..02a6257 100644 --- a/sdk/typescript/src/typed/trigger.ts +++ b/sdk/typescript/src/typed/trigger.ts @@ -1,8 +1,8 @@ // GENERATED — do not edit by hand. // // Regenerate with `npm run codegen` against the target Dograh backend. -// Source of truth: each node's NodeSpec in the backend's -// `api/services/workflow/node_specs/` directory. +// Source of truth: the backend's model-backed node-spec catalog served +// from `/api/v1/node-types`. /** diff --git a/sdk/typescript/src/typed/tuner.ts b/sdk/typescript/src/typed/tuner.ts new file mode 100644 index 0000000..fc9170c --- /dev/null +++ b/sdk/typescript/src/typed/tuner.ts @@ -0,0 +1,40 @@ +// GENERATED — do not edit by hand. +// +// Regenerate with `npm run codegen` against the target Dograh backend. +// Source of truth: the backend's model-backed node-spec catalog served +// from `/api/v1/node-types`. + + +/** + * Export the completed call to Tuner for Agent Observability + * + * LLM hint: Tuner is a post-call observability export. It does not participate in the conversation graph and should not be connected to other nodes. + */ +export interface Tuner { + type: "tuner"; + /** + * Short identifier for this Tuner export configuration. + */ + name?: string; + /** + * When false, Dograh skips exporting this call to Tuner. + */ + tuner_enabled?: boolean; + /** + * The agent identifier registered in your Tuner workspace. + */ + tuner_agent_id: string; + /** + * Your numeric Tuner workspace ID. + */ + tuner_workspace_id: number; + /** + * Bearer token used when posting completed calls to Tuner. + */ + tuner_api_key: string; +} + +/** Factory — sets `type` for you so you don't repeat the discriminator. */ +export function tuner(input: Omit): Tuner { + return { type: "tuner", ...input }; +} diff --git a/sdk/typescript/src/typed/webhook.ts b/sdk/typescript/src/typed/webhook.ts index f3d39f2..87cfea0 100644 --- a/sdk/typescript/src/typed/webhook.ts +++ b/sdk/typescript/src/typed/webhook.ts @@ -1,8 +1,8 @@ // GENERATED — do not edit by hand. // // Regenerate with `npm run codegen` against the target Dograh backend. -// Source of truth: each node's NodeSpec in the backend's -// `api/services/workflow/node_specs/` directory. +// Source of truth: the backend's model-backed node-spec catalog served +// from `/api/v1/node-types`. /** * Additional HTTP headers to include with the request. diff --git a/ui/package-lock.json b/ui/package-lock.json index db13e2f..01c5fad 100644 --- a/ui/package-lock.json +++ b/ui/package-lock.json @@ -1,15 +1,14 @@ { "name": "ui", - "version": "1.28.0", + "version": "1.30.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "ui", - "version": "1.28.0", + "version": "1.30.1", "dependencies": { "@dagrejs/dagre": "^1.1.4", - "@nangohq/frontend": "^0.69.47", "@radix-ui/react-alert-dialog": "^1.1.15", "@radix-ui/react-checkbox": "^1.3.2", "@radix-ui/react-collapsible": "^1.1.12", @@ -2485,26 +2484,6 @@ "dev": true, "license": "MIT" }, - "node_modules/@nangohq/frontend": { - "version": "0.69.47", - "resolved": "https://registry.npmjs.org/@nangohq/frontend/-/frontend-0.69.47.tgz", - "integrity": "sha512-PyRSh6DTXkqya40v4EwJ8myiGV99H4izlnkD9Ldz/Aenb/Q7r6nrP41U7dHn8phdHCOEsLLF9y9CjKXBnA5Smg==", - "license": "SEE LICENSE IN LICENSE FILE IN GIT REPOSITORY", - "dependencies": { - "@nangohq/types": "0.69.47" - } - }, - "node_modules/@nangohq/types": { - "version": "0.69.47", - "resolved": "https://registry.npmjs.org/@nangohq/types/-/types-0.69.47.tgz", - "integrity": "sha512-mgw3hQbtSeYbxj/A6ncjg31oJiZkR7FoNHwbv7LpULBDg6C2J9gZ0UbFtZfS8XZxOXUoLWvRYKN0rHcVrD+MmA==", - "license": "SEE LICENSE IN LICENSE FILE IN GIT REPOSITORY", - "dependencies": { - "axios": "1.13.5", - "json-schema": "0.4.0", - "type-fest": "4.41.0" - } - }, "node_modules/@napi-rs/wasm-runtime": { "version": "0.2.8", "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-0.2.8.tgz", diff --git a/ui/package.json b/ui/package.json index ed670c2..a2bda20 100644 --- a/ui/package.json +++ b/ui/package.json @@ -13,7 +13,6 @@ }, "dependencies": { "@dagrejs/dagre": "^1.1.4", - "@nangohq/frontend": "^0.69.47", "@radix-ui/react-alert-dialog": "^1.1.15", "@radix-ui/react-checkbox": "^1.3.2", "@radix-ui/react-collapsible": "^1.1.12", diff --git a/ui/src/app/campaigns/GoogleSheetSelector.tsx b/ui/src/app/campaigns/GoogleSheetSelector.tsx deleted file mode 100644 index de3cfc6..0000000 --- a/ui/src/app/campaigns/GoogleSheetSelector.tsx +++ /dev/null @@ -1,237 +0,0 @@ -'use client'; - -import { useEffect, useState } from 'react'; -import { toast } from 'sonner'; - -import { getIntegrationAccessTokenApiV1IntegrationIntegrationIdAccessTokenGet, getIntegrationsApiV1IntegrationGet } from '@/client/sdk.gen'; -import type { IntegrationResponse } from '@/client/types.gen'; -import { Button } from '@/components/ui/button'; -import { Label } from '@/components/ui/label'; -import logger from '@/lib/logger'; - -interface GoogleSheetSelectorProps { - accessToken: string; - onSheetSelected: (sheetUrl: string, sheetName: string) => void; - selectedSheetUrl?: string; -} - -interface PickerBuilder { - addView: (viewId: string) => PickerBuilder; - setOAuthToken: (token: string) => PickerBuilder; - setDeveloperKey: (key: string) => PickerBuilder; - setCallback: (callback: (data: { action: string; docs?: Array<{ id: string; name: string; url: string }> }) => void) => PickerBuilder; - setTitle: (title: string) => PickerBuilder; - build: () => { setVisible: (visible: boolean) => void }; -} - -declare global { - interface Window { - gapi: { - load: (library: string, callback: () => void) => void; - }; - google: { - picker: { - PickerBuilder: new () => PickerBuilder; - ViewId: { - SPREADSHEETS: string; - }; - Action: { - PICKED: string; - }; - }; - }; - } -} - -// Google API configuration -const GOOGLE_API_KEY = process.env.NEXT_PUBLIC_GOOGLE_API_KEY || ''; - -export default function GoogleSheetSelector({ accessToken, onSheetSelected, selectedSheetUrl }: GoogleSheetSelectorProps) { - const [loading, setLoading] = useState(false); - const [pickerApiLoaded, setPickerApiLoaded] = useState(false); - const [googleIntegration, setGoogleIntegration] = useState(null); - const [selectedSheetName, setSelectedSheetName] = useState(''); - const [checkingIntegration, setCheckingIntegration] = useState(true); - - // Load Google Picker API - useEffect(() => { - const script = document.createElement('script'); - script.src = 'https://apis.google.com/js/api.js'; - script.onload = () => { - window.gapi.load('picker', () => { - setPickerApiLoaded(true); - logger.info('Google Picker API loaded'); - }); - }; - document.body.appendChild(script); - - return () => { - if (document.body.contains(script)) { - document.body.removeChild(script); - } - }; - }, []); - - // Check for Google Sheet integration - useEffect(() => { - const checkGoogleIntegration = async () => { - if (!accessToken) { - return; - } - - try { - const response = await getIntegrationsApiV1IntegrationGet({ - headers: { - 'Authorization': `Bearer ${accessToken}`, - } - }); - - if (response.data) { - const integrations = Array.isArray(response.data) ? response.data : [response.data]; - const googleSheet = integrations.find((i: IntegrationResponse) => i.provider === 'google-sheet'); - setGoogleIntegration(googleSheet || null); - } - } catch (error) { - logger.error('Failed to check Google integration:', error); - } finally { - setCheckingIntegration(false); - } - }; - - checkGoogleIntegration(); - }, [accessToken]); - - const fetchGoogleAccessToken = async () => { - if (!googleIntegration) return null; - - try { - const response = await getIntegrationAccessTokenApiV1IntegrationIntegrationIdAccessTokenGet({ - path: { - integration_id: googleIntegration.id, - }, - headers: { - Authorization: `Bearer ${accessToken}`, - } - }); - - if (response.data?.access_token) { - return response.data.access_token; - } - return null; - } catch (error) { - logger.error('Failed to fetch Google access token:', error); - return null; - } - }; - - const openGooglePicker = async () => { - if (!pickerApiLoaded) { - toast.error('Google Picker is still loading. Please try again.'); - return; - } - - if (!GOOGLE_API_KEY) { - toast.error('Google API Key is not configured.'); - return; - } - - if (!googleIntegration) { - toast.error('Please connect Google Sheets in the Integrations page first.'); - return; - } - - setLoading(true); - - try { - const token = await fetchGoogleAccessToken(); - if (!token) { - toast.error('Failed to get Google access token. Please re-authorize in Integrations.'); - setLoading(false); - return; - } - - const picker = new window.google.picker.PickerBuilder() - .addView(window.google.picker.ViewId.SPREADSHEETS) - .setOAuthToken(token) - .setDeveloperKey(GOOGLE_API_KEY) - .setCallback((data: { action: string; docs?: Array<{ id: string; name: string; url: string }> }) => { - if (data.action === window.google.picker.Action.PICKED && data.docs && data.docs.length > 0) { - const doc = data.docs[0]; - setSelectedSheetName(doc.name); - onSheetSelected(doc.url, doc.name); - toast.success(`Selected: ${doc.name}`); - } - setLoading(false); - }) - .setTitle('Select a Google Sheet for your campaign') - .build(); - - picker.setVisible(true); - } catch (error) { - toast.error('Error opening Google Picker'); - logger.error('Error opening Google Picker:', error); - setLoading(false); - } - }; - - if (checkingIntegration) { - return ( -
- -
Checking Google integration...
-
- ); - } - - if (!googleIntegration) { - return ( -
- -
-

- Google Sheets integration not found -

-

- Please go to the{' '} - - Integrations page - - {' '}and connect your Google account first. -

-
-
- ); - } - - return ( -
- -
- - {selectedSheetUrl && ( - - )} -
-

- Select a Google Sheet from your connected Google account -

-
- ); -} diff --git a/ui/src/app/campaigns/new/page.tsx b/ui/src/app/campaigns/new/page.tsx index 4d77841..aab2adc 100644 --- a/ui/src/app/campaigns/new/page.tsx +++ b/ui/src/app/campaigns/new/page.tsx @@ -30,7 +30,6 @@ import { useAuth } from '@/lib/auth'; import CampaignAdvancedSettings, { getTimezoneValue, type TimeSlot } from '../CampaignAdvancedSettings'; import CsvUploadSelector from '../CsvUploadSelector'; -import GoogleSheetSelector from '../GoogleSheetSelector'; export default function NewCampaignPage() { const { user, getAccessToken, redirectToLogin, loading } = useAuth(); @@ -39,12 +38,11 @@ export default function NewCampaignPage() { // Form state const [campaignName, setCampaignName] = useState(''); const [selectedWorkflowId, setSelectedWorkflowId] = useState(''); - const [sourceType, setSourceType] = useState<'google-sheet' | 'csv'>('csv'); + const [sourceType, setSourceType] = useState<'csv'>('csv'); const [sourceId, setSourceId] = useState(''); const [selectedFileName, setSelectedFileName] = useState(''); const [isSubmitting, setIsSubmitting] = useState(false); const [createError, setCreateError] = useState(null); - const [userAccessToken, setUserAccessToken] = useState(''); // Workflows state const [workflows, setWorkflows] = useState([]); @@ -97,7 +95,6 @@ export default function NewCampaignPage() { if (!user) return; try { const accessToken = await getAccessToken(); - setUserAccessToken(accessToken); const response = await getWorkflowsSummaryApiV1WorkflowSummaryGet({ headers: { 'Authorization': `Bearer ${accessToken}`, @@ -342,12 +339,6 @@ export default function NewCampaignPage() { router.push('/campaigns'); }; - // Handle sheet selection - const handleSheetSelected = (sheetUrl: string) => { - setSourceId(sheetUrl); - setCreateError(null); - }; - // Handle CSV file upload const handleFileUploaded = (fileKey: string, fileName: string) => { setSourceId(fileKey); @@ -481,7 +472,7 @@ export default function NewCampaignPage() { @@ -500,18 +490,10 @@ export default function NewCampaignPage() {

- {sourceType === 'google-sheet' ? ( - - ) : ( - - )} + {/* Advanced Settings */} { - setIsLoading(true); - try { - if (!user) { - throw new Error('User not authenticated'); - } - const accessToken = await getAccessToken(); - - // Fetch session details from our API - const sessionResponse = await createSessionApiV1IntegrationSessionPost({ - headers: { - 'Authorization': `Bearer ${accessToken}`, - }, - }); - - if (!sessionResponse.data?.session_token) { - throw new Error('Failed to get session token'); - } - - // Initialize Nango and open connect UI - const nango = new Nango(); - const connect = nango.openConnectUI({ - onEvent: (event) => { - if (event.type === 'close') { - // Handle modal closed - setIsLoading(false); - logger.info('Nango connect UI closed'); - } else if (event.type === 'connect') { - // Handle auth flow successful - setIsLoading(false); - logger.info('Integration connected successfully'); - // Refresh the page to show new integrations - window.location.reload(); - } - }, - }); - - // Set the session token to initialize the connect UI - connect.setSessionToken(sessionResponse.data.session_token); - - } catch (err) { - logger.error(`Error creating integration: ${err}`); - setIsLoading(false); - // You might want to show a toast notification here - alert('Failed to create integration. Please try again.'); - } - }; - - return ( - - ); -} diff --git a/ui/src/app/integrations/[id]/gmail/page.tsx b/ui/src/app/integrations/[id]/gmail/page.tsx deleted file mode 100644 index 7bb1695..0000000 --- a/ui/src/app/integrations/[id]/gmail/page.tsx +++ /dev/null @@ -1,390 +0,0 @@ -'use client'; - -import { useParams, useRouter } from 'next/navigation'; -import { useCallback, useEffect, useState } from 'react'; - -import { getIntegrationAccessTokenApiV1IntegrationIntegrationIdAccessTokenGet } from '@/client/sdk.gen'; -import { useAuth } from '@/lib/auth'; -import logger from '@/lib/logger'; - -interface Email { - id: string; - threadId: string; - subject: string; - from: string; - snippet: string; - date: string; -} - -interface EmailDetail { - id: string; - threadId: string; - subject: string; - from: string; - to: string; - date: string; - body: string; -} - -interface GmailHeader { - name: string; - value: string; -} - -interface GmailPayloadPart { - mimeType: string; - body: { - data?: string; - }; -} - -export default function GmailSearchPage() { - const params = useParams(); - const router = useRouter(); - const integrationId = parseInt(params.id as string); - const { getAccessToken, redirectToLogin } = useAuth(); - - const [accessToken, setAccessToken] = useState(null); - const [searchQuery, setSearchQuery] = useState(''); - const [emails, setEmails] = useState([]); - const [selectedEmail, setSelectedEmail] = useState(null); - const [replyText, setReplyText] = useState(''); - const [loading, setLoading] = useState(false); - const [error, setError] = useState(null); - const [sendingReply, setSendingReply] = useState(false); - - const fetchAccessToken = useCallback(async () => { - try { - const token = await getAccessToken(); - if (!token) { - redirectToLogin(); - return; - } - - const response = await getIntegrationAccessTokenApiV1IntegrationIntegrationIdAccessTokenGet({ - path: { integration_id: integrationId }, - headers: { Authorization: `Bearer ${token}` }, - }); - - if (response.data?.access_token) { - setAccessToken(response.data.access_token); - } else { - setError('Failed to get access token'); - } - } catch (err) { - logger.error('Error fetching access token:', err); - setError('Failed to fetch access token. Please try again.'); - } - }, [getAccessToken, redirectToLogin, integrationId]); - - useEffect(() => { - fetchAccessToken(); - }, [fetchAccessToken]); - - const searchEmails = async () => { - if (!accessToken || !searchQuery.trim()) return; - - setLoading(true); - setError(null); - setEmails([]); - setSelectedEmail(null); - - try { - const response = await fetch( - `https://gmail.googleapis.com/gmail/v1/users/me/messages?q=${encodeURIComponent(searchQuery)}&maxResults=20`, - { - headers: { - Authorization: `Bearer ${accessToken}`, - }, - } - ); - - if (!response.ok) { - throw new Error(`Gmail API error: ${response.statusText}`); - } - - const data = await response.json(); - - if (!data.messages || data.messages.length === 0) { - setEmails([]); - return; - } - - // Fetch details for each message - const emailPromises = data.messages.map(async (msg: { id: string }) => { - const msgResponse = await fetch( - `https://gmail.googleapis.com/gmail/v1/users/me/messages/${msg.id}?format=metadata&metadataHeaders=Subject&metadataHeaders=From&metadataHeaders=Date`, - { - headers: { - Authorization: `Bearer ${accessToken}`, - }, - } - ); - return msgResponse.json(); - }); - - const emailDetails = await Promise.all(emailPromises); - - const formattedEmails: Email[] = emailDetails.map((email) => { - const headers = email.payload.headers as GmailHeader[]; - const subject = headers.find((h) => h.name === 'Subject')?.value || 'No Subject'; - const from = headers.find((h) => h.name === 'From')?.value || 'Unknown'; - const date = headers.find((h) => h.name === 'Date')?.value || ''; - - return { - id: email.id, - threadId: email.threadId, - subject, - from, - snippet: email.snippet || '', - date, - }; - }); - - setEmails(formattedEmails); - } catch (err) { - logger.error('Error searching emails:', err); - setError('Failed to search emails. Please try again.'); - } finally { - setLoading(false); - } - }; - - const loadEmailDetail = async (emailId: string) => { - if (!accessToken) return; - - setLoading(true); - setError(null); - - try { - const response = await fetch( - `https://gmail.googleapis.com/gmail/v1/users/me/messages/${emailId}?format=full`, - { - headers: { - Authorization: `Bearer ${accessToken}`, - }, - } - ); - - if (!response.ok) { - throw new Error(`Gmail API error: ${response.statusText}`); - } - - const email = await response.json(); - const headers = email.payload.headers as GmailHeader[]; - - const subject = headers.find((h) => h.name === 'Subject')?.value || 'No Subject'; - const from = headers.find((h) => h.name === 'From')?.value || 'Unknown'; - const to = headers.find((h) => h.name === 'To')?.value || 'Unknown'; - const date = headers.find((h) => h.name === 'Date')?.value || ''; - - // Extract email body - let body = ''; - if (email.payload.body.data) { - body = atob(email.payload.body.data.replace(/-/g, '+').replace(/_/g, '/')); - } else if (email.payload.parts) { - const parts = email.payload.parts as GmailPayloadPart[]; - const textPart = parts.find((part) => part.mimeType === 'text/plain'); - if (textPart && textPart.body.data) { - body = atob(textPart.body.data.replace(/-/g, '+').replace(/_/g, '/')); - } - } - - setSelectedEmail({ - id: email.id, - threadId: email.threadId, - subject, - from, - to, - date, - body, - }); - } catch (err) { - logger.error('Error loading email detail:', err); - setError('Failed to load email details. Please try again.'); - } finally { - setLoading(false); - } - }; - - const sendReply = async () => { - if (!accessToken || !selectedEmail || !replyText.trim()) return; - - setSendingReply(true); - setError(null); - - try { - // Create the email message - const to = selectedEmail.from.match(/<(.+)>/)?.[1] || selectedEmail.from; - const subject = selectedEmail.subject.startsWith('Re:') - ? selectedEmail.subject - : `Re: ${selectedEmail.subject}`; - - const messageParts = [ - `To: ${to}`, - `Subject: ${subject}`, - `In-Reply-To: ${selectedEmail.id}`, - `References: ${selectedEmail.id}`, - '', - replyText, - ]; - - const message = messageParts.join('\n'); - const encodedMessage = btoa(message) - .replace(/\+/g, '-') - .replace(/\//g, '_') - .replace(/=+$/, ''); - - const response = await fetch( - `https://gmail.googleapis.com/gmail/v1/users/me/messages/send`, - { - method: 'POST', - headers: { - Authorization: `Bearer ${accessToken}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify({ - raw: encodedMessage, - threadId: selectedEmail.threadId, - }), - } - ); - - if (!response.ok) { - throw new Error(`Gmail API error: ${response.statusText}`); - } - - alert('Reply sent successfully!'); - setReplyText(''); - } catch (err) { - logger.error('Error sending reply:', err); - setError('Failed to send reply. Please try again.'); - } finally { - setSendingReply(false); - } - }; - - return ( -
-
- -

Gmail Search

-
- - {/* Search Section */} -
-
- setSearchQuery(e.target.value)} - onKeyPress={(e) => e.key === 'Enter' && searchEmails()} - placeholder="Search emails (e.g., from:user@example.com, subject:meeting)" - className="flex-1 px-4 py-2 border border-gray-300 rounded-md focus:outline-none focus:ring-2 focus:ring-blue-500" - disabled={!accessToken || loading} - /> - -
-
- - {error && ( -
- {error} -
- )} - -
- {/* Email List */} -
-
-

Search Results

-
-
- {emails.length === 0 && !loading && ( -
- {searchQuery ? 'No emails found' : 'Enter a search query to find emails'} -
- )} - {emails.map((email) => ( -
loadEmailDetail(email.id)} - className={`p-4 cursor-pointer hover:bg-muted/50 ${ - selectedEmail?.id === email.id ? 'bg-accent' : '' - }`} - > -
{email.subject}
-
{email.from}
-
{email.snippet}
-
{email.date}
-
- ))} -
-
- - {/* Email Detail and Reply */} -
-
-

Email Details

-
- {selectedEmail ? ( -
-
-
- Subject: {selectedEmail.subject} -
-
- From: {selectedEmail.from} -
-
- To: {selectedEmail.to} -
-
- Date: {selectedEmail.date} -
-
- -
- 
{selectedEmail.body}
-
- -
-

Reply

-