Skip to content
UltimateTeam.ai Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Overview
Quickstart
Agents
Overview
CEO — Chief Executive Officer
CRO — Chief Revenue Officer
CFO — Chief Financial Officer
CMO — Chief Marketing Officer
COO — Chief Operating Officer
CTO — Chief Technology Officer
CISO — Chief Information Security Officer
CIO — Chief Intelligence Officer
API
API Reference
Overview
a2a
Get Aggregate Agent Card
List available A2A agents
Get extended Agent Card for a specific role
Operations
Handle Requests
Handle Get Agent Card
Handle Get Authenticated Extended Agent Card
Handle Requests
Handle Get Agent Card
Handle Get Authenticated Extended Agent Card
Handle Requests
Handle Get Agent Card
Handle Get Authenticated Extended Agent Card
Handle Requests
Handle Get Agent Card
Handle Get Authenticated Extended Agent Card
Handle Requests
Handle Get Agent Card
Handle Get Authenticated Extended Agent Card
Handle Requests
Handle Get Agent Card
Handle Get Authenticated Extended Agent Card
Handle Requests
Handle Get Agent Card
Handle Get Authenticated Extended Agent Card
Handle Requests
Handle Get Agent Card
Handle Get Authenticated Extended Agent Card
admin-eval
Get Failures
Get Model Comparison
Get Trend
admin-internal-rollback
Emit Auto Rollback
computer-use
List computer use sessions
Get computer use session detail
Approve a pending computer-use session
Reject a pending computer-use session
i18n
List supported currencies
List supported locales
Update tenant i18n preferences
multimodal
Browser Capture
Chat Upload
social-analytics
Get platform comparison
Get content type analysis
Get optimal posting times
Trigger analytics snapshot
Get unified social metrics
Get weekly social summary
discovery
List available A2A agents
Get extended Agent Card for a specific role
accountability
Get Task Ownership Board
Get Decisions For Delegation
Get Delegation Chain Tree
Get Delegation Links
Get All Agent Metrics
Get Agent Metrics
activity
Get recent activity feed
Search activity history via BigQuery
Verify activity entry signature
admin-activation
Get Active Alert
Get Cohorts
Get Heatmap
Get Kpis
admin-billing
Initialize Tenant Credits
Get Reconciliation Ledger
admin-costs
Get Budget Exhaustion Rate
Get Costs For Tenant
admin-coupons
List Coupons
Create Coupon
Get Coupon
Update Coupon
admin-credit-usage
Get Credit Usage
admin-deploy-status
Get Deploy Status
Get Deploy History
admin-healing
Get Healing Dashboard
admin-kg-intelligence
Get Kg Intelligence Dashboard
admin
Activate Kill Switch
Deactivate Kill Switch
Get Kill Switch Status
safety
Activate Kill Switch
Deactivate Kill Switch
Get Kill Switch Status
admin-prompt-tuning
List Proposals
Get Proposal
Apply Proposal
Approve Proposal
Reject Proposal
List Versions
Rollback Version
admin-security
Get Denial Dashboard
admin-si-dry-run
Get Config Options
Run Dry Run
admin-tenant-lifecycle
Per-tenant lifecycle journey timeline (Chairman-only)
admin-tenants
Set operator-managed tenant flags (is_simulated)
agency
Get Agency Billing
Get Brand Summary
Get Brand Report
List Brand Tenants
Add Tenant To Brand
Remove Tenant From Brand
Transfer Tenant
Get Overview
agents
List agents
Get calibration summary for all agents
Get Brier score feedback for all agents
Get AI-generated name suggestions for agents
Get SLO compliance summary for all agents
Approve a trust expansion proposal
Get trust score history for all agent roles
Get agent detail
Update agent configuration
Send a message to an agent
Stream a chat response from an agent
Trigger manual task execution
Provision agent identity
Revoke agent identity
Pause agent
Resume agent
Get a task's status and result
Get agent vital signs
List agents
Get agent
transparency
Agent calibration data
Get agent certificate
Export agent certificate as X.509 PEM
Full decision provenance
Verify decision signature
ai-capabilities
Initiate collaboration session
Get collaboration session
Capture Correction
List Corrections
Trigger Decay
Get Effectiveness
List shadow evaluations
Get model routing weights
Trigger manual consolidation
Get memory health
Get optimal cadence schedule
Get tenant activity pattern
analytics
Platform summary
Tenant health
Tenant detail
Get DAU counts
Record analytics events
Export metrics as PDF
Export metrics as Excel
Get feature adoption
List KPI dashboards
Create KPI dashboard
Get KPI dashboard
Update KPI dashboard
Delete KPI dashboard
Preview KPI dashboard
Get MAU count
List all available metrics
Agent activity summary
Cost efficiency
Revenue attribution
Agent ROI breakdown
Time saved estimate
List report schedules
Create report schedule
Get report schedule
Update report schedule
Delete report schedule
Trigger report now
anomalies
Get active anomalies for tenant
approvals
List pending approvals
Approve an action
Approve with modifications
Reject an action
attribution
Full attribution chain tree for one decision (tenant-isolated)
Accept a CEO retire/retune proposal from the morning brief (OAV-05)
Last 50 attribution records for the tenant
Windowed 30/60/90-day CFO-eyes ROI rollup with drill-down
Aggregated ROI totals by agent role
audit-log
List Audit Entries
audit
Paginated audit log entries
Export audit trail
Verify audit chain integrity
auth
Confirm TOTP enrollment
Disable TOTP 2FA
Enroll in TOTP 2FA
Verify 2FA code
Start WebAuthn authentication
Start WebAuthn registration
Complete WebAuthn registration
Request password reset
Authenticate user
Log out
Refresh access token
Reset password
List active sessions
Revoke a session
Create account
Process OIDC callback
Initiate OIDC authentication
Process SAML assertion
Initiate SAML authentication
beta
List invite codes
Generate invite codes
Redeem invite code
Deactivate invite code
List cohorts
Compare cohorts
Export cohort CSV
List onboarding progress
Record onboarding step
List stuck users
billing
Get billing overview
Get credit balance, reserved, available, and buffer status
[DEPRECATED] Purchase additional credits via PaymentIntent
List billing invoices
Pause subscription billing
Get current plan details
Upgrade subscription plan
Resume subscription billing
Start a credit top-up Checkout flow
Top-up price quote
billing-checkout
Create a Stripe Checkout Session for the requested plan tier
white-label
List Brands
Create Brand
Get Brand
Delete Brand
Update Brand
Attach Custom Domain
Detach Custom Domain
Get Custom Domain Status
briefings
List Briefings
Get Briefing By Date
browser-sessions
List browser sessions
Request a new browser session
Get browser session detail
Approve a payment-tier session
Get recording signed URL
Reject a payment-tier session
calls
Per-call emotion arc — per-turn 4-axis timeline + final sentiment
chairman
Daily operational review
Daily operational review (owner-only)
GTM plan status
Success metrics dashboard
Monthly strategic overview
Monthly MRR tracking (owner-only)
Weekly performance summary
Weekly agent performance (owner-only)
checkpoints
Checkpoint divergence analytics — per-agent 7/30-day metrics
cockpit
Bucketised calibration + stored Platt fit (if any)
Run a Platt-scaling refit and UPSERT calibration_models
Latest conformal prediction interval for (role, output_type)
Latest persisted Mixture-of-Agents consensus for a role
Tenant-verifiable Ed25519-signed cockpit snapshot (OCF-06)
Latest UI-REVIEW audit row per phase for the tenant
Trigger a synchronous heuristic UI-REVIEW audit
compliance
Acknowledge a compliance alert
Check regulatory changes
Compliance dashboard
Deadline calendar
Run compliance scan
Set up compliance profile
Generate SOC 2 Type II audit report PDF
Real-time SOC 2 control status
Verify the SOC 2 evidence hash chain
compliance-admin
Generate Conformity Pack
connectors
List connector types and instances
Request a connector forge build
Check connector forge build status
List connector permissions
Disconnect and remove connector
Get connector health status
Trigger manual data sync
Get OAuth authorization URL
Handle OAuth callback
Connect a connector with credentials
Popup-aware OAuth callback (Plan 209-02)
content
List blog posts
Create blog post
Get blog post
Update blog post
List calendar entries
Create calendar entry
List case studies
Create case study
Get case study
Update consent status
List SEO keywords
Create SEO keyword
List social posts
Create social post
conversations
List Threads
Create Thread
Archive Thread
Get Messages
Post Message
Stream Thread
coordination
List all budget pools
CEO budget reallocation
Record a spend
Record a contact touch
Check contact spacing
Get contact interaction timeline
List current intentions
Publish a new intention
Resolve a conflict
coupons
Validate Coupon
custom-connectors
List active custom connectors
Create a custom connector definition
Get a custom connector
Update a custom connector
Delete a custom connector
Execute a connector endpoint
Test a connector connection
List tool definitions from connector
dashboard
Cashflow dashboard
HQ nerve center
Intelligence dashboard
Revenue metrics
Cash flow details
Weekly win report
data-quality
Get Latest Scores
Get Score History
decisions
List decisions with filters
Confidence calibration data per agent
Get full decision provenance
Approve a pending decision
List attachments for a decision
Reject a pending decision
List decisions
vision
List attachments for a decision
deep-signals
Deep signals — last 30 days + type/day aggregations
demo-requests
List demo requests
Submit a demo request
dogfood
Pause Agent
Resume Agent
Public Stats
dogfood-learning
Get Overrides
Rollback Override
Get Staged
Approve Staged
Extend Shadow Staged
Reject Staged
enterprise
List private forge templates
Create private forge template
Get onboarding conversation state
Start enterprise onboarding
Submit onboarding step
Priority routing latency stats
Current SLA status
Real-time SLA status with error budget
SLA credit history
Detailed error budget
Monthly SLA report
Monthly SLA report
Download monthly SLA report as PDF
export
GDPR Art. 15 — Data access request
CCPA § 1798.105 — Right to delete (California)
GDPR Art. 17 — Right to erasure
CCPA § 1798.100 — Data inventory
GDPR Art. 21 — Right to object
GDPR Art. 20 — Data portability export
GDPR Art. 16 — Right to rectification
GDPR Art. 18 — Right to restriction of processing
Check data export status / download
Download a ready portable data export
feedback
List feedback
Submit feedback
Submit NPS score
Update feedback
finetuning
List Models
Register Model
Compare Models
Rollback Model
Get Model
Get Audit Trail
Promote Model
Retire Model
forge
Request a new specialist agent
List forged agents for the current tenant
Create a forged agent
Read a forged agent
Update a forged agent
Archive a forged agent
Request a new service connector
List forged connectors for the current tenant
Create a forged connector
Read a forged connector
Update a forged connector
Archive a forged connector
OAuth callback -- exchange code for token, persist to Secret Manager
Begin OAuth authorization flow
Check forge job status
List available forge templates
gtm
List A/B tests
Create A/B test
Get A/B test
Get A/B test results
Start A/B test
List campaigns
Create campaign
Get campaign
Launch campaign
Pause campaign
List conversion alerts
Update alert config
Get conversion funnel
Get feedback digest
Get feedback trends
Get launch checklist
Run automated checks
Sign off checklist item
Help
Get contextual help for a page
Search help content
hiring
Hiring dashboard
Screen a candidate
Start a new hiring process
Get top candidates
Prepare onboarding
cfo
Get In Call Payments
incidents
List recent incidents
Get incident details
Get commander state trace
Resolve incident
Get retrospective
Update retrospective root cause
Execute runbook
Get incident timeline
insights
Get Active Insights
Dismiss Insight
integrations
List webhook subscriptions
Create a webhook subscription
Make.com verification handshake
Get webhook subscription details
Deactivate webhook subscription
List delivery logs for a subscription
Send test event to subscription
intelligence
List Trigger Events
Internal
Refresh stale help content
knowledge-graph
List Candidates
Promote Candidate
Reject Candidate
List Entities
Get Entity
Get Entity Relationships
Traverse Entity
Get Kg Stats
kpi
Get Kpi Snapshots
Get Kpi Trends
marketplace
List Verticals
Apply Vertical
mcp-tools
List the registered MCP tool catalog
Per-tool error rate + P50/P95 latency (MTP-05)
Per-tool daily usage counts (heatmap source)
meetings
List meetings for the current tenant
Get meeting configuration for the current tenant
Update meeting configuration for the current tenant
Full-text search across meeting transcripts
Get a single meeting transcript with action items
members
List Members
Get Invitation
Accept Invitation
Invite Member
Remove Member
Change Member Status
Change Member Role
memory
Build agent context
List memory crystals
ml-analytics
Bulk churn scores (admin)
Per-tenant churn prediction
Cohort analysis
Cohort significance testing
Revenue forecast
Scenario forecasts
Bulk customer health (admin)
Weekly health distribution report (admin)
Per-tenant customer health
Bulk LTV scores (admin)
Per-tenant LTV prediction
List ML models (admin)
Trigger manual retraining (admin)
Score history for a tenant
mobile
Mobile Health
Version Check
monitoring
Get alert configuration
Update alert configuration
Recent anomaly alerts
API latency percentiles
Get Capacity Forecast
Last 10 chaos experiment runs
Credit burn rate and projection
Database connection pool status
Healing budget for current tenant
Healing effectiveness per layer
Integration health status
LLM response time breakdown
Multi-tenant health scores
Per-tenant health score
Tenant health history
notifications
Get Notification Preferences
Update Notification Preferences
Register Device
onboarding-checklist
Get checklist progress
Update a checklist item
onboarding
Trigger team generation
Save business profile
Run instant business scan
Stream scan progress via SSE
Get scan results
Get team generation progress
pulse
Last N decisions for a C-suite role (drill-down from pulse widget)
Business Pulse health snapshot
strategy-replay
List Scenarios
Create Scenario
Get Scenario
Update Scenario
Rerun Scenario
reports
Get today's morning brief
Get financial report
Get revenue attribution report
List report templates
Create a report template
Get a report template
Delete a report template
Update a report template
Run a report template on-demand
Get latest weekly win report
retention
Get Dashboard
Get Policies
Update Policy
revenue
Churn risk distribution
Tenant churn detail
Conversion funnel data
Funnel conversion alerts
MRR dashboard
MRR history
Referral program overview
Upsell statistics
Get referral code
Generate referral code
Redeem referral code
Referral tracking
Prospect relationship graph
sales
List industry benchmarks
Calculate ROI projection
Capture ROI calculator lead
self-improvement
Get Proposals
Apply Proposal
Approve Proposal
Reject Proposal
Run Now Monthly Cost Rebalance
Run Now Monthly Model Routing
Run Now Weekly Prompt Ab
Get Runs
settings
Get agent identity & capabilities
Toggle an agent identity capability
Get autonomy settings
Update autonomy thresholds
Get billing overview
Create Stripe checkout session
Get detailed credit usage breakdown
Emergency freeze
Request data export
Read agent frozen state
Get notification preferences
Update notification preferences
Resume all paused agents
settings:constitutions
List Constitutions
List Constitutions
Get Drift
Get Tenant Constitution
Update Tenant Constitution
Get Violations
Get Constitution
Update Constitution
Specialization
Detect vertical for a tenant
Get tenant vertical assignment
Override tenant vertical
List supported verticals
Get vertical profile
Get vertical agent config
stripe-connect
Create a Stripe Connect Express account
Generate a new onboarding link
List payouts for the tenant
Initiate a payout to a connected account
Get payout details
tasks-stream
Stream Task Progress
team-chat
Update Artifact
Get Artifact Versions
Send Chat Message
Search Messages
List Threads
Create Thread
Get Thread With Messages
Analyze Attachment
Request Approval
Check Approval Timeout
Resolve Approval
List Artifacts
Create Artifact
Close Thread
Inject User Message
Add Message
Override Decision
Redirect Conversation
tenant
Get tenant profile
Update tenant settings
Get business profile
Update business profile
Get founder DNA
Update founder DNA
List tenant users
Invite a user
Remove a user
Update user role
trust
Get Agent Certificate
Get Eu Ai Act Json
Get Eu Ai Act Pdf
Get Merkle Root History
tuning
List A/B tests
Create A/B test
Activate A/B test
Conclude A/B test
Get calibration metrics
List false negatives
List false positives
Get learnings for agent
List personality profiles
Create personality profile
Get personality profile
Create prompt version
List prompt versions
Rollback prompt version
Evaluate prompt version
Promote prompt version
UX
List onboarding A/B tests
Create an onboarding A/B test
Deterministic variant assignment for an onboarding session
Manually promote a winning variant
Record onboarding variant outcome
Onboarding A/B test results with chi-squared p-value
Get tenant UX preferences
Update tenant UX preferences
Reset to recommended defaults
List pending CTO suggestions
Accept a pending suggestion
Dismiss a pending suggestion
List all tutorials with user progress
Get a single tutorial with user progress
Mark a tutorial as completed
Record tutorial step progress
Reset tutorial progress for replay
Skip a tutorial
vault
Initiate break-glass recovery
List vault entries
Store a vault entry
Retrieve a vault entry
Delete a vault entry
vital-signs
Business vital signs — 24h readings + risk + projections
voice
Voice Status
waitlist
List waitlist entries
Join the waitlist
Update a waitlist entry
warroom
Start a war room session
End war room session
Owner interjection
Get war room transcript
webhooks
Handle inbound email webhooks
Handle Resend webhook events
Handle Retell Webhook
Handle Stripe webhook events
Handle Stripe Issuing authorization webhooks
Handle inbound Twilio SMS and voice webhooks
Handle Twilio SMS/voice delivery status callbacks
List webhook subscriptions
Create a webhook subscription
List public webhook event types
Get a webhook subscription
Revoke a webhook subscription
List recent delivery attempts
Send a test payload
workflows
Get Analytics
List Definitions
Create Definition
Get Definition
Update Definition
Delete Definition
List Runs
Get Run Detail
Approve Run
Reject Run
List Schedules
Create Schedule
Trigger Schedule
Delete Schedule
Update Schedule
List Templates
Create Custom Template
Delete Custom Template
Preview Template
Trigger Template
ops
Health
Health Deep
Health Dependencies
Health Ready
internal
Agent Chat Respond
Worker complete callback
Worker fail callback
public-api
List agents
List agents
Get agent
Get agent
List decisions
List decisions
List API keys
List API keys
Create an API key
Create an API key
Get API key
Get API key
Revoke an API key
Revoke an API key
Rotate an API key
Rotate an API key
List webhook subscriptions
List webhook subscriptions
Create a webhook subscription
Create a webhook subscription
List public webhook event types
List public webhook event types
Get a webhook subscription
Get a webhook subscription
Revoke a webhook subscription
Revoke a webhook subscription
List recent delivery attempts
List recent delivery attempts
Send a test payload
Send a test payload
keys
List API keys
Create an API key
Get API key
Revoke an API key
Rotate an API key
status
Get Status
Get Component Detail
Integrations
Overview
Stripe
QuickBooks
Shopify
HubSpot
Generic CRM
Email Inbox
LinkedIn
X (Twitter)
Meta
Mailchimp
Google Analytics
Twilio
Resend
Gmail
Compliance
Changelog
GitHub
Select theme
Dark
Light
Auto
List Threads
GET
/api/v1/conversations
Production
Local development
List active threads for the current tenant.
Authorizations
ApiKeyAuth
Responses
200
Successful Response
Select media type
application/json
Array<object>
object
agent_role
required
string
last_message_at
required
Any of:
string
null
string
format: date-time
null
status
required
string
thread_id
required
string
title
required
Any of:
string
null
string
null
updated_at
required
string
format: date-time