Platform ReferenceBETA
Platform Reference
High-level product behavior and integration expectations for developers.
Beta Notice: API and MCP behavior can evolve during beta. Rely on contract docs and changelogs for updates.
What You Can Rely On
This reference intentionally focuses on stable usage contracts: endpoint patterns, authentication, run lifecycle behavior, and evidence-first output expectations.
Documentation Scope
This page is integration-oriented. It explains what the platform does and how to consume it reliably.
Primary Integration Surfaces
App
UI-driven workflow for onboarding and first successful analysis.
Upload documents, run processing, and review evidence-backed output through the dashboard.
API
Contract-first endpoints for programmatic integrations.
Use upload, ask, run status, and run results endpoints for deterministic backend flows.
MCP
Tool-based execution for assistant and agent integrations.
Prefer one-call workflow execution, with guarded fallbacks for upload and retrieval paths.
Minimal Contract Flow
# Core API Sequence
1) POST /api/models/v1/upload
2) POST /api/models/v1/ask
3) GET /api/models/v1/runs/{id}
4) GET /api/models/v1/runs/{id}/results
# MCP Default Path
1) Call policy/setup tool once
2) Use ti_run_workflow by default
3) Follow action_required and rerun
Developer Expectations
Evidence-First Output
Treat retrieval quality and citation coverage as primary quality signals for integration success.
Operational Guardrails
Respect transport constraints, auth boundaries, timeout behavior, and actionable error responses.
Stable Contracts
Build against public endpoint and tool contracts, not inferred behavior from UI or internals.
Beta Variability
Expect iterative refinements during beta and monitor changelog updates before promoting workflows.
Next Steps
Continue with setup and integration docs: