API and MCP reference
917 operations in 89 areas. 846 of them are available to AI assistants over MCP.
Every operation runs as a signed-in person, with that person’s access. An assistant connected over MCP is limited in the same way, and risky changes wait for the person’s approval in Falcon.
Operations marked API only are steps a browser has to take itself, such as signing in, or addresses other services call.
This page is an overview, with one line for each operation.
Agent authoring and personal settings
Create and configure agents, review their work, manage invitations and maintain your personal settings.
-
Accept guide session
MCP
acceptGuideSession -
Accepttransfer agent
MCP
accepttransferAgent -
Agenda add
MCP
agenda_add -
Agenda list
MCP
agenda_list -
Agenda update
MCP
agenda_update -
Answer guide session
MCP
answerGuideSession -
Approves or rejects a tool that is waiting for review on an agent
MCP
approveAgentTool -
Approves or rejects the changes waiting for review in one category of an agent
MCP
reviewAgentCategory -
Archive agent
MCP
archiveAgent -
Asks for access to an agent you can see but not open
MCP
requestAgentInvitation -
Cancel background task
MCP
cancelBackgroundTask -
Change an agent's chat window skin
MCP
putAgentWidgetSkinReplace the whole chat window skin of one agent at once: its colours in light and dark, font, corners, launcher, header and whether the powered-by line shows. -
Change one instruction section
MCP
updateAgentSectionChange one section of an agent's instructions: its title, description or instructions. -
Change some of an agent's settings
MCP
patchAgentSettingsChange only the settings you send, as a JSON merge patch. -
Changes an agent's settings, voice and model
MCP
updateAgentSettingsReplaces an agent's settings, voice and model as a whole. -
Changes an agent's variables
MCP
updateAgentVariables -
Changes how an agent writes on each channel
MCP
updateAgentChannelStyles -
Changes the company's settings for the agenda tool
MCP
putAgendaSettings -
Changes what an agent remembers and how
MCP
updateAgentMemory -
Changes which agent this agent is built on
MCP
updateAgentBuiltOn -
Changes which tools and knowledge searches an agent has
MCP
updateAgentTools -
Changes who can see and edit an agent
MCP
updateAgentAccess -
Changes your own preferences
MCP
updateUserPreferences -
Changes your own profile
MCP
updateUserProfile -
Compares two versions of an agent and shows what changed
MCP
compareAgentVersions -
Connect a company app with an API key
MCP
serviceEnrollApiKeyAppConnect a company account with a key entered once. -
Connect GitHub as yourself with a token
MCP
connectGithubTokenConnect a personal GitHub account with a fine-grained personal access token. -
Create agent receiving address
MCP
createAgentReceivingAddress -
Create agent test run
MCP
createAgentTestRunRun a test message. -
Create an agent from a registered template version
MCP
createAgentFromTemplateCreate a draft pinned to an active company template publication. -
Create guide session
MCP
createGuideSession -
Create memory webhook
MCP
createMemoryWebhook -
Create public link invitation
MCP
createPublicLinkInvitation -
Creates a new agent
MCP
createAgentCreates an agent with an immutable agent_type: agent (default) or remote. -
Decline agent transfer
MCP
declineAgentTransfer -
Delete an agent
MCP
deleteAgentDelete an agent for good. -
Discard guide session
MCP
discardGuideSession -
Disconnect a connected app
MCP
serviceDisconnectConnectedAppStop local use, revoke the app sign-in and delete its provider account. -
Disconnect connected app
MCP
disconnectConnectedApp -
Download billing invoice
MCP
downloadBillingInvoice -
Duplicate agent
MCP
duplicateAgent -
Edit guide session
MCP
editGuideSession -
Export agent content
MCP
exportAgentContent -
Exports staff, community members or the audit log as CSV
MCP
exportCompanyCsv -
Get company
MCP
getCompanyRead the public company identity for the current host, including before sign-in. -
Get guide session
MCP
getGuideSession -
Get guide target
MCP
getGuideTarget -
Get me
MCP
getMe -
Import public link invitations
MCP
importPublicLinkInvitations -
Inspect agent test run
MCP
inspectAgentTestRun -
Invites a person to work on an agent
MCP
inviteAgentCollaborator -
List connected apps
MCP
listConnectedApps -
List memory deliveries
MCP
listMemoryDeliveries -
List people
MCP
listPeople -
List policies
MCP
listPolicies -
List public link invitations
MCP
listPublicLinkInvitations -
List roles
MCP
listRoles -
Lists the agents a new agent can be built on
MCP
listAgentBases -
Lists the agents you can see, with the ones you can open and the ones you can only see the name of
MCP
listAgents -
Lists the models you can choose for an agent
MCP
listModelChoices -
Pause agent
MCP
pauseAgent -
Publishes the agent's current draft as a new version
MCP
publishAgent -
Put agent channels
MCP
putAgentChannels -
Put agent public entry
MCP
putAgentPublicEntry -
Put agent voice settings
MCP
putAgentVoiceSettings -
Rate your completed test reply
MCP
rateAgentTestReplySave Helpful or Needs work and an optional note on your own completed Test reply. -
Read the ways to connect GitHub
MCP
getGithubConnectOptionsRead the two ways this company can connect GitHub and whether each is ready. -
Read workflow capabilities
MCP
getWorkflowCapabilitiesRead the workflow configuration choices before proposing steps. -
Reads your own preferences
MCP
getUserPreferences -
Reads your own profile
MCP
getUserProfile -
Reads your own sign-in methods and sessions
MCP
getUserSecurity -
Rename a company app account
MCP
serviceRenameConnectedAppChange the label of one company-owned connected account. -
Repair confirmed connection storage
MCP
serviceRepairConnectedAppRepair the dev storage association of an already confirmed company or current-person connection by its local ID. -
Replace a company app API key
MCP
serviceRotateApiKeyAppReplace the key of an installed company API-key account. -
Replace an agent's whole instructions
MCP
updateAgentInstructionsReplace an agent's whole instructions document: every section, in order. -
Replay conversation steps
MCP
replayConversationSteps -
Resend public link invitation
MCP
resendPublicLinkInvitation -
Restore agent
MCP
restoreAgent -
Reveal conversation words
MCP
revealConversationWordsreveal Conversation Words Requires a reason and records an audit entry before revealing private conversation words. -
Revoke public link invitation
MCP
revokePublicLinkInvitation -
Save agent test case
MCP
saveAgentTestCase -
Service test connected app event
MCP
serviceTestConnectedAppEvent -
Shows a preview of the agent on one channel (chat, texts, email, WhatsApp or voice)
MCP
getStudioPreview -
Signs you out of one session, or everywhere
MCP
revokeUserSession -
Start connecting an app
MCP
serviceStartConnectedAppStart a browser consent flow for a reviewed app profile and trusted connection link origin. -
Start installing the GitHub App for the company
MCP
startGithubAppInstallReturn the GitHub App install address with a single-use state bound to this company, person and session. -
Test agent phone channel
MCP
testAgentPhoneChannel -
Transfer agent
MCP
transferAgent -
Update agent knowledge searches
MCP
updateAgentKnowledgeSearches -
Update agent tool settings
MCP
updateAgentToolSettings
Agent routing registration
Prepare versioned Front desk registration metadata for an agent.
-
Read agent routing registration
MCP
getAgentRoutingVersioned agent-editor registration metadata only. -
Read Front desk authoring candidates
MCP
getPipelineRoutingCandidatesRead published agents that say what they are for (a purpose), available to the current workflow owner while routing remains unavailable. -
Save agent routing registration
MCP
putAgentRoutingVersioned agent-editor registration metadata only.
An agent's safety checks
Every check that applies to an agent in one place: what is set up, what each did in the last 30 days, and a way to try a sample message through them without sending anything.
-
Read an agent's safety checks
MCP
getAgentSafetyRead every check that applies to an agent: whether it is on, how it is set up for this agent, what it did in the last 30 days and where it is changed. -
Try a message through an agent's safety checks
MCP
tryAgentSafetyRun a sample message through the agent's checks without sending it: screening and the content rating read it, and the others say what they would do.
Share an agent as a template
Give another company a copy of an agent through a link: its instructions, the company skills it uses and the tools it needs. The other company reviews it before anything is created.
-
List an agent's template links
MCP
listAgentTemplateLinksList the links made for one agent: who made each, when it stops working, whether it is still active, and how many times a company has opened it. -
Open a template link
MCP
openAgentTemplateLinkRead what a template link holds, as a company package, so it can be reviewed here. -
Share an agent as a template link
MCP
createAgentTemplateLinkMake a link that lets another company copy this agent: its instructions, channel styles, the company skills it uses, its variables and the tool slots it needs. -
Turn a template link off
MCP
revokeAgentTemplateLinkStop a template link working from now on.
Agents
Inspect agent configuration, inheritance, publication readiness and channel settings before making changes.
-
List a person's memory records
MCP
listAgentMemoryRecordsList what an agent keeps in memory about one person: each record's kind, whose memory it is ('The person, everywhere' or 'The person, with each identity'), the path it is kept under and when it was kept. -
List agent dependencies
MCP
listAgentDependenciesRead the dependencies reported for this agent. -
List agent images
MCP
listAgentImagesRead the image records available on the agent and their revision. -
List agent test cases
MCP
listAgentTestCasesRead the agent's saved test cases and current revision. -
List agent test runs
MCP
listAgentTestRunsRead recorded test-run summaries and their states. -
List saved agent versions
MCP
listAgentVersionsList version numbers, authors and the environments using each version. -
Lists admitted conversation turns for an agent
MCP
listAgentConversationRunsLists content-free live conversation turn admissions in stable admission-key order (not chronological). -
Read a person's effective agent access
MCP
getEffectiveAgentAccessRead resolved permissions, category and section scope for the named person on this agent. -
Read agent email and phone channels
MCP
getAgentChannelsRead phone and email channel configuration, enabled state and readiness reasons. -
Read agent instruction inheritance
MCP
getAgentInheritanceRead the base chain, inherited parts and insertion points visible to the caller. -
Read agent instruction sections
MCP
listAgentSectionsRead grouped instruction sections and their editable state. -
Read agent instructions
MCP
getAgentInstructionsRead the instruction content and revision visible to the caller. -
Read agent knowledge searches
MCP
getAgentKnowledgeSearchesRead configured knowledge searches, source filters, mode and enabled state. -
Read agent lifecycle options
MCP
getAgentLifecycleRead lifecycle state and the actions currently described for this agent. -
Read agent memory settings
MCP
getAgentMemoryRead memory kinds, retention, processing steps, sharing destinations and lookup-tool settings, who shares each kind of memory ('The person, everywhere', 'The person, with each identity', 'A case' or 'The whole agent') and the path each kind is kept under. -
Read agent public entry settings
MCP
getAgentPublicEntryRead public link, widget and app entry settings, usage limits and reported readiness. -
Read agent publication readiness
MCP
getAgentPublishRead the current publication state and readiness information before publishing. -
Read agent settings
MCP
getAgentSettingsRead model selection, token and budget settings, input options and current revision. -
Read agent sharing settings
MCP
getAgentAccessRead the agent access configuration and current revision under the caller's existing authority. -
Read agent test choices
MCP
getAgentTestChoicesRead the choices offered for configuring an agent test. -
Read agent variable definitions
MCP
getAgentVariablesRead the agent variable configuration and its revision. -
Read agent voice settings
MCP
getAgentVoiceSettingsRead voice configuration and reported limits, usage and readiness for the selected environment. -
Read agent writing styles by channel
MCP
getAgentChannelStylesRead channel-specific instruction styles and their placement relative to shared sections. -
Read an agent
MCP
getAgentRead the agent name, description, category, visibility and current revision. -
Read an agent base selection
MCP
getAgentBuiltOnRead the selected base agent and inheritance settings. -
Read an agent overview
MCP
getAgentOverviewRead the agent overview with the state and summary information available to the caller. -
Read an agent tool settings layer
MCP
getAgentToolSettingsRead the settings and argument defaults explicitly configured for this agent and tool. -
Read an agent's chat window skin
MCP
getAgentWidgetSkinRead the live chat window skin of one agent: its colours in light and dark, font, corners, launcher, header, whether the powered-by line shows, and whether the plan lets you hide it. -
Read apps an agent needs people to connect
MCP
getAgentNeedsConnectionsComputes chosen and workflow-derived app needs from all saved workflow drafts, with coverage for current company identity bindings and latest asks matched by recipient id. -
Read effective agent tool settings
MCP
getAgentEffectiveToolSettingsRead merged tool settings with each value's source and lock state, plus the resulting model input schema. -
Read how an agent can be reached
MCP
getAgentReachRead whether each of an agent's ways to be reached is switched on: phone, email, public link, website widget and apps. -
Read skills bound to an agent
MCP
getAgentSkillsRead bound skill references, versions and per-agent usage guidance and tool switches. -
Read the impact of an agent base
MCP
getBuiltOnImpactRead inheritance consequences and newer published bases for readable children. -
Read tools assigned to an agent
MCP
getAgentToolsRead the tools assigned to this agent, their guidance and approval state. -
Where an agent is used in drafts or selected Dev versions
MCP
listAgentWorkflowUsesList workflows naming this agent, including reviewers, hand-offs and side chains. -
Who is editing this agent's instructions
MCP
getAgentPresenceWho has a section of this agent's instructions open for editing right now.
AI guidance
Inspect published AI guidance.
-
Install initial Ask Studio skill drafts
MCP
installAskStudioSkillSeedsCreate the initial ordinary skill drafts once in the trusted operator company. -
List AI guidance
MCP
listFalconGuidanceList AI guidance with the full text, declared variables and usage locations. -
List saved guidance samples
MCP
listFalconGuidanceSamplesRead example sample inputs and expected labels for this published guide. -
Propose an AI guidance draft
MCP
proposeFalconGuidanceDraftReplace the registered content parts of a draft. -
Publish an AI guidance draft
API only
publishFalconGuidanceDraftPublish the exact independently reviewed draft revision from the staff console with a fresh second step. -
Read a guidance trial
MCP
getFalconGuidanceTrialRead a saved trial with the exact source guide and sample revision, answers and confidence. -
Read AI guidance and its history
MCP
getFalconGuidanceRead AI guidance and its history with the full text, declared variables and usage locations. -
Read an AI guidance draft
MCP
getFalconGuidanceDraftRead the current draft and its review state without changing published guidance. -
Review an AI guidance draft
MCP
reviewFalconGuidanceDraftApprove the exact draft revision as a staff member who contributed none of its edits. -
Save a guidance sample
MCP
saveFalconGuidanceSampleSave a example sample and expected labels with its current revision. -
Try AI guidance on a saved sample
MCP
runFalconGuidanceTrialRun the current publication, an earlier published version or an exact saved draft revision against one saved example sample.
What each group may do through a connected app
Company administrators allow or block each kind of action (read, create, update, delete, send) through a connected app, for everyone or for one team or role.
-
Read what each group may do through a connected app
MCP
getConnectionActionPermissionsRead the rules for one connection, the teams and roles a rule can name, and the tools that use the connection with the kind of action each counts as. -
Set what each group may do through a connected app
MCP
updateConnectionActionPermissionsSave the whole list of rules for one connection.
Reply to an approval in a sentence
A reviewer answers a question in their own words; the decision service reads which outcome the sentence means, and Studio asks them to confirm what it read before anything is done.
-
Change how replies are read
MCP
updateApprovalReplySettingsTurn sentence replies on or off, set how sure a reading must be (0.7 to 0.99), and choose whether a clear reply to a low-risk question acts without a confirming tap and whether revise is offered. -
Check the reply examples
MCP
evaluateApprovalReplyRun the platform's examples (three for each kind of approval, and hand-ups) through the question and keep the result. -
Confirm or decline how a reply was read
MCP
confirmQuestionReplySay yes to 'I read this as ...' and it is done as read, or say no and nothing is done. -
List replies and how they were read
MCP
listApprovalReplyReadingsList the latest replies, each with the reviewer's words, what they were read as, how sure the reading was, and who confirmed it. -
Read how replies are read
MCP
getApprovalReplySettingsRead whether sentence replies are on, how sure a reading must be, the examples the question is checked against and the latest check. -
Read your latest reply to a question
MCP
getQuestionReplyRead how your newest sentence reply to a question was read, including one waiting for your confirmation. -
Reply to a question in a sentence
MCP
replyToQuestionWrite your answer in your own words.
Approvals where people work
Choose where each kind of approval is asked — Studio, Slack, email, and later Microsoft Teams and text — and who is asked, and see who answered and where.
-
Change where approvals are asked
MCP
updateApprovalRoutingChoose, for each approval rule, where it is asked (Studio is always included) and name the approvers asked outside Studio. -
List approvals asked outside Studio
MCP
listApprovalAsksList the approvals asked in Slack or by email that you were asked or asked for: where they went, whether they were sent or recorded in test mode, who answered and how. -
Read where approvals are asked
MCP
getApprovalRoutingRead, for each approval rule, where it is asked and who is asked, and which channels are ready, switched off, need setting up or are designed only.
Ask Studio skills
See the playbooks Ask Studio follows for each part of the Studio, and add your company's own house rules and reference pages for it.
-
Change Ask Studio's house rules
MCP
updateAskStudioSkillsReplace the company's Ask Studio house rules and reference pages. -
Read Ask Studio's skills
MCP
getAskStudioSkillsRead Ask Studio's built-in skills (name, when each applies, its intent and whether it always applies), with the company's house rules and reference pages.
Browser authentication and consent
Sign in, verify security challenges and review connected MCP clients.
-
Accept a membership invitation
API only
acceptInvitationAccept the invitation for the verified recipient. -
Cancel an MCP request
API only
cancelMcpPendingOperationCancel a pending request without executing it. -
Choose how phone codes are sent
API only
setPhoneTwoStepDeliveryChoose text, RCS (where offered) or a voice call for the current person's phone codes. -
Confirm an MCP request
API only
confirmMcpPendingOperationApprove execution of the exact pending request in its original browser review session. -
Confirm the code and turn on phone two-step
API only
confirmPhoneTwoStepConfirm the code sent to the new number. -
Continue company sign-in
API only
continueCompanySignInDiscover current companies only after mailbox or provider proof, then carry that proof through a single-use browser-bound company handoff. -
Disconnect an MCP client
MCP
revokeMcpConnectionRevoke the selected MCP connection and its continued access. -
Finish connecting a preset
API only
completeConnectorPresetNot available yet. -
Finish connecting an app
API only
serviceCompleteConnectedAppComplete the browser-bound, company/person/session-bound single-use callback. -
Finish installing the GitHub App
API only
completeGithubAppInstallComplete the browser return from a GitHub App installation. -
Finish signing in
API only
completeSignInExchange the challenge response for a browser session. -
Finish workspace setup
API only
completeWorkspaceSetupSave the workspace’s initial configuration after the setup challenge. -
Hand a provider answer back to its company
API only
relaySignInAt the shared sign-in address, finish a Google or Microsoft answer for a sign-in started at another company address and return where to hand it back. -
List your MCP connections
MCP
listMcpConnectionsRead the MCP clients connected by the current person. -
Read a membership invitation
API only
getInvitationLook up a membership invitation using its invitation proof. -
Read an MCP request awaiting review
API only
getMcpPendingOperationRead the exact pending request in the original browser review session. -
Read an uncertain MCP request’s receipt
API only
reconcileMcpPendingOperationRead an execution receipt without repeating the uncertain action. -
Read sign-in choices
API only
getSignInOptionsRead the sign-in methods available for this workspace. -
Read workspace setup
API only
getWorkspaceSetupRead the remaining setup required for this workspace. -
Remove a security method
MCP
removeSecurityMethodRemove a security method after the required browser security check. -
Replace backup codes
MCP
regenerateBackupCodesInvalidate the old backup codes and issue replacements for the current person. -
Reset a person’s security methods
MCP
resetPersonFactorsReset the selected person’s security methods under current administrator authority. -
Review an MCP connection request
API only
reviewMcpConsentValidate the registered client, redirect and requested permissions before browser consent. -
Send a code to add a phone for two-step
API only
startPhoneTwoStepSend a six-digit code to a mobile number the current person is adding as a second step. -
Send a phone code for a second step
API only
sendSecondStepPhoneCodeSend a code to the current person's verified number for this sign-in or Confirm it's you flow. -
Send a phone verification code
API only
startPhoneVerificationSend a verification challenge to the current person’s phone. -
Start a security check
API only
startStepUpCreates a ten-minute browser/session-bound challenge. -
Start adding a security method
API only
beginSecurityEnrollmentCreate a challenge to enroll a passkey or another supported security method. -
Start signing in
API only
startSignInCreate a sign-in challenge for the selected method. -
Verify a new security method
API only
confirmSecurityEnrollmentVerify the enrollment response and attach the security method to the current person. -
Verify a phone number
API only
confirmPhoneVerificationVerify the phone challenge and save the verified phone. -
Verify a second sign-in step
API only
completeSecondStepComplete the current session’s second authentication challenge.
Billing
See what the company owes, its invoices, its prepaid wallet and who receives billing emails.
-
Add prepaid credit
MCP
createCompanyWalletTopUpAdd credit to the wallet now by charging the company's payment method. -
Change who gets billing emails and the top-up setting
MCP
updateCompanyBillingAccountSet the billing contacts and what each receives, the automatic top-up rule, and the company's own wording for what its customers read while its assistants are unavailable. -
List invoices
MCP
listCompanyInvoicesList the invoices issued to the company, newest first, with their state and what is still owed. -
Read an invoice
MCP
getCompanyInvoiceRead one issued invoice: its lines, what has been paid, and any credits or charges added since. -
Read the billing account
MCP
getCompanyBillingAccountRead the company's billing standing in plain terms: plan, whether the account is in good standing, the wallet balance, who receives billing emails, the payment method and what is owed. -
Read the prepaid wallet
MCP
getCompanyWalletRead the prepaid credit balance, the automatic top-up rule and the most recent wallet entries.
Branding
Work on the company's white-label look with your own assistant: the Studio theme (colours, type, logos, the sign-in page and email) and each agent's chat window skin. Every change is a draft you can preview, check for contrast and compare with live before a person publishes it in Studio.
-
Change an agent's draft skin
MCP
updateBrandingSkinDraftChange the draft chat window skin of one agent, never the live one. -
Change the draft theme
MCP
updateBrandingThemeDraftChange the draft theme, never the live one. -
Check the branding's contrast
MCP
getBrandingContrastCheck the draft (or live) theme and an agent's skin against WCAG 2.1 AA: every text colour against every surface it sits on, in light and dark, with its measured ratio. -
Compare the draft branding with live
MCP
compareBrandingList what the draft changes against live: the tokens and logos you set, every drawn value that follows from them in light and dark, and, with an agent, each chat window setting that changes. -
Discard an agent's draft skin
MCP
discardBrandingSkinDraftThrow an agent's draft skin away. -
Discard the draft theme
MCP
discardBrandingThemeDraftThrow the draft theme away. -
Get a signed link to upload a logo
MCP
createBrandingLogoUploadGet a short-lived, single-use link to upload a logo for light or dark. -
Preview the draft branding
MCP
previewBrandingPreview the draft theme and an agent's draft skin without changing anything live: returns a signed Studio link that shows the draft beside live in light and dark, what changes, the contrast result, and screenshots of the sign-in page, the agents list, an agent's page, the chat window and an email in light and dark as images. -
Publish an agent's draft skin
MCP
publishBrandingSkinMake an agent's draft skin live on every site that embeds its chat window. -
Publish the draft theme
MCP
publishBrandingThemeMake the draft theme live for everyone in the company: Studio, the sign-in page and company email. -
Read a branding preview's pages
MCP
getBrandingPreviewRead the pages of a preview made by previewBranding: each screen in light and dark, drafted and live, as self-contained pages with no scripts, plus what changes. -
Read an agent's chat window skin
MCP
getBrandingSkinRead one agent's chat window skin: what is live, the draft being worked on (if any) and earlier live versions. -
Read Brand assets
MCP
getCompanyBrandAssetsRead a deterministic file plan for the saved company brand: brand/brand.json, brand/assets.json, brand/SKILL.md and selected owned logo bytes. -
Read the company content brand
MCP
getCompanyBrandKitRead the saved company brand for content: name, tagline, colours, approved fonts, logo ids, tone and templates, with field sources and a revision. -
Read the company theme as design tokens
MCP
getBrandingThemeRead the company's Studio theme: the live tokens and logos, the draft being worked on (if any), both as DTCG design tokens for light and dark, every token a company may set with its default, and earlier live versions to roll back to. -
Roll an agent's live skin back
MCP
rollbackBrandingSkinMake an earlier live skin, from history, live again. -
Roll the live theme back
MCP
rollbackBrandingThemeMake an earlier live theme, from history, live again. -
Save the company content brand
MCP
saveCompanyBrandKitReplace the company content brand after a person reviews and confirms it. -
Upload a logo to a signed link
API only
uploadBrandingLogoSend a logo's bytes to the link createBrandingLogoUpload gave.
Change review
See exactly what changed in an agent, skill or workflow before it is published, and set the company's rules for changes to chosen categories and for reviewing workflows.
-
Approve or decline a workflow review
MCP
decidePipelineReviewApprove or decline a workflow's review. -
Approve or reject a skill draft for publishing
MCP
reviewSkillPublicationRecord a second person's decision on a skill draft whose category needs approval before publishing. -
Ask for a review of a draft
MCP
requestChangeReviewTell the people who watch an agent or skill, and those who can approve it, that its draft is ready for review. -
Change the company's change rules
MCP
updateChangeRulesChoose which instruction categories need an acknowledgement or a second person's approval before publishing, which always alert their owners, and when a workflow needs a review before it is published. -
Comment on a workflow review
MCP
commentPipelineReviewAdd a comment to a workflow review, on one step or start or on the whole workflow. -
List categories you can watch
MCP
listChangeWatchCategoriesList only the ids and names of instruction categories you can currently read in this company. -
List your change alerts
MCP
listChangeAlertsList alerts about agents, skills and categories you watch, newest first, each with what changed and the diff as you may see it. -
Mark a change alert read
MCP
markChangeAlertReadMark one of your change alerts as read. -
Read a workflow's review
MCP
getPipelineReviewRead whether a workflow needs a review before it is published, the latest review with its comments, who may review it, and the diff it is judged by. -
Read the company's change rules
MCP
getChangeRulesRead which instruction categories need an acknowledgement or a second person's approval before publishing, and which always alert their owners. -
Read whether you are told about changes
MCP
getChangeWatchRead whether you are told about changes to an agent, a skill, an instruction category or a department, and why: your own choice, a default for category owners and administrators, or a company rule. -
Send a workflow for review
MCP
requestPipelineReviewAsk a named person to review a workflow's draft before it is published. -
Show what changed in a skill
MCP
getSkillDiffCompare a skill's draft or a published version with Live, with nothing, or with another published version, line by line. -
Show what changed in a workflow
MCP
getPipelineDiffCompare a workflow's draft with its latest version, Live, nothing or a published version: each step and start line by line, and an 'Also changes' list of the agent versions it follows, connections, variables and limits. -
Show what changed in an agent
MCP
getAgentDiffCompare an agent's draft or a published version with Live, with nothing, or with another published version, line by line. -
Turn change alerts on or off
MCP
updateChangeWatchChoose whether you are told about changes to an agent, a skill, an instruction category or a department.
Company administration
Manage company membership, security, appearance, billing and operating settings.
-
Accept company setup suggestions
MCP
companyAcceptGuideSessionApply the reviewed company setup guide result under the current caller’s settings authority and declared preconditions. -
Add a company person
MCP
createCompanyPersonCreate a membership record with the supplied name, address and role. -
Add a GitHub installation
MCP
createCompanyGithubInstallationRecord a GitHub installation and its repository access for this company. -
Adds a cloud account to deploy agents to
MCP
createCompanyDeploymentAccount -
Adds a payment method
MCP
createCompanyPaymentMethod -
Adds an agent image
MCP
createCompanyImage -
Answer a company setup question
MCP
companyAnswerGuideSessionSubmit an answer to the current company setup guide question and return the next guide state. -
Applies the draft theme so everyone sees it
MCP
changeCompanyThemeApply -
Change billing details
MCP
updateCompanyBillingSave the company’s billing details using their current revision. -
Change email domain policy
MCP
updateCompanyDomainPolicyReplace the allowed and blocked email domain policy using its current revision. -
Change MCP access policy
MCP
updateCompanyMcpPolicyReplace the company MCP policy with reviewed values using its current revision. -
Changes a deployment account
MCP
updateCompanyDeploymentAccount -
Changes a payment method
MCP
updateCompanyPaymentMethod -
Changes a person's role or details
MCP
updateCompanyPerson -
Changes an agent image
MCP
updateCompanyImage -
Changes an invitation
MCP
updateCompanyInvitation -
Changes the defaults for traveller payments
MCP
updateTravellerPaymentDefaults -
Changes the draft theme
MCP
changeCompanyThemeDraft -
Complete a privacy request
MCP
completeCompanyPrivacyRequestMark or execute the requested completion under the privacy request’s current state and company policy. -
Confirm a people roster import
MCP
importCompanyPeopleRosterSave the exact confirmed CSV as employee metadata at the previewed roster revision. -
Copies a pending invitation's link
MCP
copyCompanyInvitationLinkReturns the link of one pending invitation so an administrator can pass it on directly, for example when its email could not be sent. -
Discard a company setup guide
MCP
companyDiscardGuideSessionDiscard the proposed company setup guide result without applying its suggested settings. -
Edit a company setup answer
MCP
companyEditGuideSessionChange a saved answer in the company setup guide before accepting its proposed settings. -
Export a company package
MCP
exportCompanyPackageMake one package of this company's checks, identity fields, categories, company skills, agents and workflows, with the list of connections, numbers and identities the company importing it must supply. -
Export authored content
MCP
exportCompanyAuthoredContentRequest an export of authored content visible under the company’s current access policy. -
Export the audit log
MCP
exportCompanyAuditRequest an export of company audit records under the caller’s current audit permissions. -
Goes back to an earlier theme
MCP
changeCompanyThemeRevert -
Import a company package
MCP
importCompanyPackageImport a package as its preview said: add new items, update the items an earlier import of the same package made, and leave out refused items. -
Invites a person to the company
MCP
createCompanyInvitation -
List privacy requests
MCP
listCompanyPrivacyRequestsList the company’s recorded privacy requests and their progress so authorized staff can handle them. -
Lists earlier themes
MCP
listCompanyThemeHistory -
Lists entries in the company's audit log
MCP
listCompanyAudit -
Lists the choices available for agent images
MCP
getCompanyImageOptions -
Lists the cloud accounts the company deploys agents to
MCP
listCompanyDeploymentAccount -
Lists the company's agent images
MCP
listCompanyImage -
Lists the company's invitations
MCP
listCompanyInvitation -
Lists the company's payment methods
MCP
listCompanyPaymentMethod -
Lists the design tokens a theme can change
MCP
getCompanyThemeTokens -
Lists the filters and choices for the people list
MCP
getCompanyPeopleOptions -
Lists the people in the company
MCP
listCompanyPerson -
Makes a preview of the draft theme
MCP
changeCompanyThemePreview -
Moderate company authors
MCP
moderateCompanyAuthorsApply the requested moderation action to the selected community authors. -
Move the company's RCS sender registration along
MCP
actOnCompanyRcsRegistrationAsk for the company's approval, withdraw the request, approve the saved details, mark the registration as filed with the provider (which locks the brand details), record what the provider answered, or start a new version after a denial. -
Moves agents or instructions between categories, using a preview you made just before
MCP
applyCompanyCategoryChange -
Open the billing portal
MCP
createBillingPortalSessionCreate a short-lived billing portal session for the company so an authorized person can manage payment details with the billing provider. -
Preview a company package import
MCP
previewCompanyPackageImportCheck every item in a package against this company: which it would add, which it would update because an earlier import (or an item with the same name or key) made them, which are unchanged, and which it would leave out and why. -
Preview a people roster import
MCP
previewCompanyPeopleImportPreview up to 500 people from a CSV (128 KiB, 32 columns). -
Preview or invite many people
MCP
invitePeoplePreview up to 500 invitation rows, then queue ready invitations after one recent second step. -
Read a company setup guide
MCP
companyGetGuideSessionRead the current question, answers and proposed settings for an existing company setup guide session. -
Read billing details
MCP
getCompanyBillingRead company billing configuration and available invoice information. -
Read company message topics
MCP
getCompanyMessageTopicsCompany message topics and their consent classification, quiet hours and daily limits. -
Read company validation checks
MCP
getValidationChecksRead custom checks, ready-made checks and saved company input-check defaults. -
Read deployment details
MCP
getCompanyDeploymentDetailsRead the deployment details for the supplied account and resource selection. -
Read email domain policy
MCP
getCompanyDomainPolicyRead the company rules for allowed and blocked email domains before changing enrollment or invitation policy. -
Read MCP access policy
MCP
getCompanyMcpPolicyRead who may connect MCP clients and which actions require confirmation under the current company policy. -
Read Microsoft sign-in settings
MCP
getCompanyMicrosoftSignIn -
Read the company plan
MCP
getCompanyPlanRead the current company plan and its limits before requesting a feature that depends on plan eligibility. -
Read the company's RCS sender registration
MCP
getCompanyRcsRegistrationRead the company's registration for its own RCS sender: the brand, contact, legal, use case, reach and tester details saved so far, which checks still fail, who prepared and approved it, when it was filed and what the provider has answered, per carrier. -
Read the screen import draft
MCP
getScreenImportDraftRead the company’s single saved import draft, including its original source and proposed screens. -
Reads one agent image
MCP
getCompanyImage -
Reads one deployment account
MCP
getCompanyDeploymentAccount -
Reads one invitation
MCP
getCompanyInvitation -
Reads one payment method
MCP
getCompanyPaymentMethod -
Reads one person
MCP
getCompanyPerson -
Reads payment totals and defaults for traveller payments
MCP
getTravellerPaymentTotals -
Reads the company's theme: the live one and any draft
MCP
getCompanyTheme -
Reads the full details for one person
MCP
getCompanyPersonDetails -
Record a privacy request
MCP
createCompanyPrivacyRequestRecord a person’s requested privacy action for company handling. -
Record Microsoft admin approval
MCP
completeCompanyMicrosoftConsent -
Run a company action
MCP
actOnCompanyGeneralRun a supported company-level action against the current settings revision. -
Run a connection action
MCP
actOnCompanyConnectionRun a supported action on one company connection. -
Run a data privacy action
MCP
actOnCompanyDataPrivacyRun a supported action on the company data privacy settings. -
Run a deployment account action
MCP
actOnCompanyDeploymentAccountRun a supported action on a company deployment account. -
Run a GitHub installation action
MCP
actOnCompanyGithubInstallationRun a supported action on a company GitHub installation. -
Run a model settings action
MCP
actOnCompanyModelLimitsRun a supported action on company model settings using the current revision. -
Run a security action
MCP
actOnCompanySecurityRun a supported action on company security settings. -
Run a single sign-on action
MCP
actOnCompanySsoRun a supported action on the company’s single sign-on configuration. -
Run a tool category action
MCP
actOnCompanyToolCategoryRun a supported action on a company tool category. -
Run an event source action
MCP
actOnCompanyEventSourceRun a supported action on one company event source. -
Run an MCP policy action
MCP
actOnCompanyMcpPolicyRun a supported action on the company MCP policy, subject to current company authority and the declared revision precondition. -
Runs an action on a payment method, such as verify or remove
MCP
actOnCompanyPaymentMethod -
Runs an action on a person, such as sign out everywhere or remove. The actions allowed depend on the person
MCP
actOnCompanyPersonRuns an action on a person, such as sign_out_everywhere or remove. -
Runs an action on an agent image, such as build or remove. The actions allowed depend on the image
MCP
actOnCompanyImageRuns an action on an agent image, such as build or remove. -
Runs an action on an invitation, such as resend or revoke
MCP
actOnCompanyInvitation -
Save a connection credential
MCP
setCompanyConnectionsSecretReplace the write-only credential for one company connection. -
Save a model credential
MCP
setCompanyModelsSecretReplace the write-only credential in company model settings. -
Save an event source credential
MCP
setCompanyEventSourcesSecretReplace the write-only credential for one company event source. -
Save company validation checks
MCP
putValidationChecksReplace custom check definitions and optionally update company check_settings and file_scan settings. -
Save Microsoft sign-in settings
MCP
putCompanyMicrosoftSignIn -
Save or discard the screen import draft
MCP
putScreenImportDraftReplace the company’s single saved import draft, or discard it with draft null. -
Save the company's RCS sender registration draft
MCP
updateCompanyRcsRegistrationSave every detail of the registration draft at once. -
Search saved employee roster details
MCP
searchCompanyPeopleRosterRead confirmed CSV employee metadata in the current company. -
Searches the company's audit log
MCP
searchCompanyAudit -
Searches the company's people
MCP
searchCompanyPeople -
Show what a company package carries
MCP
getCompanyPackagesRead how many checks, identity fields, categories, company skills, agents and workflows a package from this company would carry, what never travels, and the packages imported here before. -
Shows what moving agents or instructions between categories would change
MCP
previewCompanyCategoryChange -
Signs a person out everywhere
MCP
signOutCompanyPerson -
Start a company setup guide
MCP
companyCreateGuideSessionCreate a company setup guide session for the requested settings target. -
Throws away the draft theme
MCP
changeCompanyThemeDiscard -
Try a validation check
MCP
tryValidationCheckEvaluate sample text with one company-defined check and return the decision without saving the sample. -
Update company message topics
MCP
updateCompanyMessageTopicsCompany message topics and their consent classification, quiet hours and daily limits. -
Uploads a logo for the theme
MCP
uploadCompanyLogo
Company closing
Close a company's account from the operator console: two people agree, and 30 days later its data is removed.
-
Cancel closing a company
MCP
cancelOperatorCompanyClosureWithdraw a proposal, or cancel a scheduled closing before its 30 days run out. -
Confirm closing a company
MCP
confirmOperatorCompanyClosureConfirm another staff member's proposal. -
List company closings
MCP
listOperatorCompanyClosuresList every company closing that has been proposed, scheduled, withdrawn or cancelled, with who did each step and when the data goes. -
Propose closing a company
MCP
proposeOperatorCompanyClosurePropose closing a company, with a reason.
Separate Contacts
Keep the company's Contacts: people outside the company, separate from acting identities and Team users.
-
Add a contact
MCP
createCompanyContactSave a new contact with a name and optional emails, phones and fields. -
Archive a contact
MCP
archiveCompanyContactSoft-delete a contact at the revision last read: it leaves the contact list and is never matched or selected, and restoreCompanyContact brings it back. -
Change a contact
MCP
updateCompanyContactReplace a contact's details and its Team member and acting identity links at the revision last read. -
Import contacts from a CSV
MCP
importCompanyContactsCheck or save up to 100 contacts from a CSV of at most 64 KB with a header row and a name column. -
List contacts with their details
MCP
listCompanyContactDetailsRead the company's contacts with their name, emails, phones and fields, newest-created order by reference. -
List separate Contact metadata
MCP
listCompanyContactsRead separate Contact references, revisions, conversation dates and profile-presence only. -
Read one contact with details
MCP
getCompanyContactDetailsRead one contact's name, emails, phones, fields, links and revision. -
Read separate Contact metadata
MCP
getCompanyContactRead separate Contact references, revisions, conversation dates and profile-presence, plus display-only active channel-address opt-outs for linked, non-archived contact points. -
Restore an archived contact
MCP
restoreCompanyContactBring an archived contact back to the contact list at the revision last read.
Staged company departments
Name custom departments before enabling department policy. Definitions alone grant no access.
-
Inventory retained agent and workflow categories
MCP
getCompanyDepartmentCategoryInventoryRead counts from one current company transaction. -
Preview staged department defaults changes
MCP
previewCompanyDepartmentDefaultsDeprecated: staged department cells and per-person overrides left Studio; a person's level applies in every department they belong to. -
Preview staged department membership changes
MCP
previewCompanyDepartmentMembershipsCompare a full proposed roster with the current staged revision. -
Read staged company department definitions
MCP
getCompanyDepartmentsRead fixed Company-wide and Admin entries followed by staged custom department definitions. -
Read staged department configuration snapshot
MCP
getCompanyDepartmentConfigurationRead definitions, ordered memberships, stored cells and overrides at one staged revision. -
Read staged department memberships
MCP
getCompanyDepartmentMembershipsOrdered custom-department memberships only. -
Save staged custom company department definitions
MCP
putCompanyDepartmentsReplace up to 500 custom department definitions with revision checks and an atomic audit event. -
Save staged department instruction-category defaults
MCP
putCompanyDepartmentInstructionCategoriesDeprecated: staged department cells and per-person overrides left Studio; a person's level applies in every department they belong to. -
Save staged department memberships
MCP
putCompanyDepartmentMembershipsOrdered custom-department memberships only. -
Save staged department skill-section defaults
MCP
putCompanyDepartmentSkillSectionsDeprecated: staged department cells and per-person overrides left Studio; a person's level applies in every department they belong to.
Company entries
Read the canonical Ways in configuration catalog.
-
Assign a settings profile to a canonical entry
MCP
updateCompanyEntryProfileAssign an existing canonical dev entry to an exact current active settings profile using both revisions. -
List canonical company entries
MCP
listCompanyEntriesRead a bounded page of canonical company/environment configuration references. -
Narrow a canonical entry lifecycle
MCP
updateCompanyEntryStateChange an existing canonical dev entry to disabled or terminal revoked using its current revision. -
Read one canonical company entry
MCP
getCompanyEntryRead one current canonical company/environment configuration record by id, including disabled and revoked tombstones. -
Read the canonical entry for a legacy source
MCP
getCompanyLegacyEntryResolve an exact legacy transport kind and source id to its deterministic canonical company entry on dev. -
Save checks for a canonical way in
MCP
updateCompanyEntryScreeningSave per-way-in checks on the canonical dev entry with its current revision. -
Save inbound identity choices for a canonical entry
MCP
updateCompanyEntryIdentityAssignmentSave bounded inbound identity choices on the canonical dev entry using its current revision.
Company escalation defaults
Store default escalation contacts and question settings once per company.
-
Read company escalation defaults
MCP
getCompanyEscalationRead company default escalation contacts and question settings. -
Save company escalation defaults
MCP
putCompanyEscalationSave company default escalation contacts and question settings.
Company held messages
Read held admission receipts for the company Ways in audit.
-
List held way-in messages
MCP
listHeldMessagesRead a bounded page of held admission receipts across ways in, optionally filtered to one canonical entry id.
Company MCP address selection
Select published targets and who may use the company address from Settings > MCP.
-
Change company MCP selection
MCP
updateCompanyMcpAddressSelectionReplace the company address exclusion checklist and allowed people or teams using the current revision. -
Read company MCP selection
MCP
getCompanyMcpAddressSelectionRead saved exclusions and access for the published-target company MCP address.
Current agent number assignments
Read bounded current number occupancy without financial or connection administration rights.
-
List current number assignments for an agent
MCP
listAgentCompanyNumberAssignmentsActive non-community company members with current read and edit rights on this agent.
Number deletion protection
Protect company inventory numbers from release.
-
Set number deletion protection
MCP
setCompanyNumberProtectionCompany owner or administrator only.
Company self-serve sign-up
Create and review a new company workspace without granting production access before operator staff approval.
-
Approve a company sign-up
MCP
approveCompanySignupRequestApprove a verified request and create its limited workspace defaults. -
List company email reputation guards
MCP
listEmailReputationRead rolling SES bounce and complaint rates and any automatic outbound-email pauses. -
List company sign-up requests
MCP
listCompanySignupRequestsRead verified company sign-ups waiting for operator staff approval. -
Start a company sign-up
API only
startCompanySignupSubmit company details, a verified mailbox and a processor-vault payment reference for a new workspace sign-up. -
Unpause a company's outbound email
MCP
unpauseCompanyEmailAfter review, staff can clear a company's automatic email-reputation pause. -
Verify a company sign-up
API only
verifyCompanySignupVerify the mailbox code sent for a company sign-up.
Spending
One spend policy per company: its monthly and daily limits, what it has spent against them, and the per-agent caps inside them.
-
Change the company's spending limits
MCP
updateCompanySpendingSet the company's monthly and daily limits. -
Read the company's spending limits
MCP
getCompanySpendingRead the company's monthly and daily limits, the most each may be set to, what has been spent this month and today, and the per-agent, per-person, per-run and per-conversation caps.
Connect requests
Ask the company's identities and people, by email, to connect their own app accounts on a page that needs no sign-in.
-
Ask people to connect their accounts
MCP
sendConnectRequestEmails each chosen identity or Studio person a link, in the company's own name, where they connect the chosen apps without signing in. -
Finish connecting an app
API only
finishConnectInviteAppConfirms the app's sign-in finished for the person the link was sent to, and records the connection as theirs. -
List connect requests
MCP
listConnectRequestsLists the company's latest connect requests, newest first, with how many people are sent, opened, complete, bounced or expired. -
Open a connect page
API only
openConnectInviteReads the page a connect link opens: the company's name, the person's first name and the apps asked for, each connected or not. -
Read a connect request
MCP
getConnectRequestReads one request with every person's status: sent, opened, connected n of m, bounced, expired or stopped. -
Read a person's connect request
MCP
getConnectInviteReads one identity's or person's current request: the apps asked for, which are connected, and whether the link was sent, opened, bounced or has expired. -
Read the fixture outbox's connect email
API only
getConnectInviteFixtureEmailFixture mode only: returns the last connect email the local outbox kept for this person, standing in for real delivery so a tester can open the link. -
Read your own connect request
MCP
getMyConnectInviteReads the signed-in person's own connect request: the apps the company asked them to connect, which are connected (from the emailed link or from Your connections), and the link's status. -
Remind people who have not finished
MCP
remindConnectRequestEmails a fresh link only to the people in this request who still have an app to connect. -
Remove a connected app
API only
removeConnectInviteAppRemoves the person's own connection to one of the apps on their page. -
Start connecting an app
API only
startConnectInviteAppStarts the app's own sign-in for the person the link was sent to, and returns where to send their browser. -
Stop a person's link
MCP
revokeConnectInviteStops the person's current link straight away.
Connections
Inspect configured app and channel connections, sender readiness and tool grants.
-
Add an app to company apps
MCP
pinCompanyAppPin an app from the local catalogue without signing in. -
Change company app sign-in settings
MCP
updateCompanyAppSettingsChange between Falcon's client and the company's own client. -
Change identity verification settings
MCP
updateIdentityVerificationSettingsChange how checks work for every agent: the age the inquiry template checks, whether a finished check counts as verified, how long links work, when people verify again, and the notice sent with every link. -
Change Persona app connection settings
MCP
updatePersonaAppSettingsManage the company Persona app connection using the existing canonical verification account, vault, revisions and authorization. -
Connect a Persona account
MCP
savePersonaAppAccountManage the company Persona app connection using the existing canonical verification account, vault, revisions and authorization. -
Connect a Persona account
MCP
saveIdentityVerificationAccountConnect the company's own Persona account for Dev (a sandbox key) or Live (a production key), with the inquiry template and the webhook secret. -
Connect an Other email mailbox
MCP
createOtherEmailConnectionConnect a hand-entered SMTP and IMAP mailbox after a mandatory test send; credentials are write-only and encrypted. -
Create a saved request shape
MCP
createRequestShapeSave explicitly authored masked shape metadata in the current company library. -
Create a server key for an API way in
MCP
createIncomingRequestKeyCreate a server key for one API way in and show its value once. -
Create an incoming email map
MCP
createIncomingEmailMapCreate an email way in with only workflow_id to issue an address and safe defaults, or supply a complete email rule. -
Create an incoming request map
MCP
createIncomingRequestMapCreate a signed, bounded request address that maps an incoming request to a workflow or agent. -
Decide on a held email
MCP
decideHeldIncomingEmailStart a held or skipped email anyway (its email map's target runs once), mark it as spam, or dismiss it. -
Delete an incoming email map
MCP
deleteIncomingEmailMapDelete an incoming email map and its run authority, revoking any imported shared entry in the same transaction. -
Delete an incoming request map
MCP
deleteIncomingRequestMapDelete a request map. -
Disconnect a Persona account
MCP
removePersonaAppAccountManage the company Persona app connection using the existing canonical verification account, vault, revisions and authorization. -
Disconnect a Persona account
MCP
removeIdentityVerificationAccountDisconnect an environment's Persona account and schedule its key and webhook secret for deletion. -
Disconnect an Other email mailbox
MCP
disconnectOtherEmailConnectionDisable a mailbox and remove stored credentials. -
Learn a request shape from a JSON sample
MCP
learnRequestShapePropose bounded field paths and types with masked examples from JSON text (8 KiB UTF-8 maximum). -
List a connection's tool choices
MCP
listToolConnectionChoicesList tools available through a selected connection. -
List an API way in's server keys
MCP
listIncomingRequestKeysList the server keys of one API way in: name, test or live, last four characters, browser origins, state, last use and, after a rotation, when the old value stops working. -
List an identity’s connected apps
MCP
listCompanyIdentityConnectedAppsRead only one company identity’s verified app connections. -
List available message senders
MCP
listSendingSendersHosted reads list full company email addresses with current binding consent and verified-domain or matching-mailbox readiness, filtered to agents the caller may configure. -
List company apps
MCP
listCompanyAppPinsList the apps pinned by the company in insertion order, including apps with no connected account. -
List company message keys
MCP
listCompanyMessageKeysRead message-key metadata and configured state. -
List connected app deliveries
MCP
serviceListConnectedAppDeliveriesRead recorded workflow handoffs for this connection and environment: at most 100 newest within 192 KiB. -
List connected apps
MCP
serviceListConnectedAppsRead the complete visible connection list in one response; no cursor or pagination input is accepted. -
List connection presets
MCP
listConnectorPresetsList reusable connection presets. -
List held incoming email
MCP
listHeldIncomingEmailsRead the emails the check before a run held or skipped: each email's kind, how sure the check was, its email map, its files kept and not kept, and when it arrived and expires. -
List incoming email maps
MCP
listIncomingEmailMapsRead the ordered rules that route inbound email, the addresses assigned to agents and identities, and the company's forwarding or MX setup. -
List incoming request maps
MCP
listIncomingRequestMapsRead request maps, their rotatable addresses and recent accepted, ignored or refused results. -
List labelled incoming email
MCP
listIncomingEmailLabelsRead what people said held and skipped emails really were, next to what the check said, for checking the filter later. -
List saved request shapes
MCP
listRequestShapesRead company-scoped masked shape metadata and exact revision. -
List SendGrid connections
MCP
listSendGridConnectionList configured SendGrid connections and their status. -
List twilio connections
MCP
listTwilioConnectionsList configured Twilio connections and their status. -
List what request map targets receive and give back
MCP
listIncomingRequestTargetsRead every workflow or agent a request map can start: its declared start fields, the steps that receive them first, what it gives back, and JSON Schemas for its input and response generated from its definition and versioned with it. -
Listen for a Request URL sample
MCP
controlIncomingRequestSampleStart or stop a ten-minute sample window, or keep or release the latest masked sample. -
Prepare a saved request shape example
MCP
getRequestShapeExamplePrepare deterministic masked example JSON from an active saved shape at the requested revision. -
Preview a Request URL mapping
MCP
previewIncomingRequestMappingPreview only the Mapping stage against current target fields without starting a workflow. -
Read a connected app
MCP
serviceGetConnectedAppRead verified connections owned by the signed-in person. -
Read a connection preset
MCP
getConnectorPresetRead a preset's provider and connection requirements. -
Read a person's verification
MCP
getPersonVerificationRead what one person's identity check came to in Dev or Live: its status, the age it confirmed, when it was verified and expires, and Persona's inquiry id. -
Read a Persona check's result
MCP
getPersonaAppCheckResultRead the company's stored Persona check result for one person in Dev or Live, using the same signed callback record as existing identity checks. -
Read a Request URL sample
MCP
getIncomingRequestSampleRead bounded property paths and types from the last parsed request, including verification refusals. -
Read a SendGrid connection
MCP
getSendGridConnectionInspect a SendGrid connection's configured state. -
Read a Twilio connection
MCP
getTwilioConnectionInspect a Twilio connection's configured state. -
Read an app event example
MCP
getAppCloudEventExampleInspect the app event envelope. -
Read an app icon
MCP
getAppIconRead sanitized public app artwork through a bounded server cache. -
Read company app sign-in settings
MCP
getCompanyAppSettingsRead the sign-in choice and identity-connectability flag. -
Read company messaging rules
MCP
getCompanyMessagingRulesRead the message kinds and sending rules that apply. -
Read identity verification
MCP
getIdentityVerificationRead the company's Persona connection for Dev and Live (whether each is connected, its inquiry template, the key's last four characters and the webhook address to add in Persona) and how checks work: the age the template checks, whether a finished check counts, how long links work, when people verify again and the notice sent with each link. -
Read message-key tool grants
MCP
getMessageKeyToolGrantsRead which tools a message key may use. -
Read one saved Other email mailbox
MCP
getOtherEmailConnectionRead mailbox status and last test without credentials. -
Read one saved request shape
MCP
getRequestShapeRead company-scoped masked shape metadata and exact revision. -
Read Persona app connection
MCP
getPersonaAppConnectionManage the company Persona app connection using the existing canonical verification account, vault, revisions and authorization. -
Read Request URL pull activity
MCP
getIncomingRequestPullActivityRead the last completed pull page and, where retained, up to 20 completed pages newest first: delivered and skipped-duplicate counts, hashed duplicate keys and storage-admitted completion times. -
Read saved Other email mailboxes
MCP
listOtherEmailConnectionsRead mailbox status, addresses and the last provider test without credentials. -
Read the company webhook endpoint
MCP
getCompanyWebhookEndpointInspect the configured shared webhook endpoint. -
Receive a mapped incoming request
API only
receiveIncomingRequestVerify and map a signed incoming request, sent as JSON or form fields. -
Receive an identity verification result
API only
serviceReceiveIdentityVerificationEventReceive a Persona webhook event for the company's Dev or Live account. -
Remove an app from company apps
MCP
unpinCompanyAppUnpin an app without disconnecting any account or changing grants. -
Revoke a person's verification
MCP
revokePersonVerificationTake back a person's verification in Dev or Live, with a reason, and optionally ask Persona to delete the check's personal data. -
Revoke an API way in's server key
MCP
revokeIncomingRequestKeyStop a key at once, including an old value still in its rotation window. -
Rotate an API way in's server key
MCP
rotateIncomingRequestKeyGive a key a new value, shown once. -
Rotate an incoming request address
MCP
rotateIncomingRequestMapRotate a request map address while retaining its mapping and target. -
Show a held email's excerpt
MCP
revealHeldIncomingEmailShow the subject, a short excerpt and any retained original input-screening decision and refusal reason of one held or skipped email. -
Show a webhook signing secret
MCP
revealIncomingRequestMapSecretExplicitly reveal one current custom webhook signing secret or shared key. -
Test a Request URL signature
MCP
testIncomingRequestVerificationTest the saved sender verifier against a supplied raw request using the current server clock. -
Update an incoming email map
MCP
updateIncomingEmailMapChange an email map's matching rule or target while retaining its inbound address. -
Update an incoming request map
MCP
updateIncomingRequestMapChange the name, target, verification, conditions or mapping without changing the request address.
Connector packages and reference knowledge
Discover reviewed connector packages and pinned toolkit support documentation. Discovery never installs a connection or grants execution.
-
List prebuilt connector packages
MCP
listConnectorPackagesRead versioned native package mappings, coverage, limits and live qualification status. -
Read a prebuilt connector package
MCP
getConnectorPackageRead a package with function icons, example outputs, REST mappings, limits and live qualification status. -
Read connector reference knowledge
MCP
getConnectorReferenceSearch or read a pinned toolkit support corpus with source commit, retrieval date and content hash. -
Search connector reference knowledge
MCP
searchConnectorReferencesSearch or read a pinned toolkit support corpus with source commit, retrieval date and content hash.
Data expression previews
Try a bounded typed expression with caller-owned JSON data.
-
Try a data expression
MCP
previewDataExpressionEvaluate a pure typed expression against caller-supplied JSON sample data at the current saved workflow revision.
Where decisions are made
Every place the product asks a quick yes/no, pick-one or score question to decide something, in one list: where it runs, what it asks in plain words, whether it is fixed by the platform, tunable by the company or written by the company's authors, and what it did in the last 30 days.
-
Change an agent's decision tuning
MCP
updateAgentDecisionSettingsReplace how an agent's decisions are tuned: how early screening flags a message, phrases that always hold a message, exact messages checked to the standard only, what happens to a flagged message and how sure an Ask about documents answer must be. -
Read every decision slot in the company
MCP
getDecisionsList every place a decision is made, with the values in effect for the company and what each slot did in the last 30 days. -
Read the decisions that apply to an agent
MCP
getAgentDecisionsList every decision slot with the values in effect for one agent and what each slot did for that agent in the last 30 days.
Output Screening samples
Test a saved output screen with current checks and ratings, without delivering anything.
-
Try a saved output Screening step
MCP
sampleDeliveryScreenRuns one saved Deliveries Screening step against a supplied text answer and optional run fields.
Docs
Search the product docs and read any page in full, so an assistant can answer how-to questions from the same pages people read.
-
Read a docs page
MCP
readDocPageRead one docs page in full, as Markdown. -
Search the docs
MCP
searchDocsFind the docs sections that best match some words, best first, each with the page to read in full.
Door settings profiles
Read durable shared screening and cap configuration on dev.
-
Create a door settings profile
MCP
createDoorSettingsProfileCreate shared screening and cap configuration without binding or enabling a way in. -
List door settings profiles
MCP
listDoorSettingsProfilesRead a bounded page of shared door settings profiles for screening, caps and speaking identity. -
Read one door settings profile
MCP
getDoorSettingsProfileRead one shared door settings profile by id, including how many ways in use it. -
Update a shared door settings profile
MCP
updateDoorSettingsProfileReplace configuration at the current revision and atomically advance every current canonical entry reference.
Editing by email
Change an agent's instructions or a company skill by emailing its edit address, or email the company's Studio address for anything you could change in Studio. The Studio assistant reads the email as the sender, drafts the change and replies with it before anything is saved; changes beyond drafts are approved with a code from the sender's phone or authenticator app.
-
Change editing by email
MCP
updateEmailEditSettingsTurn personal edit addresses on or off, choose whether the company address may propose any change the sender could make in Studio ('Email Studio can propose any change', on by default), how long an email approval window lasts (0 to 60 minutes, 30 by default) and which changes always need Studio (permissions, secrets, connections and spending always do). -
Confirm an emailed change
MCP
confirmEmailEditConfirm the change drafted from an email with the one-time token from its confirmation link. -
Confirm an emailed plan
API only
confirmEmailEditReviewApply the whole plan an email to the company's Studio address produced, as the person who sent it, in Studio instead of by phone approval; changes that always need Studio are confirmed only here. -
End everyone's email approvals
API only
endCompanyEmailApprovalsEnd every open email approval window in the company now. -
End your email approval window
API only
endEmailApprovalWindowEnd your open email approval window now. -
Issue an edit address
MCP
issueEmailEditAddressIssue the edit address for one agent, one skill, or, naming neither, the company-wide address. -
Read an edit address
MCP
getEmailEditAddressRead the edit address for one agent, one skill, or, naming neither, the company-wide address; null until one is issued. -
Read an emailed plan to review
API only
getEmailEditReviewRead the plan an email to the company's Studio address produced beyond drafts of instructions and skills: each change with its diff and, for a request with many steps, the steps Studio is drafting. -
Read editing by email
MCP
getEmailEditSettingsRead whether editing by email is on, whether personal edit addresses are required, whether the company address may propose any change, how long an email approval window lasts, which changes always need Studio, the company-wide address and how many emails were dropped or refused. -
Read your email approvals
API only
getEmailApprovalsRead whether an email approval window is open for you, until when and on which device, the changes applied inside one in the last 24 hours that you can undo, and what you can approve emailed changes with. -
Undo an emailed change
API only
undoEmailApprovedChangeRestore the version from before a change that an email approval window applied, within 24 hours, as long as nothing changed it since.
Entitlement leases
Keep deployments in a company's own AWS account tied to a current licence: each runtime holds a short signed lease, renewed from the platform, and stops starting new conversations when the lease runs out.
-
List deployment leases
MCP
listOperatorEntitlementDeploymentsList every deployment that holds an entitlement lease, with what billing says about its company, when it last renewed and until when, and whether staff have revoked it. -
Read lease settings
MCP
getOperatorEntitlementLeaseSettingsRead how long a lease lasts, how long new conversations are still admitted after it ends, and the plain message shown when they are refused. -
Register a deployment
API only
registerOperatorEntitlementDeploymentRegister a deployment that runs in a company's own AWS account. -
Renew a deployment's lease
API only
renewEntitlementLeaseA deployed runtime asks for a fresh signed lease. -
Restore a deployment's lease
MCP
restoreOperatorEntitlementLeaseTake a deployment off the revoke list so its next renewal is issued again, provided billing says the company is active. -
Revoke a deployment's lease
MCP
revokeOperatorEntitlementLeaseStop renewing a deployment's lease and add it to the revoke list. -
Set lease settings
MCP
setOperatorEntitlementLeaseSettingsSet the lease length (proposed: 3 days), the grace period (proposed: 24 hours) and the refusal message.
What needs me today
One read of what needs a person's attention across agents and workflows: failed runs, approvals waiting, spend near a limit, work that stalled, channels that stopped delivering and changes not yet published. Counts only, never what anyone said.
-
Read what needs me today
MCP
getFleetHealthRead the list of things that need a person today, grouped by kind, oldest first, with counts per category and which categories are not recorded yet.
Identities
Manage people and places that agents act for.
-
Archive an outside agent
MCP
archiveExternalAgentArchive a manually registered external directory entry. -
Change an outside agent directory owner
MCP
transferExternalAgentOwnerChange the metadata owner of an active manually registered outside agent to a current active non-community company member. -
Change company identity forwarding send setting
MCP
updateCompanyIdentityForwardingSendSettingChange the existing address’s preference without replacing its proof. -
Change personal identity forwarding send setting
MCP
updatePersonalIdentityForwardingSendSettingChange the existing address’s preference without replacing its proof. -
Choose an identity binding's RCS sender
MCP
updateCompanyIdentityBindingRcsAttach an identity RCS registration or return the binding to the agent's shared sender. -
Choose company binding calendars
MCP
updateCompanyIdentityBindingCalendarChoose which already granted calendars narrow this identity binding’s working hours. -
Choose personal binding calendars
MCP
updatePersonalIdentityBindingCalendarChoose which already granted calendars narrow this identity binding’s working hours. -
Commit a company identity import
MCP
commitCompanyIdentityImportWrite reviewed rows as drafts with inbound off, applying explicit update or skip decisions to current company contact matches. -
Create or replace company identity forwarding address
MCP
replaceCompanyIdentityForwardingAddressRandom per-binding addresses choose the reply sender mode. -
Create or replace personal identity forwarding address
MCP
replacePersonalIdentityForwardingAddressRandom per-binding addresses choose the reply sender mode. -
Download the identity import template
MCP
getCompanyIdentityImportTemplateDownload a header-only CSV for company contacts using the current visible sender fields. -
Find who a person is with
MCP
findIdentityTurnFind which identity a person is with in a pool, by one of their proved contact points. -
List agent identities
MCP
listAgentIdentities -
Move a person to another identity
MCP
reassignIdentityTurnMove one person, found by a proved contact point, to another identity bound to this agent. -
Play a prepared identity voice preview
MCP
getIdentityVoicePreviewRead settled private audio after current authority checks; never generates audio. -
Preview a company identity import
MCP
previewCompanyIdentityImportRead CSV or JSON identity rows, apply adjustable header mapping, validate every row and show email, code and phone matches without writing identities or sending mail. -
Preview an identity greeting in a selected voice
MCP
previewIdentityVoiceGenerate or reuse the stored identity greeting with one reviewed xAI voice. -
Preview an identity RCS registration
MCP
previewCompanyIdentityBindingRcsRegistrationPreview the RCS registration builder pre-filled from identity fields. -
Read a company binding address test
MCP
getCompanyIdentityBindingTestTest only the current receiving email, SIP address or attached number of an enabled binding. -
Read a personal binding address test
MCP
getPersonalIdentityBindingTestTest only the current receiving email, SIP address or attached number of an enabled binding. -
Read an agent identity
MCP
getAgentIdentity -
Read an identity binding's RCS sender
MCP
getCompanyIdentityBindingRcsRead the agent-shared or identity-dedicated RCS choice, approval status and identity sign-off. -
Read company binding calendar status
MCP
getCompanyIdentityBindingCalendarRead the calendars selected for this binding and the last successful refresh time. -
Read company identity forwarding addresses
MCP
getCompanyIdentityForwardingAddressesRandom per-binding addresses choose the reply sender mode. -
Read personal binding calendar status
MCP
getPersonalIdentityBindingCalendarRead the calendars selected for this binding and the last successful refresh time. -
Read personal identity forwarding addresses
MCP
getPersonalIdentityForwardingAddressesRandom per-binding addresses choose the reply sender mode. -
Register an outside agent
MCP
registerExternalAgent -
Rename an outside agent
MCP
renameExternalAgentRename an active manually registered external directory entry. -
Report on taking turns
MCP
getIdentityTurnsNew conversations per identity over the last seven days, why each identity got them (its turn, a returning person, the fallback, a switch or a move by hand), open conversations, today's count against its daily cap, and people moved between identities. -
Request a company binding address test
MCP
createCompanyIdentityBindingTestTest only the current receiving email, SIP address or attached number of an enabled binding. -
Request a personal binding address test
MCP
createPersonalIdentityBindingTestTest only the current receiving email, SIP address or attached number of an enabled binding. -
Save the company identity Voice section
MCP
updateCompanyIdentityVoiceSave only voice_settings, preserving the current profile and media. -
Save the personal identity Voice section
MCP
updatePersonalIdentityVoiceSave only voice_settings, preserving the current profile and media. -
Simulate a new conversation
API only
simulateIdentityTurnFixture mode only.
Workflow Identity graphs
Revision-bound storage for the Identity tab’s workflow graph.
-
Read a workflow’s Identity graph
MCP
getIdentityGraphReads the saved graph, or an empty revision-zero graph before the first save. -
Save a workflow’s Identity graph
MCP
updateIdentityGraphStores the complete Identity graph with optimistic concurrency.
Knowledge search consumers
Manage consumer credentials and limits for external knowledge search.
-
Create a knowledge search consumer
MCP
createKnowledgeSearchConsumerManage external search consumer credentials with current scoped read and manage_access plus a fresh second step. -
List knowledge search consumers
MCP
listKnowledgeSearchConsumersManage external search consumer credentials with current scoped read and manage_access plus a fresh second step. -
Read a knowledge search consumer
MCP
getKnowledgeSearchConsumerManage external search consumer credentials with current scoped read and manage_access plus a fresh second step. -
Read knowledge search consumer usage
MCP
getKnowledgeSearchConsumerUsageRead settled retrieval cost attributed to original requests in the current UTC day and outstanding reservations for one consumer, with its current daily cap and available budget. -
Revoke a knowledge search consumer
MCP
revokeKnowledgeSearchConsumerManage external search consumer credentials with current scoped read and manage_access plus a fresh second step. -
Rotate a knowledge search consumer
MCP
rotateKnowledgeSearchConsumerManage external search consumer credentials with current scoped read and manage_access plus a fresh second step.
Knowledge search document approvals
Approve checked uploaded documents for external search within the base ceiling.
-
Read a document search approval
MCP
getKnowledgeSearchDocumentManage explicit external release approval for a checked uploaded document. -
Replace a document search approval
MCP
replaceKnowledgeSearchDocumentManage explicit external release approval for a checked uploaded document.
Knowledge search base policy
Manage the explicit base ceiling; public search and per-document approval remain separate.
-
Read a knowledge search policy
MCP
getKnowledgeSearchPolicyRead or replace the base ceiling for external knowledge search. -
Replace a knowledge search policy
MCP
replaceKnowledgeSearchPolicyRead or replace the base ceiling for external knowledge search.
Knowledge
Inspect knowledge bases, their sources and synchronization progress.
-
Ask about documents
MCP
askAboutDocumentsAsk one registered yes/no or pick-one question about referenced items without loading their content into the agent context. -
List knowledge bases
MCP
listKnowledgeBaseList knowledge bases and their source summaries. -
List knowledge sources
MCP
listKnowledgeSourceList sources configured for a knowledge base. -
List knowledge syncs
MCP
listKnowledgeSyncsRead recorded synchronization attempts for a knowledge base. -
Read a knowledge base
MCP
getKnowledgeBaseInspect a knowledge base's configuration, source counts and revision. -
Read a knowledge source
MCP
getKnowledgeSourceInspect a source's location, schedule, tags and current state.
Pause at a limit
When a step's turn reaches one of its limits (rounds, tool calls, time, tokens or spend), the run waits for a person to carry on or stop instead of failing.
-
Continue or stop a step at its limit
MCP
decideLimitPauseLet a paused step carry on from where it stopped with more of the limit it reached, or stop the run here. -
List steps waiting at a limit
MCP
listLimitPausesList workflow steps whose turn stopped at a limit and are waiting for someone to continue or stop: which step, which limit, what it used, and how much more is allowed. -
Read one step waiting at a limit
MCP
getLimitPauseRead one paused step: the limit it reached, what it used so far, the most that can be added, and the decision once there is one.
Link filter previews
Try typed link conditions without storing sample data.
-
Try a link filter
MCP
previewLinkFilterEvaluate typed AND rules and OR groups against caller-owned JSON at the current saved workflow revision.
Look components
Keep reusable typed Look slots once and copy them into any Look.
-
Change a Look component's draft
MCP
updateLookComponentChanges the component's name, description, category or slot fields. -
Create a Look component
MCP
createLookComponentCreates a draft component holding one typed Look slot in a skill category. -
List look components
MCP
listLookComponentsLists the reusable Look components (palettes, grain, grades, lighting, lenses, composition, medium, mood and subject settings) in skill categories the caller can read, with their published versions and the Looks that use them. -
Publish a Look component version
MCP
publishLookComponentPublishes the current draft as the next immutable version, which Looks can then copy. -
Read a Look component
MCP
getLookComponentReads one component with its draft slot, published versions and the Looks that use them. -
Retire a Look component
MCP
retireLookComponentRetires the component: it stays readable with its versions, is no longer offered for copying and cannot be changed or published again.
MCP access tags
Tag agents and workflows and grant tags to people, teams, access keys and apps, from Settings > Access tags. Tags decide who may list and call them over MCP.
-
Change MCP access tags
MCP
updateMcpAccessTagsReplace the access tags, grants and tagged agents and workflows using the current revision. -
Read MCP access tags
MCP
getMcpAccessTagsRead the company's access tags, the grants that give them to people, teams, access keys and apps, and which agents and workflows carry them. -
Read who MCP access tags let in
MCP
getMcpAccessMapEach access tag with the agents and workflows that carry it and the grants that hold it.
Agents and workflows over MCP
Let people's assistants (Claude, ChatGPT) and automation tools talk to one agent, or start one workflow, over MCP. Each is off until switched on, and each gets its own address on the company's host.
-
Change a workflow's MCP address
MCP
updatePipelineMcpStartSwitch the workflow's MCP address on or off, choose who may connect, the apps allowed after sign-in, and which identities get their own address. -
Change an agent's MCP address
MCP
updateAgentMcpEndpointSwitch the agent's MCP address on or off, choose who may connect, the apps allowed after sign-in, and which identities get their own address. -
Disconnect a client
MCP
revokeAgentMcpClientDisconnect one client of the agent's MCP address: its key or sign-in stops working at once. -
Disconnect a client
MCP
revokePipelineMcpClientDisconnect one client of the workflow's MCP address: its key or sign-in stops working at once. -
Give a client an access key
MCP
createAgentMcpKeyCreate an access key (an API token) for one named client of the agent's MCP address, such as a company automation tool or server that connects with an address and a Bearer token and cannot sign in. -
Give a client an access key
MCP
createPipelineMcpKeyCreate an access key (an API token) for one named client of the workflow's MCP address, such as a company automation tool or server that connects with an address and a Bearer token and cannot sign in. -
Read a workflow's MCP address
MCP
getPipelineMcpStartRead whether this workflow can be reached as an MCP server, off by default: its address on the company's own host, who may connect (anyone, signed-in people, or chosen clients), the tool assistants see (run_<workflow> with the workflow's declared start fields (fixed and mapped-in values cannot be set), plus get_run and cancel_run; runs are in the background and get_run returns the status, the current step, 'waiting for approval' and the result in the workflow's declared output shape), each identity's own address, and the connected clients. -
Read an agent's MCP address
MCP
getAgentMcpEndpointRead whether this agent can be reached as an MCP server, off by default: its address on the company's own host, who may connect (anyone, signed-in people, or chosen clients), the tool assistants see (one tool, ask_<agent>, that takes a message and an optional conversation_id and returns the reply and the conversation_id for follow-ups), each identity's own address, and the connected clients. -
Replace a client's access key
MCP
rotateAgentMcpKeyGive one client of the agent's MCP address a new access key, shown once. -
Replace a client's access key
MCP
rotatePipelineMcpKeyGive one client of the workflow's MCP address a new access key, shown once. -
Replace a workflow's MCP address
MCP
rotatePipelineMcpAddressGive the workflow's main address, or one identity's address, a new unguessable part. -
Replace an agent's MCP address
MCP
rotateAgentMcpAddressGive the agent's main address, or one identity's address, a new unguessable part. -
Review a request to connect to an agent
API only
reviewAgentMcpConsentCheck an app's request to talk to one agent or workflow as the signed-in person, before they allow it: the app, where it returns, the company and the agent or workflow, and the identity when the address names one.
Model catalog
Browse every model the platform can offer, see where each one runs and whether it may keep data, and allow the ones a company wants. Nothing is usable until the company allows it.
-
Browse the model catalog
MCP
listModelCatalogBrowse the models that can be offered to the company, searchable and filterable, one page at a time. -
Read what changed in the model catalog
MCP
listModelCatalogChangesRead the most recent reads of the model catalog, newest first, with what each one changed: new models, retired models, price changes and models that gained or lost a zero-retention endpoint.
Model controls
Pause model calls and set the run ceilings every new run starts with, from the operator console.
-
Force or release the decisions fallback
MCP
setOperatorDecisionFallbackSkip jev everywhere and use each job's fallback, or go back to jev. -
Pause or resume model calls
MCP
setOperatorModelCallSwitchPause or resume model calls for everyone, one provider, one company or one agent. -
Read decision provider health
MCP
getOperatorDecisionHealthRead each decisions provider's health (jev, OpenAI Decisions, the model judge): whether its circuit breaker is closed, open or probing, recent failures and latency, and whether the fallback is forced. -
Read model-call switches and run ceilings
MCP
getOperatorModelControlsRead every model-call pause switch that has been set, the providers that can be paused, and the run ceilings new runs start with. -
Set run ceilings
MCP
setOperatorRunCeilingsSet the turns, tool calls, tokens per turn, time and delegation depth each new run may use, up to this deployment's maximum.
Model tiers
Fast, Balanced and Best: three named levels of thinking with a relative cost, so people choose how much to spend without needing to know model names.
-
Read the model tiers
MCP
getModelTiersRead Fast, Balanced and Best: what each is for, how much it costs next to Fast, and the model behind it.
Billing lifecycle
Set the billing lifecycle rules (late payment, trial, the end-user message and whether the timer enforces them), watch every company's standing, issue and correct invoices, and override an account's state.
-
Change a company's terms
MCP
updateOperatorCompanyBillingSet one company's plan, whether it pays after the month (postpaid) or ahead (prepaid), the days it has to pay an invoice, and any exceptions to the late-payment rules, such as a longer grace for an enterprise. -
Change the billing lifecycle settings
MCP
updateOperatorBillingSettingsChange when a late company is restricted, suspended, cancelled and purged, the card retry days, the trial length, how new companies pay, the days to pay an invoice, the message end users read while assistants are unavailable, and whether the timer enforces any of it. -
Correct an invoice
MCP
adjustOperatorInvoiceAdd a credit or an extra charge to an issued invoice, with a description the company sees and a reason it does not. -
Issue a month's invoice
MCP
issueOperatorInvoiceRate a finished month of measured usage at cost plus the markup in force and issue the invoice, once. -
Move a company to another state
MCP
setOperatorCompanyLifecycleMove a company to any state except purged, with a reason, and optionally hold automatic changes for a number of days so the timer does not undo it. -
Read one company's billing
MCP
getOperatorCompanyBillingRead one company's account, lifecycle, contacts, wallet, invoices with cost and markup, and the log of state changes, including steps that were only reported because enforcement is off. -
Read the billing lifecycle
MCP
getOperatorBillingRead the billing lifecycle settings (the days before a late company is restricted, suspended, cancelled and purged, the card retry days, the trial length, the message end users read and whether enforcement is on), the billing provider's state, and every company's state with what it owes. -
Run the billing timer
MCP
evaluateOperatorBillingRun the late-payment timer for one company or all: retry failed cards, add automatic top-ups, and decide whether each account moves a step.
Operator connector inventory
Staff-only reviewed package inventory. Mapping, live qualification, hosted installation and connected accounts are separate facts.
-
List operator connector inventory
MCP
listOperatorConnectorPackagesRead reviewed connector mappings, versions and qualification in the staff Console.
Partners
Manage consented partner access to client companies.
-
Accept a partner invitation
MCP
acceptPartnerInvitationAccept a pending partner invitation as a client administrator. -
Add a sub-company
MCP
createSubCompanyCreate a new company linked to this one as its canonical parent. -
Add partner staff
MCP
invitePartnerStaffAdd an existing active member of the partner company as partner staff. -
Approve a client’s usage markup, display and service lines
MCP
updateClientUsageTerms -
Approve a partner account
MCP
approvePartnerAccount -
Assign staff to a client
MCP
assignPartnerStaffAssign active staff to a consented client. -
Change a partner staff role
MCP
updatePartnerStaffRole -
Create a partner account
MCP
createPartnerAccountCreate a staff-approved partner account. -
Export authorized child usage by person
MCP
exportPartnerOwnerUsageExport company-qualified saved-owner usage for exactly the child reports admitted by current partner administrator and Billing authority. -
Export monthly client usage and margin
MCP
exportPartnerClientSummaries -
Hand your sign-in to a company you can open
API only
createCompanyHandoffMake a one-time, 60-second hand-off for a company in your switcher, bound to that company's registered Studio address. -
Invite a partner to a client
MCP
createPartnerInvitationCreate a consent invitation from a partner to a client company. -
List client assignments
MCP
listPartnerAssignments -
List companies you can open
MCP
listMySwitchableCompaniesList the open partner console and open clients you are currently assigned to, at their registered Studio addresses. -
List partner clients
MCP
listPartnerClientsList client companies linked to a partner. -
List partner people in this company
MCP
listCompanyPartnerStaffShow assigned partner people with the partner marker, effective role permissions and client-owned exclusion revision. -
List partner staff
MCP
listPartnerStaff -
List partners with client access
MCP
listCompanyPartnerAccessShow client administrators which partners can act in this company. -
Read a client’s agreed usage and support terms
MCP
getClientUsageTerms -
Read monthly client usage and margin
MCP
listPartnerClientSummaries -
Read this company’s usage at its partner’s prices
MCP
getCompanyUsageReport -
Remove a client assignment
MCP
removePartnerAssignment -
Remove a partner person from this company
MCP
removeCompanyPartnerStaffRecord a durable client-owned exclusion for one partner person. -
Remove partner staff
MCP
removePartnerStaff -
Revoke partner access
MCP
revokePartnerAccessRevoke a partner's delegated access in the current client company.
Pricing
Set the markup the operator adds to measured cost, and see cost, markup and margin per company.
-
Confirm a markup change
MCP
confirmOperatorMarkupChangeConfirm a markup change another member of staff proposed. -
Export cost, markup and margin
MCP
exportOperatorPricingMarginsExport each company's cost, markup, price and margin for a month as CSV. -
Propose a markup change
MCP
proposeOperatorMarkupChangePropose a markup percentage for the default, a company or a partner, from a chosen date forward. -
Read cost, markup and margin
MCP
getOperatorPricingMarginsRead each company's measured cost, markup, price and margin for a month, priced with the markup in force when each unit was measured. -
Read pricing
MCP
getOperatorPricingRead the default markup, each company's and partner's markup in force, every dated change and the lines that are off. -
Set how a company sees its price
MCP
setOperatorCompanyPriceDisplayChoose whether a company's billing shows cost and markup separately (itemised) or only its price (combined). -
Withdraw a markup change
MCP
withdrawOperatorMarkupChangeWithdraw a markup change that is still waiting for confirmation.
Remote agent receivers
Manage receiver metadata and one-time signing keys. Remote publication dispatch is not started by receiver setup.
-
Create a remote agent receiver
MCP
createRemoteAgentReceiverManage an immutable HTTPS receiver for one agent in the host-selected environment. -
List remote agent receivers
MCP
listRemoteAgentReceiversList receiver metadata for this agent in the host-selected environment. -
Queue a selected published version for a remote agent
MCP
publishRemoteAgentVersionQueue selected immutable published root instructions, bound skills and approved checked-upload knowledge for an active receiver. -
Read a remote agent receiver
MCP
getRemoteAgentReceiverManage an immutable HTTPS receiver for one agent in the host-selected environment. -
Read remote agent publication delivery
MCP
getRemoteAgentDeliveryRead durable publication delivery metadata for a receiver in the host-selected environment. -
Read saved remote publication selection
MCP
getRemoteAgentPublicationSettingsRead the host-environment saved receiver and explicit section/skill IDs and knowledge-document references for direct ordinary Publish. -
Refresh a remote agent checkpoint
MCP
refreshRemoteAgentCheckpointExplicitly refresh signed checkpoint evidence for the current selected publication. -
Retry a failed remote publication
MCP
retryRemoteAgentDeliveryRequeue the exact failed plan for one additional attempt, with ten lifetime attempts maximum. -
Revoke a remote agent receiver
MCP
revokeRemoteAgentReceiverManage an immutable HTTPS receiver for one agent in the host-selected environment. -
Rotate a remote receiver signing key
MCP
rotateRemoteAgentReceiverManage an immutable HTTPS receiver for one agent in the host-selected environment. -
Save remote publication selection
MCP
updateRemoteAgentPublicationSettingsSave explicit receiver, section/skill IDs and knowledge-document references for direct ordinary Publish in dev.
Tools, knowledge and workflow authoring
Configure reusable skills, tools, connections, knowledge, storage, workflows and reports.
-
Add a starter skill
MCP
installSkillTemplateAdds one starter skill to the company as a new, ordinary skill: its name, description, instructions and three examples of a good answer are the company's to edit from then on. -
Adds a connection to another MCP server
MCP
createRemoteMcpConnectionAdds a connection to another MCP server at an https address. -
Adds a source to a knowledge base
MCP
createKnowledgeSource -
Adds a storage connection
MCP
createStorageConnection -
Adds a webhook to a workflow
MCP
createPipelineWebhook -
Adds something that starts a workflow
MCP
createPipelineTrigger -
Archive a workflow
MCP
archivePipelineArchive a workflow you no longer use. -
Cancel report schedule
MCP
cancelReportSchedule -
Changes a company skill's draft
MCP
updateCompanySkill -
Changes a company tool
MCP
updateCompanyTool -
Changes a connection to another MCP server
MCP
updateRemoteMcpConnection -
Changes a file store
MCP
updateFileStore -
Changes a knowledge base
MCP
updateKnowledgeBase -
Changes a knowledge source
MCP
updateKnowledgeSource -
Changes a storage connection
MCP
updateStorageConnection -
Changes a workflow webhook
MCP
updatePipelineWebhook -
Changes the company's settings for the get file tool
MCP
updateGetFileSettings -
Changes the company's settings for the list files tool
MCP
updateListFilesSettings -
Changes the company's settings for the save file tool
MCP
updateSaveFileSettings -
Changes the skills an agent uses and when it uses them
MCP
updateAgentSkills -
Changes which tools a message key may use
MCP
updateMessageKeyToolGrants -
Check a skill's wording
MCP
checkCompanySkillRuns the skill checks over a draft: a clear name, a description that says what the skill does and when to use it, a sensible length, no stale dates, one word for one thing, one way to do it, an example of a good answer, no keys or passwords, and no files the agent cannot open. -
Check twilio connection
MCP
checkTwilioConnection -
Checks that a storage connection works
MCP
checkStorageConnection -
Connect connector preset
MCP
connectConnectorPreset -
Create falcon code repository
MCP
createFalconCodeRepository -
Create report schedule
MCP
createReportSchedule -
Create send grid connection
MCP
createSendGridConnection -
Create twilio connection
MCP
createTwilioConnection -
Creates a company skill
MCP
createCompanySkill -
Creates a file store
MCP
createFileStore -
Creates a knowledge base
MCP
createKnowledgeBase -
Creates a link to a stored file
MCP
createFileLink -
Creates a new company skill and adds it to an agent in one step
MCP
createAndBindAgentSkill -
Defines a new company tool
MCP
createCompanyTool -
Delete a company skill
MCP
deleteCompanySkillDelete a skill from the company library. -
Delete a knowledge base
MCP
deleteKnowledgeBaseDelete a knowledge base with its documents and search index. -
Delete a workflow
MCP
deletePipelineDelete a workflow for good. -
Delete selected unused workflow drafts
MCP
deleteUnusedPipelineDraftsAtomically remove one to twenty selected never-published workflow drafts with no runs. -
Disconnect remote connector
MCP
disconnectRemoteConnector -
Export report
MCP
exportReport -
Get agent daily cost cap
MCP
getAgentDailyCostCap -
Get agent skill derivation
MCP
getAgentSkillDerivation -
Get cost report
MCP
getCostReport -
Get report schedules
MCP
getReportSchedules -
Get workflow event example
MCP
getPipelineEventExample -
Get workflow raise example
MCP
getPipelineRaiseExample -
Get workflow report
MCP
getPipelineReport -
Get workflow version
MCP
getPipelineVersion -
List knowledge base choices
MCP
listKnowledgeBaseChoices -
List the starter skills a company can add
MCP
listSkillTemplatesLists the 14 starter skills, each with what it does, when it is used, the category it is filed under and how many examples of a good answer it carries. -
List workflows available to run now
MCP
listRunNowWorkflowsRead names and manual-start buttons from installed Dev versions using current manual-start grants. -
Lists a workflow's webhooks
MCP
listPipelineWebhooks -
Lists the company's skills
MCP
listCompanySkills -
Lists the company's workflows
MCP
listPipelines -
Lists the knowledge bases a connection can reach, so you can add them
MCP
discoverKnowledgeBases -
Lists the tools and knowledge searches you can add to an agent
MCP
listToolCatalog -
Lists what starts a workflow
MCP
listPipelineTriggers -
Makes a copy of a company skill
MCP
duplicateCompanySkill -
Moves a company tool through review and release: submit it for review, approve it, publish it or retire it
MCP
actOnTool -
Publishes a skill's draft as a new version
MCP
publishCompanySkill -
Put tool webhook signing
MCP
putToolWebhookSigning -
Put twilio connection
MCP
putTwilioConnection -
Reads a skill's published versions and whether its draft is ready to publish
MCP
getCompanySkillPublication -
Reads one company skill
MCP
getCompanySkill -
Refresh the connected-app catalogue
MCP
refreshToolCatalogRefresh reviewed connected-app metadata for the current company. -
Reschedule workflow run
MCP
reschedulePipelineRun -
Resolve tool ui action
MCP
resolveToolUiAction -
Restore an archived workflow to a draft
MCP
unarchivePipelineRestore an archived workflow to an unpublished draft. -
Restores an older workflow version as the draft. To change Live, make an older version live instead
MCP
rollbackPipelineRestores an older workflow version as the draft. -
Retry workflow run
MCP
retryPipelineRun -
Runnow workflow run
MCP
runnowPipelineRun -
Runs a test call of a company tool. Repeat the same call with the same idempotency key to read its result
MCP
testCompanyToolRuns a test call of a company tool. -
Select connector tools
MCP
selectConnectorTools -
Shows the tool a workflow's agents use to report the exceptions the workflow declares
MCP
getPipelineExceptionTool -
Starts syncing a knowledge base from its sources
MCP
startKnowledgeSync -
Stop a workflow run
MCP
cancelPipelineRunStop a run of this workflow. -
Test knowledge search
MCP
testKnowledgeSearch -
Test send grid connection
MCP
testSendGridConnection -
Test workflow
MCP
testPipeline -
Unpublish a workflow
MCP
unpublishPipelineStop new starts and return an editable unpublished draft. -
Update agent skill derivation
MCP
updateAgentSkillDerivation -
Update company messaging rules
MCP
updateCompanyMessagingRules -
Update company webhook endpoint
MCP
updateCompanyWebhookEndpoint -
Update falcon code repository
MCP
updateFalconCodeRepository -
Update report schedule
MCP
updateReportSchedule -
Update send grid connection
MCP
updateSendGridConnection -
Update step tool settings
MCP
updateStepToolSettings -
Update tool implementation choice
MCP
updateToolImplementationChoice -
Update tool sign-in
MCP
updateToolSignInEnroll an advanced own-account bearer-token or API-key reference, with optional additional header references, on a fresh tool connection, or retire its existing enrollment with kind none.
Run label index
Make run labels kept before the label index existed findable in a workflow's run search, from the operator console.
-
Index older run labels
MCP
backfillOperatorRunLabelIndexIndex one company's run labels that were kept before the label index existed, so run search finds them.
Service callbacks and client transport
Receive authenticated callbacks and exchange conversation and workflow data.
-
Accept a signed guest invitation
API only
acceptPublicGuestInvitationAccept a single-use signed invitation proof without Studio sign-in. -
Accept a signed tool event
API only
acceptToolCallEventMessage-key grants default empty. -
Add an agenda item from a company server
API only
addPersonAgendaNot available yet. -
Follow a run's events
API only
getRunStreamEventsRead one run's events as server-sent events with its stream token in the Authorization header. -
Get a reply stream ticket
API only
createClientStreamTicketExchange the session Bearer, sent in the Authorization header, for a ticket that opens this session's reply stream once. -
List a person’s agenda
MCP
listPersonAgendaRead the agenda items for the referenced person under current conversation-read permission. -
Mint a stream token for a run
API only
mintRunStreamTokenMint a fresh read-only stream token for a run this API way in started, for example after the first one expired. -
Prepare a conversation upload
API only
createClientUploadSynthetic client exchange. -
Raise a signed workflow exception
API only
raisePipelineExceptionNot available yet. -
Read a private company theme PNG
MCP
getCompanyThemeAssetRead an authorized company theme asset as PNG bytes. -
Read a streamed run's final text
API only
getRunResultRead the screened final text of a run that streams, with the API way in's server key or the run's stream token. -
Read a voice session
API only
getVoiceSessionRead a voice session started with this client session Bearer: whether it is ready, live or ended, why it ended, its length limit and the seconds used so far. -
Read a workflow run by its server reference
MCP
fetchPipelineRunRead a workflow run within the caller’s permitted scope. -
Read conversation events
API only
getClientEventsDeprecated: the session value in this path can reach load balancer and CDN access logs. -
Read the reply stream with a ticket
API only
getClientStreamRead a client session's replies as server-sent events, opened with a ticket from createClientStreamTicket. -
Receive a tool completion callback
API only
receiveToolWebhookCallbackBound to tenant, waiting call/version and output schema. -
Start talking in a chat session
API only
startVoiceSessionStart voice in the conversation a client session Bearer names: the public widget, a public link, or a session your own server exchanged for a person with its message key. -
Stop a run with its stream token or server key
API only
stopRunByStreamTokenAsk the run this stream token belongs to (or that this API way in's server key started) to stop. -
Stop talking
API only
endVoiceSessionEnd a voice session started with this client session Bearer. -
Upload conversation content
API only
putClientUploadSynthetic client exchange.
Skill sections
Canonical skill permission rows and their saved draft fields. Metadata does not grant access.
-
List canonical skill sections
MCP
listCompanySkillSectionsReturn stable section ids, display names and the CompanySkillWrite fields in each section.
Company Slack app creation
Explicit administrator setup with a temporary configuration token.
-
Create the company Slack app
MCP
createCompanySlackAppCreates an app from saved company display settings and checked callback URLs using a temporary configuration token, then sets the bundled square icon from the company-hosted static asset.
Company Slack setup
Create a company-owned app, check its bot token and preview or explicitly send a test message.
-
Check the company app bot token
MCP
checkCompanySlackConnectionChecks the bot token with auth.test and bots.info and replaces an encrypted setup candidate in the current company and environment. -
Connect the company Slack app
MCP
connectCompanySlackChecks a bot token using auth.test and bots.info, then atomically stores a company-owned encrypted native connection and fills Slack settings from the observation. -
Discard the staged company app credentials
MCP
discardCompanySlackSetupCandidateErases the encrypted setup candidate after checking the current settings revision and candidate generation. -
Enroll the company Slack personas
MCP
putCompanySlackPersonaEnrollmentExplicitly replaces the complete enrolled roster using exact saved way-in revisions and the current native installation, signed-event evidence and bot scopes. -
List the company Slack app connection
MCP
listCompanySlackNativeConnectionsReturns at most one current company-native Slack connection with historical checked workspace and app details, without decrypting credentials. -
Preview or send a company app test message
MCP
sendCompanySlackTestMessageIn Test mode returns a local preview without provider calls. -
Read company app setup status
MCP
getCompanySlackSetupStatusReads setup metadata in this company and environment. -
Read the company app manifest
MCP
getCompanySlackAppManifestReturns a Slack app creation manifest with a neutral default name. -
Read the saved Slack persona roster
MCP
getCompanySlackPersonaEnrollmentReads the saved enrollment revision and roster for the selected native company app. -
Search the company Slack directory
MCP
searchCompanySlackDirectoryLists one provider page visible to the selected company app, filtered by name or id.
Provisioned Slack ways in
Read and edit company-owned Slack ways in, including explicit app mode and paused persona configuration.
-
Change a provisioned Slack way in
MCP
updatePipelineSlackWayInChanges a saved Slack way in using its quoted If-Match revision. -
Create a Slack way in with defaults
MCP
createPipelineSlackWayInCreates a shared-app Slack way in from the workflow name, with a unique slug keyword (collisions and reserved words gain -2, -3, and so on), any channel and keyword-directed DMs. -
List provisioned Slack ways in
MCP
listPipelineSlackWaysInLists provisioned Slack ways in with current mode, optional handle, persona draft and read-only company-settings binding; legacy modes read as separate_app. -
Undo a newly added Slack way in
MCP
undoPipelineSlackWayInRemoves an unchanged way in created with defaults within ten seconds.
Storage ways in
Company-scoped dev workflow storage configuration.
-
List storage way in uses
MCP
listStorageWayInUsesLists current workflow storage configurations that reference this company folder. -
Read storage ways in
MCP
getStorageWaysInReads storage-way-in configuration and its revision. -
Save storage ways in
MCP
updateStorageWaysInStores the complete storage-way-in configuration with optimistic concurrency.
Storage
Inspect file stores, storage configuration and file-tool examples.
-
List file expiry folders
MCP
listExpiryFoldersInspect configured expiry folders and retention rules. -
List file stores
MCP
listFileStoreList the company's file stores and their connection assignments. -
List storage connections
MCP
listStorageConnectionList configured storage connections and their readiness. -
Read a file move job
MCP
getFileMoveJobInspect an existing file move job's progress. -
Read a file store
MCP
getFileStoreRead a file store's location, settings and revision. -
Read a file-listing example
MCP
getListFilesExampleInspect example file-listing arguments and results. -
Read a file-reading example
MCP
getReadFileExampleInspect example file-reading arguments and results. -
Read a save-file example
MCP
getSaveFileExampleInspect example save-file arguments and results. -
Read a storage connection
MCP
getStorageConnectionInspect a storage connection's configuration and security status. -
Read a storage policy
MCP
getStoragePolicyRead the required storage policy for a selected connection. -
Read get-file tool settings
MCP
getGetFileSettingsInspect the get-file tool's configured access and defaults. -
Read list-files tool settings
MCP
getListFilesSettingsInspect the list-files tool's configured scope and defaults. -
Read save-file tool settings
MCP
getSaveFileSettingsInspect destination and file-handling settings.
Stored keys
Company-owned write-only HTTP keys, scoped to workflows and environments.
-
Create a stored key
MCP
createStoredKey -
List stored key names
MCP
listStoredKeys -
Remove a stored key
MCP
removeStoredKey -
Update or rotate a stored key
MCP
updateStoredKey
Studio address and custom domain
Each company has one Studio address. Read it, ask to move it to a domain the company owns, prove the domain with a DNS record, and remove the domain again.
-
Ask to move Studio to a custom domain
MCP
setCompanyStudioDomainName a domain the company owns for its Studio and get the TXT record that proves it. -
Check the custom domain's DNS record
MCP
checkCompanyStudioDomainLook for the TXT record now. -
Read the company's Studio address
MCP
getCompanyStudioAddressRead where the company's Studio answers, and any custom domain it is moving to with the DNS records still needed. -
Remove the custom domain
MCP
removeCompanyStudioDomainDrop a custom domain request, or stop using a custom domain in use; the company's Studio then answers at its subdomain again and people sign in there.
Speak a request to Ask Studio
A microphone in Ask Studio turns what a person says into text they read and change before they send it. Nothing is sent from the recording.
-
Turn a spoken request into text
API only
dictateStudioAssistantRequestSend a short recording (a WAV file, up to the stated length) and get back what was said as text. -
Whether the microphone in Ask Studio is available
API only
getStudioAssistantDictationSay whether speaking a request is switched on here, and the longest recording that is turned into words.
Ask Studio conversation history
Find and manage your own private conversations.
-
Deletes your Ask Studio conversation
MCP
deleteStudioAssistantSession -
Lists your Ask Studio conversations
MCP
listStudioAssistantSessions -
Renames your Ask Studio conversation
MCP
updateStudioAssistantSessionTitle
Ask Studio and MCP usage
See what Ask Studio and connected MCP clients cost this month, per person, per client and per operation, and set the company's monthly caps and kill switch.
-
Change Ask Studio and MCP limits
MCP
updateStudioUsageLimitsSet each person's and each connected client's monthly cap for Ask Studio and MCP calls, or turn the kill switch on or off. -
Create a background usage export
MCP
createOwnerUsageExportJobCreate an immutable background Excel or CSV export of the usage you may currently see, with the same company/self, current-team, date, model and resource filters as the usage report. -
Download a verified usage export chunk
MCP
getOwnerUsageExportChunkRead only an existing export created for you in the current company. -
Export usage by saved owner
MCP
exportOwnerUsageExport measured saved-owner usage as Excel or CSV with the same company/self, month, model and paired UTC date filters as the report. -
Read Studio and owner-attributed usage
MCP
getStudioUsageRead the month's Studio assistant and MCP lines plus measured usage by saved owner in the caller's company or self scope. -
Read your saved usage export status
MCP
getOwnerUsageExportJobRead only an existing export created for you in the current company.
Switchboard rule previews
Test deterministic route rules against supplied samples.
-
Preview Switchboard rules
MCP
previewSwitchboardRoutesEvaluate supplied unsaved Switchboard rules at a current saved workflow step against a bounded caller-supplied sample.
The Switchboard step
A workflow step that sends each item down the right path by one typed question, decided from data already in the run. It asks nobody anything. The question is yes or no, pick one from a closed list, or a score with bands, written by the company's authors. Its examples are run through the question, and a workflow with a Switchboard cannot be published until every example lands on the route it was written for.
-
Read how each Switchboard step's examples did
MCP
getSwitchboardEvaluationsFor every Switchboard step in a workflow's draft: whether its examples have been run, whether they passed for the question as it stands now, and which examples went to a different route. -
Run a Switchboard step's examples
MCP
evaluateSwitchboardRun every example of one Switchboard step through its question and record whether each landed on the route it was written for.
Task lists
Read generic company task lists and task history. Hosted reads require task erasure and company-closure jobs.
-
Continue a task after an Agenda outcome
MCP
continueListTaskWaitApply an already saved Agenda answer or configured stuck outcome to its exact waiting task. -
Create a task
MCP
createListTaskCreate a list or task with a server-generated identifier and revision 1. -
Create a task list
MCP
createTaskListCreate a list or task with a server-generated identifier and revision 1. -
Create starter task lists
MCP
ensureTaskListStartersExplicitly create Employee tasks and Coding tasks once. -
Delete a task
MCP
deleteListTaskDelete at the quoted current If-Match revision without a body. -
Delete an empty task list
MCP
deleteTaskListDelete at the quoted current If-Match revision without a body. -
List task lists
MCP
listTaskListsRead current task-list data in the host-selected company and environment. -
List tasks in a task list
MCP
listListTasksRead current task-list data in the host-selected company and environment. -
Read a task
MCP
getListTaskRead a task and its latest saved Agenda answer, when present. -
Read a task list
MCP
getTaskListRead current task-list data in the host-selected company and environment. -
Read task history
MCP
listListTaskHistoryRead current task-list data in the host-selected company and environment. -
Update a task
MCP
updateListTaskReplace the list definition or task fields at the quoted current revision. -
Update a task list
MCP
updateTaskListReplace the list definition or task fields at the quoted current revision. -
Wait on a person for a task
MCP
waitOnListTaskAdmit an Agenda question and move a task to Waiting atomically.
Team directory
Sync the Team list from the company's own directory: Microsoft Entra ID, Google Workspace or a SCIM provider.
-
Connect a team directory
MCP
connectTeamDirectoryConnects the company's own directory: Microsoft Entra ID or Google Workspace after an admin grants read-only consent, or a SCIM provider that pushes changes. -
Disconnect the team directory
MCP
disconnectTeamDirectoryDisconnects the directory and stops its SCIM token. -
List people from the team directory
MCP
listTeamDirectoryPeopleLists everyone the directory brought, former people included, with their status, groups, job title and manager, which directory they came from, whether they still sync, and what was paused when they were suspended or removed. -
Read the team directory
MCP
getTeamDirectoryReads the company's connected work directory: which one, when it last synced, how many people are active, suspended or former, the SCIM address (the token is never shown again), whether scheduled sync runs, and recent notices about people who were suspended or removed. -
Replace the SCIM token
MCP
rotateTeamDirectoryTokenMakes a new SCIM token, shown only this once, and stops the old one at once. -
Sync the team directory now
MCP
syncTeamDirectoryReads changes from Microsoft Entra ID or Google Workspace now.
Microsoft Teams
Connect Microsoft Teams as a company channel. Studio stores the app id, directory id, and bot id, and checks each incoming message before anything else. Studio does not create the Teams app and does not store its secret.
-
Read the company's Teams channel
MCP
getCompanyTeamsChannelRead whether Microsoft Teams is not set up, ready to receive, or paused, the saved app id, directory id, and bot id, the messaging address, and the setup steps. -
Save the company's Teams channel
MCP
updateCompanyTeamsChannelSave the app id, directory id, and bot id together, and whether receiving is on.
Register template versions
Bind update notes to immutable agent publications in the template owner company.
-
Read registered template version metadata
MCP
getAgentTemplateVersionCompany administrator with current agent read access. -
Register an immutable agent publication as a template version
MCP
registerAgentTemplateVersionCompany administrator with current agent read access and Publish permission. -
Withdraw a registered template version
MCP
withdrawAgentTemplateVersionRecord irreversible owner-side withdrawal with a reason.
Tools
Inspect tool definitions, safeguards, task progress and integration examples.
-
Ask one question across GitHub files
MCP
askGithubFilesAsk one registered question over bounded GitHub file items at an immutable commit. -
Find relevant github files
MCP
findRelevantGithubFilesRank relevant files in a connected GitHub repository at an immutable commit without returning repository content. -
List built-in tool definitions
MCP
listBuiltInToolDefinitionsInspect the built-in tool kinds and their configuration fields. -
List company tools
MCP
listCompanyToolList tool definitions, safeguards and publication state. -
List connected code repositories
MCP
listFalconCodeRepositoryList the connected repositories available for code tools. -
List remote mcp connections
MCP
listRemoteMcpConnectionsList configured remote MCP connections and their status. -
List tool implementation choices
MCP
listToolImplementationChoicesCompare the available backend kinds. -
List tool interface action kinds
MCP
listToolUiActionKindsInspect the supported interface action kinds. -
Read a background task
MCP
getBackgroundTaskRead an existing task's progress and result using its task identifier. -
Read a background task event example
MCP
getBackgroundTaskEventExampleInspect a task progress event's shape. -
Read a company tool
MCP
getCompanyToolRead a tool's input and output shapes, backend, safeguards and current revision. -
Read a connected code repository
MCP
getFalconCodeRepositoryInspect a connected repository's configuration and state. -
Read a recorded tool call
MCP
getToolCallRecordRead the status and permitted result of an existing tool call using its call identifier. -
Read a remote MCP connection
MCP
getRemoteMcpConnectionRead a configured remote MCP connection and its status. -
Read a tool completion event example
MCP
getToolEventBridgeCompletionExampleInspect the completion event format for a tool that finishes asynchronously. -
Read a tool interface action example
MCP
getToolUiActionExampleRead an example of a tool result that requests an interface action. -
Read a tool webhook callback example
MCP
getToolWebhookCallbackExampleInspect the callback shape used to complete a deferred tool call. -
Read a tool webhook request example
MCP
getToolWebhookRequestExampleInspect the request shape a tool webhook receives. -
Read a tool's sign-in requirements
MCP
getToolSignInRead tool credential enrollment status and bounded current draft connection users without returning references or values. -
Read agenda tool settings
MCP
getAgendaSettingsInspect the agenda tool's configured defaults. -
Read an agenda event example
MCP
getAgendaEventExampleInspect the declared agenda event shape. -
Read background task limits
MCP
getBackgroundTaskLimitsInspect the configured task limits. -
Read email shared-sender reply settings
MCP
getEmailMessagingSettingsRead Send email settings, including what to do when a reply could be for more than one open conversation. -
Read Slack shared-sender reply settings
MCP
getSlackMessagingSettingsRead Slack sender settings, including what to do when a reply could be for more than one open conversation. -
Read Telegram shared-sender reply settings
MCP
getTelegramMessagingSettingsRead Telegram sender settings, including what to do when a reply could be for more than one open conversation. -
Read text shared-sender reply settings
MCP
getTextMessagingSettingsRead text sender settings, including what to do when a reply could be for more than one open conversation. -
Read tool call examples
MCP
getToolCallExamplesRead example arguments and results to understand a tool's declared interface. -
Read tool editing options
MCP
getCompanyToolOptionsRead icon choices and current safeguard authority. -
Read tool publication state
MCP
getToolPublicationInspect the saved tool versions and their publication state. -
Read tool webhook signing status
MCP
getToolWebhookSigningRead webhook signing configuration and key status. -
Read WhatsApp shared-sender reply settings
MCP
getWhatsappMessagingSettingsRead WhatsApp sender settings, including what to do when a reply could be for more than one open conversation. -
Set email shared-sender reply settings
MCP
putEmailMessagingSettingsSave Send email settings for replies that could be for more than one open conversation. -
Set Slack shared-sender reply settings
MCP
putSlackMessagingSettingsSave the Slack sender setting for replies that could be for more than one open conversation. -
Set Telegram shared-sender reply settings
MCP
putTelegramMessagingSettingsSave the Telegram sender setting for replies that could be for more than one open conversation. -
Set text shared-sender reply settings
MCP
putTextMessagingSettingsSave the text sender setting for replies that could be for more than one open conversation, including the seven-day recent window. -
Set WhatsApp shared-sender reply settings
MCP
putWhatsappMessagingSettingsSave the WhatsApp sender setting for replies that could be for more than one open conversation.
Trusted work domains
Company-owned DNS proof for member sign-in, independent of seats and Studio addresses.
-
Add a trusted work domain
MCP
addCompanyTrustedDomainGet the independent DNS TXT record for a work domain. -
Block one company member
MCP
blockCompanyMemberActorStop current member access for one known actor, without deleting its identity or memory. -
Cancel a removed member’s scheduled memory erasure
MCP
cancelCompanyMemberActorMemoryErasureCancel only the exact pending schedule before its undo deadline and before any worker attempt. -
Change a trusted domain
MCP
updateCompanyTrustedDomainSet permitted sign-in methods, exact Microsoft tenant, member access, plus-address handling and the default visibility, or pause the domain. -
Check a work domain proof
MCP
checkCompanyTrustedDomainLook for the exact TXT proof outside the database lock, then admit it with the current revision and authority. -
End all member sessions for one person
MCP
endCompanyMemberActorSessionsEnd all existing company member bearers for one retained actor across assistants, environments and sites. -
Erase a removed member’s memory now
MCP
eraseCompanyMemberActorMemoryExplicitly queue immediate person-memory erasure for a terminally removed member. -
List retained company members
MCP
listCompanyMemberActorsRead retained company member records under current manager authority. -
List trusted work domains
MCP
listCompanyTrustedDomainsRead the company's work domains and proof state. -
Read a member spend ceiling
MCP
getCompanyMemberSpendPolicyRead the company ceiling, optional member override and effective ceiling. -
Read a retained company member
MCP
getCompanyMemberActorRead one retained member under current company management authority. -
Reapprove one retained member
MCP
reapproveCompanyMemberActorExplicitly reapprove one frozen or older-epoch retained member against the expected current domain epoch. -
Remove a trusted domain
MCP
removeCompanyTrustedDomainEnd this domain's trust and release its exclusive claim. -
Remove one company member
MCP
removeCompanyMemberActorPermanently stop member access for one retained actor. -
Schedule a removed member’s memory erasure
MCP
scheduleCompanyMemberActorMemoryErasureQueue durable person-memory erasure after an administrator-chosen 1–30 day undo window. -
Set or reset a member spend ceiling
MCP
updateCompanyMemberSpendPolicyConditionally set a retained member ceiling, or send null to follow the current company default. -
Set or shorten a member access deadline
MCP
expireCompanyMemberActorSet or shorten one retained member access deadline. -
Unblock one company member
MCP
unblockCompanyMemberActorRestore a blocked member only while its existing domain, epoch, address rules and expiry remain valid.
Way-in chains
The steps that run one after another on a way in before any agent: lookups, split, map, identity, gates and who answers.
-
Default way-in chains
MCP
listWayInChainDefaultsLists the chain each kind of way in starts with, and the chain limits. -
Read a way in's chain
MCP
getWayInChainReads the chain on one way in of a workflow (web chat, email, phone, Slack, app poller, or a start by its id), with its warnings and optional value-free last_test_data. -
Read a workflow start's chain
MCP
getPipelineTriggerChainReads the chain on one of a workflow's starts (schedule, webhook, event, app, run by hand), with its warnings. -
Save a way in's chain
MCP
updateWayInChainReplaces the chain on one way in. -
Save a workflow start's chain
MCP
updatePipelineTriggerChainReplaces the chain on one workflow start, with the same rules as a way in's chain. -
Try a way-in chain on a sample
MCP
sampleWayInChainRuns an unsaved chain on sample data and returns each step's output, the errors and warnings, and for a split the parent summary and one result per child item.
Web chat ways in
Put a workflow's chat on your website: its chat key, allowed websites and how the window looks.
-
Add a web chat to a workflow
MCP
createPipelineWebChatAdds a web chat way in. -
Change a web chat
MCP
updatePipelineWebChatChanges a web chat way in's name, On/Paused state, allowed websites or window settings. -
List a workflow's web chats
MCP
listPipelineWebChatsLists the web chat ways in on a workflow with their chat keys, allowed websites, window settings and observed accepted-message activity. -
Remove a web chat
MCP
deletePipelineWebChatRemoves a web chat way in. -
Try a web chat
MCP
startPipelineWebChatTrialOpens a 15-minute trial of a web chat way in from Studio.
After-agent deliveries
Saved End deliveries and their deterministic routing, running after the workflow finishes.
-
Read the after-agent deliveries graph
MCP
getDeliveriesGraphReads the saved AfterAgent model, projecting End Call a URL steps from the canonical workflow. -
Save the after-agent deliveries graph
MCP
updateDeliveriesGraphSaves the AfterAgent model under the quoted workflow revision.
Workflow exceptions
Saved exception graphs, named kinds and raised exception receipts.
-
Read exception kinds
MCP
getExceptionKindsReads the workflow exception kind registry, with built-in kinds first. -
Read raised exceptions
MCP
listExceptionsLists real durable workflow exception receipts newest first, including MCP way-in raises. -
Read the Exceptions graph
MCP
getExceptionsGraphReads the saved workflow Exceptions graph without dropping Studio node fields. -
Save exception kinds
MCP
updateExceptionKindsReads or replaces the workflow exception kind registry. -
Save the Exceptions graph
MCP
updateExceptionsGraphStores the workflow Exceptions graph without dropping Studio node fields.
Workflow Filter rule previews
Test a deterministic rule before authoring an executable Filter step.
-
Preview a workflow Filter rule
MCP
previewWorkflowFilterEvaluate an unsaved deterministic Filter rule against a caller-supplied scalar sample using the current saved workflow declarations.
Workflow folders
Company-shared one-level workflow folders, called categories in Studio.
-
Archive a workflow category
MCP
deleteWorkflowFolderArchive a workflow category, retaining its identity and all assigned workflows. -
Create a workflow folder
MCP
createWorkflowFolder -
List workflow folders
MCP
listWorkflowFolders -
Move a workflow to a folder
MCP
moveWorkflowToFolder -
Rename a workflow folder
MCP
renameWorkflowFolder
Workflow layouts
Where people moved cards on a workflow's node graphs: Ways in chains, Identity, Agent flow, Deliveries and Exceptions.
-
Read a graph's card positions
MCP
getPipelineCanvasLayoutReads where people moved cards on one of a workflow's node graphs. -
Save a graph's card positions
MCP
updatePipelineCanvasLayoutReplaces every moved card's position on one of a workflow's node graphs.
Workflow notifications
Notify is a tool-step preset that renders named run fields without a model call. Staff notifications are stored in the company inbox; qualified outbound channel bindings are separate.
-
Preview a notification template
MCP
previewWorkflowNotificationRender a saved notification template against sample scalar run fields. -
Read your notifications
MCP
listNotificationsRead only the current active staff member’s inbox. -
Send me a notification test
MCP
sendWorkflowNotificationTestRender sample fields and store a test in the current active staff member’s own in-app inbox.
Workflow publish checks
Check required setup choices on the saved workflow.
-
Check workflow for publishing
MCP
checkPipelineForPublishingRead required setup markers and missing agent/tool choices, planned placeholders and invalid filters on the current saved workflow, including side chains.
Workflow ways in
Read the saved ways into a workflow and open their existing chains.
-
List a workflow's ways in
MCP
listPipelineWaysInList saved workflow starts, request maps, incoming email maps and web chats, with their canonical chain paths.
Workflows
Inspect settings saved on workflow steps and the values they inherit.
-
Adopt a Gmail reply draft agent
MCP
adoptGmailReplyDraftTemplateCreate and publish a Dev reply draft workflow using an existing immutable agent publication containing only the reviewed draft instructions. -
Create a call-recording-ready workflow starter
MCP
createCallRecordingStarterCreate a workflow that starts when a call recording is ready, and make it Live. -
Install the Gmail reply draft workflow
MCP
installGmailReplyDraftTemplateInstall reviewed draft instructions on an unused root agent, publish its immutable Dev version and create the reply draft workflow. -
Read effective workflow step tool settings
MCP
getStepEffectiveToolSettingsRead a step's resolved tool settings and their sources. -
Read workflow step tool settings
MCP
getStepToolSettingsRead the settings saved directly on a workflow step. -
Receive a finished call recording
API only
receiveCallRecordingReceive a provider-signed finished recording notification for the transcript and report starter.