API reference
Every public method of the Xuda API, with its fields, who may call it and a sandbox that calls it with your own key.
- Methods
- 383
- Microservices
- 26
- Public
- 20
Endpoint
01One POST per method, a JSON body, the method id in the path.
POST https://xuda.ai/cpi/<method_id>Calling a method Authentication
02Your API key travels in the body as api_key, next to the method fields.
{ "api_key": "pk_...", ...fields }Authentication guide Response
03Every answer has a code and data. A code of 0 or more is success.
{ "code": 1, "data": { ... } }Errors Microservices
Pick one to list its methods.
Account
account_module
35methodsAccount profiles and the contact book: creating, updating, archiving and organizing profiles and contacts.
- public 1
- user 34
Advertising
advertise_module
6methodsConnects an application to Google Ads and Meta, generates ad creative, and launches and reports on live campaigns.
- user 6
AI
ai_module
26methodsAI chats, AI agents and mini apps: creating, favoriting, pinning, archiving and deleting them and their conversation items.
- user 25
- user_access 1
Applications
app_module
61methodsCreates and operates an application: projects, studio programs, the application firewall, database maintenance and traffic logs.
- public 1
- user 39
- user_access 3
- admin 18
Backups
backup_module
2methodsCreates an application backup by replicating the source application, and lists the backups an application has.
- admin 2
Build
build_module
4methodsBuilds a new release of an application and manages, lists and deletes its releases.
- developer 1
- admin 3
Calendar
calendar_module
24methods- public 10
- user 14
Cms
cms_module
5methods- user 5
Data (DBS)
data_module
6methodsReads, creates, updates, restores and soft-deletes records in an application table, and returns table row counts.
- user_access 1
- admin 5
Deploy
deploy_module
7methodsDeployment info, hosting regions, the suggested region for a caller, and application version updates.
- user 3
- admin 3
- none 1
Domains
domains_module
2methodsLists an account's registered domains and connects one of them to a VPS.
- user 2
Drive
drive_module
68methodsFiles and folders across the studio, user and workspace drives: checking, copying and the rest of drive file management.
- user 27
- admin 41
Email
email_module
14methodsConnected mailboxes and messages: reading, archiving, refreshing and sending email for a verified account.
- user 13
- admin 1
Firewall (fleet)
firewall_module
9methodsFleet-wide firewall definitions, ipsets and rendered rulesets across the server registry. Superuser only.
- admin 9
IPv4
ipv4_module
9methodsBuying, attaching, parking, releasing and listing an account's IPv4 addresses, plus pool availability and pricing.
- user 9
Logs
logs_module
6methodsApplication and account activity logs: querying, counting, and clearing application or user logs.
- user 4
- admin 2
Marketplace
marketplace_module
1methodReturns the install consent screen shown before a marketplace AI agent or plugin is installed.
- user 1
Meet
meet_module
1methodResolves a public Xuda Meet link to the room behind it.
- public 1
Platform
misc_module
3methodsPlatform-wide information: active application servers, hosting regions and the configured pricing object.
- public 2
- user 1
Notifications
notification_module
8methodsReads a user's notifications, marks one read, and sends a notification to the authorized users of an application.
- public 1
- user 6
- admin 1
Plugins
plugins_module
6methodsLists, installs and uninstalls plugins on an application, and lists the plugin catalog and its categories.
- public 2
- admin 4
Session and CLI auth
session_module
4methodsThe device-code sign-in flow used by the Xuda CLI (start, poll, approve, deny), and session log housekeeping.
- public 2
- user 1
- admin 1
Team and sharing
team_module
13methodsShares an application with another account, manages contact and user-group members, and assigns API keys to them.
- user 9
- admin 4
Tickets
ticket_module
10methodsReads support tickets, and, through the ticket API, an external service submits, replies to, lists and closes tickets on a desk.
- user 10
Verify
verify_module
3methodsCreates and reads identity verification sessions for the users of your own application.
- user 3
Voice
voice_module
50methodsPhone numbers, calls and the answering rules around a profile: activating the phone service, calling, transferring and messaging.
- user 44
- admin 6
All methods
archive_account_profileArchive Account ProfileArchive Account ProfileArchives account profile.2 fieldsuserarchive_contactArchive ContactArchive ContactArchives contact.2 fieldsusercreate_account_profileCreate Account ProfileCreate Account ProfileCreates account profile.13 fieldsusercreate_contactCreate ContactCreate ContactAdds a person to the contact book by hand, from typed details rather than from a received message. Takes only the fields a contact has, name, email, phone, company, job title and its kind (personal or business, which then needs no model to classify it), and ignores anything else the caller happens to hold, such as a shipping address. The email is the book's key, so it is required and a repeat of one already filed returns the existing contact instead of a second copy.10 fieldsuserdelete_account_profileDelete Account ProfileDelete Account ProfileDeletes account profile.2 fieldsuserdelete_contactDelete ContactDelete ContactDeletes contact.2 fieldsuserfavorite_contactFavorite ContactFavorite ContactMarks contact as a favorite.2 fieldsusergenerate_contact_avatarGenerate Contact AvatarGenerate Contact AvatarClears a contact's existing pictures and regenerates its profile avatar (not available on free accounts).2 fieldsuserget_account_advertisingGet Account AdvertisingGet Account AdvertisingReturns the user's advertising campaigns (app_type:advertising) via a Mango query.No fieldsuserget_account_balancersGet Account BalancersGet Account BalancersReturns the user's load balancers (app_type:balancer) via a Mango query, so the sidenav bucket picks up a newly created balancer right after deploy.No fieldsuserget_account_datacentersGet Account DatacentersGet Account DatacentersReturns the datacenters associated with the account from the user_datacenters master view.No fieldsuserget_account_deploymentsGet Account DeploymentsGet Account DeploymentsReturns the deployments associated with the account from the user_deployments master view.No fieldsuserget_account_infoGet Account InfoGet Account InfoReturns the account data for the requesting user, optionally enforcing usage limits.No fieldsuserget_account_instancesGet Account InstancesGet Account InstancesReturns all instances associated with the account from the user_all_instances master view.No fieldsuserget_account_profilesGet ProfilesGet ProfilesRetrieves account profiles.12 fieldsuserget_account_projectsGet Account ProjectsGet Account ProjectsReturns the projects owned by the account (or all projects for superuser and support accounts) from the user_projects master view.No fieldsuserget_account_static_websitesGet Account WebsitesGet Account WebsitesReturns the user's websites (app_type:static_website) via a Mango query.No fieldsuserget_account_vpsGet Account VPSGet Account VPSReturns the standalone virtual servers associated with the account from the user_vps master view.No fieldsuserget_contactsGet ContactsGet ContactsRetrieves contacts.15 fieldsuserget_login_screenGet Login ScreenGet Login ScreenPublic pre-auth resolver for an account's effective login screen. Returns only source/media_type/file_url and the public branding view (UI-1752).3 fieldspublicget_site_build_image_modesGet Site Build Image ModesGet Site Build Image ModesReturns which website-builder image modes (svg, stock, gen_low, gen_high) the account may use. The two AI-generation modes require a paid membership and a workspace credit plan; otherwise they are locked and the UI shows an upgrade prompt.No fieldsusernot_spam_contactNot Spam ContactNot Spam ContactMarks a contact as not spam, whitelists its email, and refreshes its business or personal classification.2 fieldsuserpin_contactPin ContactPin ContactPins contact.2 fieldsuserset_deep_research_contactSet Deep Research ContactSet Deep Research ContactEnables deep research on a contact, enriching its business or personal info and processing related conversation transcripts.2 fieldsuserset_not_contactSet Not A ContactSet Not A ContactMoves a contact out of the Contacts list into Not contacts, for a sender that is not somebody to talk to (a bank's alerts, a store's receipts, a no-reply address). Its mail is still read as before. unset_not_contact puts it back.2 fieldsuserunarchive_account_profileUnarchive Account ProfileUnarchive Account ProfileRestores archived account profile.2 fieldsuserunarchive_contactUnarchive ContactUnarchive ContactRestores archived contact.2 fieldsuserunfavorite_contactUnfavorite ContactUnfavorite ContactRemoves the favorite state from contact.2 fieldsuserunfriend_contactUnfriend ContactUnfriend ContactEnds the friend relationship with a contact by closing its team request and clearing the link from the contact.2 fieldsuserunpin_contactUnpin ContactUnpin ContactRemoves the pinned state from contact.2 fieldsuserunset_deep_research_contactUnset Deep Research ContactUnset Deep Research ContactDisables deep research on a contact and clears its cached data.2 fieldsuserunset_not_contactUnset Not A ContactUnset Not A ContactPuts a contact from Not contacts back in the Contacts list, and keeps it there: the no-reply rule never moves it again.2 fieldsuserupdate_account_infoUpdate Account InfoUpdate Account InfoUpdates account information.32 fieldsuserupdate_account_profileUpdate Account ProfileUpdate Account ProfileUpdates account profile.22 fieldsuserupdate_entity_account_profilesUpdate Entity Account ProfilesUpdate Entity Account ProfilesUpdates entity account profiles.3 fieldsuser
generate_ad_creativeGenerate Ad CreativeGenerate Ad CreativeAI-generates ad copy (headline, primary text, description, CTA) for a campaign + platform in a chosen tone. Google Ads first; other platforms use the social template.7 fieldsuserget_ad_campaign_reportGet Ad Campaign ReportGet Ad Campaign ReportPulls LIVE daily metrics (Meta Insights + Google Ads search) from each launched network into the campaign's report. Owner-scoped.2 fieldsuserget_advertise_platformsGet Advertise PlatformsGet Advertise PlatformsReturns advertising platforms with status in [pending, process, active] (override via statuses). Credentials are stripped from the response.1 fielduserlaunch_ad_campaignLaunch Ad CampaignLaunch Ad CampaignCreates the campaign in the ad network (Google Ads first) via its API, PAUSED. Owner-scoped.2 fieldsuserprovision_google_ads_accountProvision Google Ads AccountProvision Google Ads AccountAgency: creates a new Google Ads client account under Xuda's manager for the customer and stores it on their account. One per customer, reused. Bills to the manager's consolidated billing.2 fieldsuserset_ad_network_statusSet Ad Network StatusSet Ad Network StatusPauses or resumes the LIVE network campaigns (Google + Meta) for a campaign, on every network it was launched to. Pairs with the header Active/Paused toggle. Owner-scoped.2 fieldsuser
archive_ai_agentArchive AI AgentArchive AI AgentArchives AI agent.3 fieldsuserarchive_ai_chatArchive AI ChatArchive AI ChatArchives AI chat.2 fieldsuserarchive_mini_appArchive Mini AppArchive Mini AppArchives mini in application.2 fieldsuserdelete_ai_chatDelete AI ChatDelete AI ChatDeletes AI chat.2 fieldsuserdelete_conversation_itemDelete Conversation ItemDelete Conversation ItemDeletes conversation item.2 fieldsuserdelete_mini_appDelete Mini AppDelete Mini AppDeletes mini from application.2 fieldsuserfavorite_ai_agentFavorite AI agentFavorite AI agentMarks AI agent as a favorite.2 fieldsuserfavorite_ai_chatFavorite AI chatFavorite AI chatMarks AI chat as a favorite.2 fieldsuserfavorite_mini_appFavorite Mini AppFavorite Mini AppMarks mini app as a favorite.2 fieldsusergenerate_ai_agent_imageGenerate AI Agent ImageGenerate AI Agent ImageGenerates a new picture for one AI agent you own and saves it on the agent, using the same generator that runs when an agent is created. Use it when an agent has no picture and the card is falling back to the placeholder. Runs in the background, the new picture appears on the next load.2 fieldsuser Background jobgenerate_release_notesGenerate Release NotesGenerate Release NotesAI-generates concise, user-facing release notes for a build the developer is about to create, by diffing the app's PUBLISHED programs against the previous release's timestamp to see what changed. Read-only (never writes the release). Returns { notes, changed_count, since_build, version }. Credits are metered to the caller.4 fieldsuser_accessget_ai_workspace_pending_countsGet AI Workspace Pending CountsGet AI Workspace Pending CountsReturns counts of pending workspace requests grouped by type (AI chats, AI agents, apps, contacts, account profiles, user drive) for a main account profile.2 fieldsuserpin_ai_agentPin AI agentPin AI agentPins AI agent.2 fieldsuserpin_ai_chatPin AI chatPin AI chatPins AI chat.2 fieldsuserpin_mini_appPin Mini AppPin Mini AppPins mini app.2 fieldsuserrename_ai_chatRename AI ChatRename AI ChatRenames an AI chat and records the change on its activity trail.3 fieldsuserrename_mini_appRename Mini AppRename Mini AppRenames a mini app.3 fieldsuserset_agent_tool_consentSet Agent Tool ConsentSet Agent Tool ConsentRecords whether the caller allows an installed agent to use plugin tools that run in the publisher's workspace, where anything the tools create is stored in the publisher's drive rather than the caller's.3 fieldsuserunarchive_ai_chatUnarchive AI ChatUnarchive AI ChatRestores archived AI chat.2 fieldsuserunarchive_mini_appUnarchive Mini AppUnarchive Mini AppRestores archived mini in application.2 fieldsuserunfavorite_ai_agentUnfavorite AI agentUnfavorite AI agentRemoves the favorite state from AI agent.2 fieldsuserunfavorite_ai_chatUnfavorite AI chatUnfavorite AI chatRemoves the favorite state from AI chat.2 fieldsuserunfavorite_mini_appUnfavorite Mini AppUnfavorite Mini AppRemoves the favorite state from mini app.2 fieldsuserunpin_ai_agentUnpin AI agentUnpin AI agentRemoves the pinned state from AI agent.2 fieldsuserunpin_ai_chatUnpin AI chatUnpin AI chatRemoves the pinned state from AI chat.2 fieldsuserunpin_mini_appUnpin Mini AppUnpin Mini AppRemoves the pinned state from mini app.2 fieldsuser
agent_firewall_closeFirewall: close portsFirewall: close portsClose inbound TCP port(s) on the current app's firewall. Acts only on the current app.1 fielduseragent_firewall_listFirewall: list open portsFirewall: list open portsList the inbound firewall rules (open ports) for the current app. Check what is reachable from outside before opening or closing ports.No fieldsuseragent_firewall_openFirewall: open portsFirewall: open portsOpen inbound TCP port(s) on the current app's firewall so the service becomes reachable from outside. Use when a service is up locally but times out from outside. Acts only on the current app.1 fielduserchange_under_attack_modeChange Under Attack ModeChange Under Attack ModeToggles Cloudflare under-attack mode for the application.2 fieldsadminclear_traffic_logsClear Traffic LogsClear Traffic LogsLaunches a background job that deletes the application's visit log documents.1 fieldadmincompact_databaseCompact DatabaseCompact DatabaseLaunches a background job that deletes stat-4 documents and compacts the application's database.1 fieldadmincreate_progCreate ProgCreate ProgCreates a new studio node (program, table, component, folder...) using the same factory Studio itself uses. Returns the created doc.5 fieldsusercreate_projectCreate ProjectCreate ProjectCreates a new project for the caller from the app fields sent in data. Fields only the platform may set are ignored. Free plugins listed in data.app_plugins_purchased are installed into the new project, and its default drive folders are created.2 fieldsuserdelete_progDelete ProgDelete ProgSoft-deletes a studio node (Studio's stat 4 convention). The global node cannot be deleted.3 fieldsuserdestroy_appDestroy AppDestroy AppPermanently deletes the specified application. The pre_dispatch hook stamps app_cost.terminated_ts synchronously before the destruction job is queued, so billing UI updates instantly.2 fieldsadminget_app_configGet App ConfigGet App ConfigReturns the public configuration of a live deployment: its branding and icon, address, current build, launch route, and the launch and login settings its public screens need (access mode, login methods, device frame and the preview password check). The app is found by app_id, by its domain, or by a live preview token.3 fieldspublicget_app_firewallGet App FirewallGet App FirewallReturns the app's current firewall rules: the live rules of a hosted virtual server, the cloud firewall attached to the app, or, when neither exists yet, a default ruleset that allows outbound traffic and no inbound traffic.1 fieldadminget_app_infoGet App InfoGet App InfoReturns the app's record together with the caller's access to it: the caller's access_type, a readonly flag when the call is made with an API key, and for a VPS its access-consent scopes and their state. For a user group app it also opens an app session and returns its app_token.2 fieldsuser_accessget_app_tablesGet App TablesGet App TablesReturns the app's studio table docs, excluding pouchdb-backed local tables.2 fieldsadminget_app_traffic_metricsGet App Traffic MetricsGet App Traffic MetricsReturns visit counts for a deployment by country, device, browser, vendor, operating system, engine, model and device type, plus total visitors and visitors by date. For a project, the counts are summed across its datacenters.1 fieldadminget_app_traffic_overviewGet App Traffic OverviewGet App Traffic OverviewRetrieves application traffic overview.1 fieldadminget_db_activityGet Db ActivityGet Db ActivityReturns recent activity on the app's database, the background jobs currently running for it, and, for each document type, how many deleted documents are waiting to be cleared by compaction.1 fieldadminget_progGet ProgGet ProgFetches one studio node (full JSON) by its id.2 fieldsuserget_prog_examplesGet Prog ExamplesGet Prog ExamplesCurated, WORKING example progs from the xuda kitchen-sink project. Call without example_id to list (name, type, tags, one-liner); then fetch one by example_id and pattern your build on it. Examples are sanitized reference docs. Create your own progs with create_prog, never save an example verbatim.4 fieldsuserget_progsGet ProgsGet ProgsLists the studio nodes (programs, tables, components, routes...) of a studio project. Returns summaries by default; pass full=true for complete docs.6 fieldsuserget_project_instancesGet Project InstancesGet Project InstancesLists the project's instances whose maintainer is the project's owner.1 fieldadminget_studio_docs_by_typeGet Studio Docs By TypeGet Studio Docs By TypeReturns studio (or deployed-build) docs for an app filtered by menuType, status, and optional build id.4 fieldsuser_accessget_studio_guideGet Studio GuideGet Studio GuideThe xuda Studio authoring guide for AIs. READ THIS FIRST before creating or editing studio progs. Call without a topic for the primer + required workflow + topic index; then read the topic matching what you build (components, tables, programs, javascript, attributes, anatomy, gotchas). Enumerable facts (menu types, xu attributes, workflow actions) are merged from this server's live registries, so the guide always matches the deployed runtime.1 fielduserget_vps_diagnose_reportGet VPS Diagnose ReportGet VPS Diagnose ReportReturns the last stored Auto Diagnose report for the app (or null). Read-only: reads the report already saved on the app doc, no SSH or file access. Owner-gated via _vps_fs_resolve.1 fielduserlist_studio_doc_versionsList Studio Doc VersionsList Studio Doc VersionsLists version-history snapshots for a studio doc from the app's history database (server-side capture).2 fieldsuser_accesssave_deploy_settingsSave Deploy SettingsSave Deploy SettingsUpdates an app's deployment settings: launch and access mode, billed add-ons (offline, User Monitor, Auto Diagnose), VPS access consent, the release and route to serve, and the login and setup configuration. The app's monthly cost is recalculated afterwards.20 fieldsadminsave_progSave ProgSave ProgUpdates an existing studio node with a full doc (must include _id; _rev is checked for conflicts). Pass the doc as prog_json (a JSON-encoded string). Identity/audit fields (docType, created, createdByUid) are server-owned. Javascript progs are COMPILED on save (like Studio's own save): on success scriptData.dependencies is refreshed, on failure the doc is saved with a build_error and the response carries compile.error.2 fieldsuserset_runtime_user_assistSet Runtime User AssistSet Runtime User AssistTurns the deployed app's User Monitor add-on (in-app help) on or off and recalculates the app's monthly cost.2 fieldsadminset_runtime_utility_screenSet Runtime Utility ScreenSet Runtime Utility ScreenDeprecated: use set_runtime_user_assist. Utility Screen is now part of User Monitor, so this turns the same add-on on or off and recalculates the app's monthly cost.2 fieldsadminturn_app_offTurn App OffTurn App OffTurns off (suspends) the specified application.1 fieldadminturn_app_onTurn App OnTurn App OnTurns on (resumes) the specified application.1 fieldadminupdate_domain_setupUpdate Domain SetupUpdate Domain SetupSets the app's address: a subdomain of the platform app domain, a custom domain the customer owns, or a domain registered through Xuda. A custom domain starts a DNS and SSL check; a registered domain is attached to the project and stored as a custom domain.5 fieldsadminupdate_npm_dependenciesUpdate Npm DependenciesUpdate Npm DependenciesSaves the app's npm dependencies to its project package.json, installs them, and syncs the project's files to its servers. If package.json cannot be read, a new one is created and the call asks you to refresh and save again.2 fieldsadminvalidate_progValidate ProgValidate ProgValidates a studio prog with xuda's own checker (structure, cross-references, workflow actions, expressions) PLUS a landmine scan for AI-typical mistakes (quotes inside xu-script/xu-style, unknown xu attributes, designer-state $-keys, malformed nodes). RUN THIS BEFORE EVERY save_prog and fix all errors; warnings are real problems too. Pass prog_json (candidate doc, pre-save) or prog_id (existing node).3 fieldsuserverify_app_dns_infoVerify App Dns InfoVerify App Dns InfoLooks up WHOIS data and verifies the SSL certificate for the app's configured custom domain.1 fieldadminvps_disable_sshVPS: disable SSHVPS: disable SSHDisables SSH-over-WebSocket access for the VPS (the router stops resolving the tunnel). Keeps the subdomain.1 fielduservps_disable_web_urlVPS: disable web URLVPS: disable web URLStops serving the VPS's public xuda.app URL (keeps the subdomain reserved for re-enable).1 fielduservps_enable_sshVPS: enable SSHVPS: enable SSHEnables SSH/SFTP-over-WebSocket access for the VPS (idempotent). Returns the connect commands with a token on first enable.1 fielduservps_enable_web_urlVPS: enable web URLVPS: enable web URLGives the VPS a public https://<sub>.xuda.app URL that reverse-proxies to its web server (default port 80). Allocates a subdomain if needed.3 fieldsuservps_fs_deleteVPS Files: deleteVPS Files: deleteDeletes a file or directory (recursively) on the project's VPS over SFTP.2 fieldsuservps_fs_disk_usageVPS Files: disk usageVPS Files: disk usageReturns one-level disk usage (du) of a directory on the VPS, largest children first.2 fieldsuservps_fs_listVPS Files: list directoryVPS Files: list directoryLists a directory on the project's VPS over SFTP. Returns typed entries (file/dir, size, mtime, mode).2 fieldsuservps_fs_mkdirVPS Files: create directoryVPS Files: create directoryCreates a directory (recursively) on the project's VPS over SFTP.2 fieldsuservps_fs_readVPS Files: read fileVPS Files: read fileReads a file on the project's VPS over SFTP. Detects text/image/binary and caps inline size.2 fieldsuservps_fs_renameVPS Files: rename / moveVPS Files: rename / moveRenames or moves a file or directory on the project's VPS over SFTP.3 fieldsuservps_fs_searchVPS Files: searchVPS Files: searchSearches a directory subtree on the VPS by filename or by file contents.4 fieldsuservps_fs_service_actionVPS Files: service actionVPS Files: service actionRuns a bounded service action (nginx test/reload, apache, caddy, systemd daemon-reload, or systemctl verb on a named unit) on the VPS.4 fieldsuservps_fs_tailVPS Files: tail fileVPS Files: tail fileReturns the tail of a file on the VPS, with an offset for incremental polling (live log follow).3 fieldsuservps_fs_writeVPS Files: write fileVPS Files: write fileCreates or overwrites a file on the project's VPS over SFTP.4 fieldsuservps_fs_write_batchVPS Files: batch uploadVPS Files: batch uploadWrites many files to the project's VPS over a single SFTP session, creating parent directories as needed. Used for folder uploads.2 fieldsuservps_rotate_ssh_tokenVPS: rotate SSH tokenVPS: rotate SSH tokenIssues a fresh one-time SSH/SFTP-over-WebSocket bearer token for the VPS (invalidates any previous one) and returns the ready-to-paste connect commands. The server's own SSH login is still required.1 fielduservps_set_web_portVPS: set web portVPS: set web portChanges the upstream port (and optional https scheme) the public xuda.app URL proxies to on the VPS.3 fieldsuservps_ssh_access_createVPS SSH: add developer accessVPS SSH: add developer accessCreates a new named SSH-over-WebSocket developer access, mints a one-time connection token (only its hash is stored), and returns the plaintext token and connect commands once. Optionally sets an expiry.3 fieldsuservps_ssh_access_deleteVPS SSH: delete developer accessVPS SSH: delete developer accessDeletes a named SSH developer access. Its token stops working immediately.2 fieldsuservps_ssh_access_listVPS SSH: list developer accessesVPS SSH: list developer accessesLists every SSH/SFTP-over-WebSocket developer access for a VPS: label, creation date, expiry, active or suspended status, and live online state. Read-only, owner-gated. Never returns the token itself.1 fielduservps_ssh_access_rotateVPS SSH: regenerate access tokenVPS SSH: regenerate access tokenRegenerates the connection token for an existing named SSH developer access (invalidates the previous one) and returns the new plaintext token and connect commands once.2 fieldsuservps_ssh_access_set_statusVPS SSH: suspend or activate accessVPS SSH: suspend or activate accessSuspends or re-activates a named SSH developer access. A suspended access is refused by the router immediately.3 fieldsuservps_ssh_access_updateVPS SSH: edit developer accessVPS SSH: edit developer accessEdits a named SSH developer access: change its label and or expiry. Does not change the token.4 fieldsuservps_ssh_command_logVPS SSH: command historyVPS SSH: command historyLists the commands run over SSH on this server, read live from the server's own command log. Read-only, owner-gated. Requires the command log to be switched on for the server, and only covers interactive shell sessions.2 fieldsuservps_ssh_command_log_setVPS SSH: switch command history on or offVPS SSH: switch command history on or offTurns the in-server command log on or off. When on, every command typed in an interactive SSH session is recorded on the server itself so the owner can review it. Owner-gated and off by default.2 fieldsuservps_ssh_session_eventsVPS SSH: session historyVPS SSH: session historyLists every SSH/SFTP session opened against this server through the secure tunnel: which access was used, the client address, when it started and ended, how long it lasted, and how much data moved each way. Read-only, owner-gated. Session envelopes only, the tunnel is end-to-end encrypted so commands and file names are never visible to the platform.2 fieldsuser
build_appBuild AppBuild AppBuilds a new release version of an application, running the program checker and publishing release notifications.4 fieldsdeveloperdelete_releaseDelete ReleaseDelete ReleaseSoft-deletes an application release and removes its build folder if no deployments use it.2 fieldsadminget_app_releasesGet App ReleasesGet App ReleasesRetrieves application releases.2 fieldsadminget_release_note_infoGet Release Note InfoGet Release Note InfoRetrieves the release note for a specific application build.2 fieldsadmin
calendar_set_planCalendar Set PlanCalendar Set PlanSwitch Xuda Calendar on, change tier, or switch it off. Tiers are free (one booking page), starter (unlimited pages, payments, SMS reminders and round robin), growth (resources, group sessions with seats, calendar sync and AI phone booking) and business (managed templates, attribute routing, webhooks and API). Paid tiers ride one line item on the consolidated subscription, so moving between them swaps the price instead of adding a second charge. Switching off clears the plan and cancels the line at the end of the period.3 fieldsusercancel_calendar_bookingCancel Calendar BookingCancel Calendar BookingCancel a booking and give the time back. Safe to call twice, and the slot returns to the public grid.2 fieldsuserconfirm_calendar_bookingConfirm Calendar BookingConfirm Calendar BookingTurn a held slot into a real booking. A hold token that is no longer present has lost the slot and is refused rather than re-added, because re-adding it is how one time gets sold twice.7 fieldsuserconfirm_paid_bookingConfirm Paid BookingConfirm Paid BookingConfirms an appointment once its payment has cleared. Everything is checked against Stripe on the server: the visitor arrives from a redirect and controls every value in it, so three things must agree before a slot is given away. Stripe says the payment completed; the payment names THIS appointment and THIS hold, which is what stops a receipt for a cheap slot being presented against an expensive one; and the amount collected still matches what the service costs. If the payment cleared but the slot could not be booked, that is reported rather than swallowed, because the money is real and the appointment is not.No fieldspubliccreate_booking_roomCreate Booking RoomCreate Booking RoomMake the Xuda Meet room of a video booking that was confirmed without one, and send each guest of that appointment the link. The room belongs to the appointment, so every confirmed booking of it holds the same room. Safe to call twice: a second press answers the room that exists and sends nothing again. Refused for a booking that is cancelled, already over, not a video appointment, or not the caller's.2 fieldsuserdelete_calendar_itemDelete Calendar ItemDelete Calendar ItemRemove a resource, a service or a booking page. Bookings are never deleted this way: they are cancelled, which frees the slot and keeps the record the money and the contact history point at.1 fielduserget_booking_bootstrapGet Booking BootstrapGet Booking BootstrapEverything a public booking page needs to render: its title, its services and a freshly minted anti-bot token. Public, and it carries no account data beyond what the page itself shows.1 fieldpublicget_calendar_bookingsGet Calendar BookingsGet Calendar BookingsThe account's bookings, upcoming by default. Each row carries the time in the resource's zone, the attendee's details and anything they said when booking.2 fieldsuserget_calendar_plansGet Calendar PlansGet Calendar PlansThe Xuda Calendar tier ladder with prices, features and cumulative entitlements, plus which plan this account is on and whether the module is switched on at all.1 fielduserget_calendar_setupGet Calendar SetupGet Calendar SetupEverything the Calendar setup screens render in one call: the bookable resources and their working hours, the services people can book, and the published booking pages with their public addresses.1 fielduserget_calendar_slotsGet Calendar SlotsGet Calendar SlotsThe bookable times for one service on one resource across a window, with everything already taken removed. A candidate slot is an offer, not an object: for a free-form service no occurrence exists until somebody takes one.5 fieldsuserget_public_bookingGet Public BookingGet Public BookingWhat a visitor's private link opens: one booking and what they may do with it. No account and no address: the signature in the link is the whole of the check. Reading it never changes anything, because mail scanners open every link in a message.2 fieldspublicget_public_booking_slotsGet Public Booking SlotsGet Public Booking SlotsThe bookable times a visitor may choose from. Returns a start, an end and a seat count, and never says who holds the other seats.5 fieldspublichold_calendar_slotHold Calendar SlotHold Calendar SlotReserve a time for a few minutes while the booking is completed. This is the reservation: whoever wins here holds the slot, and nothing downstream re-decides it.9 fieldsusernotify_calendar_guestsNotify Calendar GuestsNotify Calendar GuestsEmail everyone invited to one booking that its time has changed, with the calendar invite attached and an optional message from the owner. The owner's own mailbox sends it on a plan that carries that entitlement, otherwise Xuda's booking address does, with a Reply-To pointing back at the owner. One message each rather than one message naming everybody.4 fieldsuserpublic_book_slotPublic Book SlotPublic Book SlotTake a booking from a visitor with no account. The slot is claimed before the visitor is told they have it; only the confirmation email and the contact record happen afterwards.12 fieldspublicpublic_cancel_bookingPublic Cancel BookingPublic Cancel BookingA visitor cancels their own booking from their private link, by the page's rules: whether visitors may change a booking, and up to how many hours before it starts. A paid booking is refunded first, by the page's refund percent, and stays booked if the refund fails. A paid booking on a page with no refund cannot be cancelled here.2 fieldspublicpublic_confirm_paid_bookingPublic Confirm Paid BookingPublic Confirm Paid BookingBook a held time once its payment has gone through. Nothing the page sends is trusted but which hold to look at: the payment is read back from Stripe on the owner's account and must have succeeded, for the service's price, in its currency, for this very hold, before the time is given. The Stripe webhook runs the same confirm, so whichever arrives second gets the same booking back. A payment that went through for a time that could no longer be kept is reported, never silent.3 fieldspublicpublic_reschedule_bookingPublic Reschedule BookingPublic Reschedule BookingA visitor moves their own booking from their private link, by the page's rules and every selling rule of the public page. The new time is taken before the old one is let go, the booking keeps its details, its length and its payment, and the invite updates the event already in the visitor's calendar. A move never charges.3 fieldspublicpublic_start_paid_bookingPublic Start Paid BookingPublic Start Paid BookingHold a time for a visitor with no account and start paying for it on the booking page itself, for a service that takes payment when booking. Every check of a free booking runs first. The price and the currency are the service's own, decided on the server and never sent by the page; the charge is a direct charge on the owner's own connected Stripe account. The hold is extended while the card is typed, and the visitor's details wait on it until the payment is confirmed. Answers the client secret the page's card field needs and which hold to confirm, nothing more.11 fieldspublicsave_calendar_pageSave Calendar PageSave Calendar PageCreate or update a published booking page: which services it offers and whether it is live.12 fieldsusersave_calendar_resourceSave Calendar ResourceSave Calendar ResourceCreate or update something that can be booked: a person, a room, a chair, a device. Carries its own timezone and its own weekly availability, so two appointments can never land on the same one.5 fieldsusersave_calendar_serviceSave Calendar ServiceSave Calendar ServiceCreate or update something people can book: how long it takes, how it aligns on the clock, its buffers and notice, and how many can attend.16 fieldsuserstart_booking_paymentStart Booking PaymentStart Booking PaymentSends a held appointment slot to Stripe so the visitor can pay for it before the booking exists. The charge lands directly on the owner's own connected Stripe account, so the calendar is never the merchant. The hold is extended while the card form is open, because ten minutes is the right answer for an abandoned browser tab and the wrong one for somebody who is paying, and Stripe will not hold a payment page open for less than thirty minutes anyway. Refused for a free service, which should simply be confirmed.No fieldspublic
archive_cms_tableArchive CMS TableArchive CMS TableArchive a CMS table (it leaves the list and its records stay) or bring it back with archived false, which counts against the plan's tables again.3 fieldsusercms_related_recordsGet CMS Records Of An ItemGet CMS Records Of An ItemThe CMS tables related to one item of another module (a ticket, a delivery, an order, a product, a finance document or a contact), each with its fields and the records that point at that item, so the item can show them to fill. A workspace with CMS switched off answers no tables.3 fieldsuserget_cms_tableGet CMS TableGet CMS TableOne CMS table as Xuda Studio stores it (its fields and indexes), with its record count and the database it lives in.2 fieldsuserget_cms_tablesGet CMS TablesGet CMS TablesThe CMS tables of one workspace, active and archived, each with its fields and how many records it holds, plus the database the records live in (the app_id to hand dbs_read, dbs_create, dbs_update, dbs_delete and dbs_restore), whether that database is ready, and the plan with what it allows. The first open of a workspace other than Main installs the database plugin there and answers preparing until it is ready.1 fieldusersave_cms_tableSave CMS TableSave CMS TableCreate a CMS table, or change one when table_id is sent. A table has a name, an optional description and its fields, each a name, a type (string, number, boolean, date, array, object, or relation) and whether it is required. A relation field relates the table to the Contacts module ({ kind: 'module', module: 'contacts' }) or to another CMS table of the workspace ({ kind: 'table', table_id }), holding one id or, with many, several; a saved relation keeps what it relates to and its shape. Field names start with a letter and use letters, digits and underscores. A new table counts against the plan's tables, and every table against its fields per table. The table is an ordinary Xuda Studio table in the workspace's database, so it opens in Studio too.5 fieldsuser
dbs_createDBS CreateDBS CreateCreates a new record in the specified app table from the provided key-value table data.3 fieldsadmindbs_deleteDBS DeleteDBS DeleteSoft-deletes (or permanently deletes when 'permanent' is set) the listed record IDs from an app table.4 fieldsadmindbs_readDBS ReadDBS ReadReads records from an app table with optional row range, single-row lookup, sorting, filtering, and archived-record selection.10 fieldsuser_accessdbs_restoreDBS RestoreDBS RestoreRestores previously soft-deleted records, identified by their IDs, in the specified app table.3 fieldsadmindbs_updateDBS UpdateDBS UpdateReplaces the data of an existing record, identified by row_id, in the specified app table.4 fieldsadminget_table_countsGet Table CountsGet Table CountsReturns the number of records in a table: active records, or archived records when archived is true.3 fieldsadmin
get_app_server_usageGet App Server UsageGet App Server UsageRetrieves application server usage.3 fieldsadminget_deploy_infoGet Deploy InfoGet Deploy InfoReturns summary deployment info for an app (type, status, access URL, deploy data, and the replicate app's icon properties).1 fieldnoneget_platform_regionsGet Platform RegionsGet Platform RegionsRetrieves platform regions.No fieldsuserget_region_hosting_optionsGet Region Hosting OptionsGet Region Hosting OptionsResolves a macro-region to a farm-first offer plus DigitalOcean datacenters for the region.9 fieldsuserget_suggested_regionGet Suggested RegionGet Suggested RegionSuggests the deploy macro-region from the caller's IP country (Cloudflare cf-ipcountry).1 fielduserpublish_templatesPublish Farm TemplatesPublish Farm TemplatesEnsure every live farm placement node carries the golden deployment + datacenter templates, copying any missing one from a node that has it (vzdump -> scp -> qmrestore -> qm template). dry_run reports the gap without copying.2 fieldsadmin Background jobupdate_app_versionUpdate App VersionUpdate App VersionUpdates application version.1 fieldadmin
agent_domain_connectDomains: connect to this VPSDomains: connect to this VPSPoint one of the account's own domains (from agent_domain_list) at THIS project's VPS via DNS. Optional subdomain (e.g. 'app' -> app.example.com); omit to use the apex. Prefer a subdomain unless the user explicitly wants the apex. Attaching replaces any existing record on that exact hostname.2 fieldsuseragent_domain_listDomains: listDomains: listList the account's registered domains (name, status, which app each is attached to). Use this BEFORE asking the user to type a domain: if they say 'connect one of my domains', call this and present the options.No fieldsuser
check_drive_file_studioCheck Drive File StudioCheck Drive File StudioChecks whether a file or folder already exists in the studio drive.4 fieldsadmincheck_drive_file_userCheck Drive File UserCheck Drive File UserChecks whether a file or folder already exists in the user drive.4 fieldsusercheck_drive_file_workspaceCheck Drive File WorkspaceCheck Drive File WorkspaceChecks whether a file or folder already exists in the workspace drive.4 fieldsadmincheck_drive_files_studioCheck Drive Files StudioCheck Drive Files StudioChecks whether multiple files or folders already exist in the studio drive.5 fieldsadmincheck_drive_files_userCheck Drive Files UserCheck Drive Files UserChecks whether multiple files or folders already exist in the user drive.5 fieldsusercheck_drive_files_workspaceCheck Drive Files WorkspaceCheck Drive Files WorkspaceChecks whether multiple files or folders already exist in the workspace drive.5 fieldsadmincopy_drive_files_userCopy Drive Files UserCopy Drive Files UserCopies drive files/folders (with their full subtree, duplicating the stored bytes) into another folder in the user drive.3 fieldsusercopy_drive_files_workspaceCopy Drive Files WorkspaceCopy Drive Files WorkspaceCopies drive files/folders (with their full subtree, duplicating the stored bytes) into another folder in the workspace drive.3 fieldsadmincreate_drive_folder_studioCreate Drive Folder StudioCreate Drive Folder StudioCreates drive folder for studio drive.5 fieldsadmincreate_drive_folder_userCreate Drive Folder UserCreate Drive Folder UserCreates drive folder for user drive.5 fieldsusercreate_drive_folder_workspaceCreate Drive Folder WorkspaceCreate Drive Folder WorkspaceCreates drive folder for workspace drive.5 fieldsadmindelete_drive_files_studioDelete Drive Files StudioDelete Drive Files StudioDeletes drive files from studio drive.2 fieldsadmindelete_drive_files_userDelete Drive Files UserDelete Drive Files UserDeletes drive files from user drive.3 fieldsuserdelete_drive_files_workspaceDelete Drive Files WorkspaceDelete Drive Files WorkspaceDeletes drive files from workspace drive.2 fieldsadmindelete_file_bulk_studioDelete File Bulk StudioDelete File Bulk StudioDeletes multiple files from the studio drive.2 fieldsadmindelete_file_bulk_userDelete File Bulk UserDelete File Bulk UserDeletes multiple files from the user drive.1 fielduserdelete_file_bulk_workspaceDelete File Bulk WorkspaceDelete File Bulk WorkspaceDeletes multiple files from the workspace drive.2 fieldsadminextract_drive_file_studioExtract Drive File StudioExtract Drive File StudioUnzips an archive file in place: each entry in the archive becomes a new file or folder at the same drive location as the archive.2 fieldsadminextract_drive_file_userExtract Drive File UserExtract Drive File UserUnzips an archive file in place: each entry in the archive becomes a new file or folder at the same drive location as the archive.3 fieldsuserextract_drive_file_workspaceExtract Drive File WorkspaceExtract Drive File WorkspaceUnzips an archive file in place: each entry in the archive becomes a new file or folder at the same drive location as the archive.2 fieldsadminget_drive_breakdown_userGet Drive Breakdown UserGet Drive Breakdown UserStorage breakdown by file type + duplicate groups for the drive. (user drive)No fieldsuserget_drive_breakdown_workspaceGet Drive Breakdown WorkspaceGet Drive Breakdown WorkspaceStorage breakdown by file type + duplicate groups for the drive. (workspace drive)1 fieldadminget_drive_file_info_studioGet Drive File Info StudioGet Drive File Info StudioRetrieves drive file information for studio drive.3 fieldsadminget_drive_file_info_userGet Drive File Info UserGet Drive File Info UserRetrieves drive file information for user drive.4 fieldsuserget_drive_file_info_workspaceGet Drive File Info WorkspaceGet Drive File Info WorkspaceRetrieves drive file information for workspace drive.3 fieldsadminget_drive_file_versions_userGet Drive File Versions UserGet Drive File Versions UserLists a user drive file's versions, newest first: its AI edits and what it held before each Replace, each with its link, out of every listing.2 fieldsuserget_drive_files_studioGet Drive Files StudioGet Drive Files StudioRetrieves drive files for studio drive.12 fieldsadminget_drive_files_userGet Drive Files UserGet Drive Files UserRetrieves drive files for user drive.12 fieldsuserget_drive_files_workspaceGet Drive Files WorkspaceGet Drive Files WorkspaceRetrieves drive files for workspace drive.12 fieldsadminget_drive_size_studioGet Drive Size StudioGet Drive Size StudioReturns the total storage used (bytes) by the studio drive.1 fieldadminget_drive_size_userGet Drive Size UserGet Drive Size UserReturns the total storage used (bytes) by the user drive.No fieldsuserget_drive_size_workspaceGet Drive Size WorkspaceGet Drive Size WorkspaceReturns the total storage used (bytes) by the workspace drive.1 fieldadminget_shared_with_me_files_userGet Shared With Me FilesGet Shared With Me FilesLists drive files and folders shared with the current user.1 fielduserget_trashed_files_userGet Trashed Files UserGet Trashed Files UserLists trashed items (trash roots) for the drive. (user drive)No fieldsuserget_trashed_files_workspaceGet Trashed Files WorkspaceGet Trashed Files WorkspaceLists trashed items (trash roots) for the drive. (workspace drive)1 fieldadminkeep_drive_file_version_userKeep Drive File Version UserKeep Drive File Version UserKeeps what a user drive file holds now as one of its versions (out of every listing), before another version is written into it.2 fieldsusermove_drive_files_userMove Drive Files UserMove Drive Files UserMoves drive files/folders (with their full subtree) into another folder in the user drive.3 fieldsusermove_drive_files_workspaceMove Drive Files WorkspaceMove Drive Files WorkspaceMoves drive files/folders (with their full subtree) into another folder in the workspace drive.3 fieldsadminpurge_trashed_files_userPurge Trashed Files UserPurge Trashed Files UserPermanently deletes trashed batches (docs tombstoned, bytes cleaned). (user drive)1 fielduserpurge_trashed_files_workspacePurge Trashed Files WorkspacePurge Trashed Files WorkspacePermanently deletes trashed batches (docs tombstoned, bytes cleaned). (workspace drive)2 fieldsadminrename_drive_file_studioRename Drive File StudioRename Drive File StudioRenames drive file in studio drive.3 fieldsadminrename_drive_file_userRename Drive File UserRename Drive File UserRenames drive file in user drive.3 fieldsuserrename_drive_file_workspaceRename Drive File WorkspaceRename Drive File WorkspaceRenames drive file in workspace drive.3 fieldsadminrename_drive_folder_studioRename Drive Folder StudioRename Drive Folder StudioRenames drive folder in studio drive.3 fieldsadminrename_drive_folder_userRename Drive Folder UserRename Drive Folder UserRenames drive folder in user drive.3 fieldsuserrename_drive_folder_workspaceRename Drive Folder WorkspaceRename Drive Folder WorkspaceRenames drive folder in workspace drive.3 fieldsadminrestore_trashed_files_userRestore Trashed Files UserRestore Trashed Files UserRestores trashed batches back into the drive. (user drive)1 fielduserrestore_trashed_files_workspaceRestore Trashed Files WorkspaceRestore Trashed Files WorkspaceRestores trashed batches back into the drive. (workspace drive)2 fieldsadminstar_drive_file_studioStar Drive File StudioStar Drive File StudioToggles the starred bookmark on a studio drive item.4 fieldsadminstar_drive_file_userStar Drive File UserStar Drive File UserToggles the starred bookmark on a user drive item.3 fieldsuserstar_drive_file_workspaceStar Drive File WorkspaceStar Drive File WorkspaceToggles the starred bookmark on a workspace drive item.4 fieldsadmintrash_drive_files_userTrash Drive Files UserTrash Drive Files UserMoves drive items (with their subtree) to the trash: soft delete, restorable. (user drive)2 fieldsusertrash_drive_files_workspaceTrash Drive Files WorkspaceTrash Drive Files WorkspaceMoves drive items (with their subtree) to the trash: soft delete, restorable. (workspace drive)2 fieldsadminupdate_drive_addons_studioUpdate Drive Addons StudioUpdate Drive Addons StudioUpdates drive addons for studio drive.5 fieldsadminupdate_drive_addons_userUpdate Drive Addons UserUpdate Drive Addons UserUpdates the drive addon toggles (OCR, image convertor, video AI, AI component generator, edit image) on the user's account drive.4 fieldsuserupdate_drive_addons_workspaceUpdate Drive Addons WorkspaceUpdate Drive Addons WorkspaceUpdates drive addons for workspace drive.5 fieldsadminupdate_drive_file_sharing_mode_studioUpdate Drive File Sharing Mode StudioUpdate Drive File Sharing Mode StudioUpdates drive file sharing mode for studio drive.4 fieldsadminupdate_drive_file_sharing_mode_userUpdate Drive File Sharing Mode UserUpdate Drive File Sharing Mode UserUpdates drive file sharing mode for user drive.4 fieldsuserupdate_drive_file_sharing_mode_workspaceUpdate Drive File Sharing Mode WorkspaceUpdate Drive File Sharing Mode WorkspaceUpdates drive file sharing mode for workspace drive.4 fieldsadminupdate_drive_file_studioUpdate Drive File StudioUpdate Drive File StudioUpdates drive file for studio drive.2 fieldsadminupdate_drive_file_tags_studioUpdate Drive File Tags StudioUpdate Drive File Tags StudioUpdates drive file tags for studio drive.4 fieldsadminupdate_drive_file_tags_userUpdate Drive File Tags UserUpdate Drive File Tags UserUpdates drive file tags for user drive.4 fieldsuserupdate_drive_file_tags_workspaceUpdate Drive File Tags WorkspaceUpdate Drive File Tags WorkspaceUpdates drive file tags for workspace drive.4 fieldsadminupdate_drive_file_userUpdate Drive File UserUpdate Drive File UserUpdates drive file for user drive.2 fieldsuserupdate_drive_file_workspaceUpdate Drive File WorkspaceUpdate Drive File WorkspaceUpdates drive file for workspace drive.2 fieldsadminupload_drive_file_studioUpload Drive File StudioUpload Drive File StudioUploads drive file to studio drive.1 fieldadminupload_drive_file_userUpload Drive File UserUpload Drive File UserUploads drive file to user drive.1 fielduserupload_drive_file_workspaceUpload Drive File WorkspaceUpload Drive File WorkspaceUploads drive file to workspace drive.3 fieldsadmin
archive_emailArchive EmailArchive EmailArchives an email by setting its document stat to archived.1 fielduserdelete_email_accountDelete Email AccountDelete Email AccountSoft-deletes a connected email account by marking its document stat as deleted.1 fielduserget_email_briefGet Email BriefGet Email BriefReturns one sentence, written by the AI from the summaries of today's received mail, saying what came in and what needs the reader. Kept a day and written again only when today's mail changed.5 fieldsuserget_email_overviewGet Email OverviewGet Email OverviewReturns received mail per day for the last days of the reader's calendar and the unread mail per mailbox, for the mail client's band and mailbox lens.4 fieldsuserget_email_read_alongGet Email Read AlongGet Email Read AlongReads a draft alongside the person writing it and writes nothing: what the mail being answered asks and whether the draft answers it, a file the draft mentions that is not attached, and a time it names that the calendar cannot make.9 fieldsuserget_user_emailsGet User EmailsGet User EmailsQueries and returns a user's emails filtered by mailbox, date range, search term, and read status.13 fieldsuserget_user_mailboxesGet User MailboxesGet User MailboxesReturns per-mailbox email counts for the user's active account profile.1 fielduserpause_mailbox_importPause Mailbox ImportPause Mailbox ImportPauses a connected mailbox's import at once (the import's Cancel): nothing more is read or filed for it until Continue syncing (refresh_mailboxes with resume). Answers the mailbox and the import's job as it settled.1 fielduserprocess_pending_emailProcess Pending EmailProcess Pending EmailProcesses a pending email for the user's verified email account, optionally resetting its error state.2 fieldsuserread_emailRead EmailRead EmailMarks an email and its linked chat conversation item as read for the calling user. The counterpart to Unread Email; leaves the mailbox's own seen flag and the message timestamp alone.1 fielduserrefresh_mailboxesRefresh MailboxesRefresh MailboxesFetches new emails for the user's verified email accounts across their active account profiles.1 fieldusertest_emailTest EmailTest EmailRuns a test for email.2 fieldsadminunarchive_emailUnarchive EmailUnarchive EmailPuts an archived email back in its mailbox, at the stat it had before it was archived. An email that is not archived is left as it is.1 fielduserunread_emailUnread EmailUnread EmailMarks an email and its linked chat conversation item as unread.1 fielduser
fw_deleteFirewall: delete definitionFirewall: delete definitionDelete a firewall definition doc by id (superuser only).2 fieldsadminfw_driftFirewall: driftFirewall: driftCompare the stored fleet firewall definitions against what each server actually has and report the differences. Optionally scope to a single server.3 fieldsadminfw_enforceFirewall: enforce (disabled)Firewall: enforce (disabled)Computes the effective ruleset for one server. Without confirm it is a dry run: it returns the rendered rules and a read-back of the rules live on the server, and changes nothing. With confirm true it applies the ruleset live, to a hypervisor host, a hosted virtual machine or a region server; over SSH an apply reverts itself after deadman_secs unless commit is also true. Every run is logged. Platform administrators only.5 fieldsadminfw_getFirewall: getFirewall: getGet one firewall/ipset/server doc by id.1 fieldadminfw_listFirewall: listFirewall: listList fleet firewall definitions, ipsets, or server registry (optionally filter by docType).2 fieldsadminfw_pingFirewall: pingFirewall: pingHealth check of the fleet firewall module.No fieldsadminfw_render_fleetFirewall: render fleet (dry-run)Firewall: render fleet (dry-run)Summary of the effective ruleset for every server. Dry-run only.No fieldsadminfw_render_serverFirewall: render server (dry-run)Firewall: render server (dry-run)Compute the effective firewall ruleset a server WOULD receive. Dry-run only; applies nothing.2 fieldsadminfw_saveFirewall: save definitionFirewall: save definitionUpsert a firewall/ipset/server definition doc (superuser only). Writes config data, does not enforce.1 fieldadmin
ipv4_attachIPv4: (re)attachIPv4: (re)attachAccount: attach an owned IP to a target, switching internal/external.5 fieldsuseripv4_attach_targetsIPv4: attachable targetsIPv4: attachable targetsAccount: list the caller's internal resources (VMs, deployments, datacenters) an IP can attach to.No fieldsuseripv4_external_configIPv4: external attach configIPv4: external attach configAccount: fetch the WG tunnel or proxy config for an externally-attached IP.2 fieldsuseripv4_listIPv4: my addressesIPv4: my addressesAccount: list the caller's IPv4 addresses with state, target, PTR and price.No fieldsuseripv4_parkIPv4: parkIPv4: parkAccount: detach an owned IP to parked ($5).1 fielduseripv4_pool_statusIPv4: pool statusIPv4: pool statusAccount: IPv4 availability + price card for the account's continent.3 fieldsuseripv4_purchaseIPv4: purchase + attachIPv4: purchase + attachAccount: buy a /32 and attach it to an internal target or an external box (a target is required).7 fieldsuseripv4_releaseIPv4: releaseIPv4: releaseAccount: release an owned IP back to the pool (quarantine cooldown, billing stops).1 fielduseripv4_set_ptrIPv4: set reverse DNSIPv4: set reverse DNSAccount: set the PTR (reverse DNS) hostname on an owned IP.2 fieldsuser
delete_app_logsDelete App LogsDelete App LogsSpawns a background job that archives all application logs for the given app.1 fieldadmindelete_user_logsDelete User LogsDelete User LogsSpawns a background job that archives security account logs and deletes the rest for the given user.No fieldsuserget_developer_overviewGet Developer OverviewGet Developer OverviewAggregated API/MCP activity for the account over a time window: totals, per-channel split with matching per-channel error counts (mcp/api/dashboard), top methods, per-key usage, the uncapped count of keys seen, recent errors, and a zero-filled time series of requests and errors (series, bucket_ms). Reports whether the read hit its row cap, in which case every figure is partial.3 fieldsuserget_logsGet LogsGet LogsQueries logs of a given type within a timestamp range, with optional search, paging, and status filters.18 fieldsuserget_logs_countsGet Logs CountsGet Logs CountsReturns grouped log counts by request type or response status within a timestamp range.6 fieldsuserget_security_logsGet Security LogsGet Security LogsFetches the latest 5 security-flagged account logs for the given user and optional app.1 fieldadmin
get_platform_servers_infoGet Platform Servers InfoGet Platform Servers InfoRetrieves platform servers information.No fieldspublicget_price_objGet Price ObjGet Price ObjReturns the configured pricing object (PRICE_OBJ) from server config.1 fielduserget_xuda_servers_infoGet Xuda Servers InfoGet Xuda Servers InfoQueries the xuda_servers database for active application servers and returns their id, countries, status, and datacenters.No fieldspublic
cancel_reminderCancel ReminderCancel ReminderTakes off one of the calling account's pending reminders, so it is never sent, or one that could not be sent.1 fieldusercreate_reminderCreate ReminderCreate ReminderKeeps a reminder for the account calling: at remind_at a notification with the subject and note is sent to it, leading to link. At most 200 can wait at once.6 fieldsuserget_notificationsGet NotificationsGet NotificationsQueries CouchDB for the requesting user's notifications (inbox, outbox, or system) filtered by status and optional date range.15 fieldsuserget_remindersGet RemindersGet RemindersThe pending reminders of the account calling, soonest first; with item_id, only the ones on that thing.2 fieldsuserget_system_notificationsGet System NotificationsGet System NotificationsRetrieves the requesting user's unread system notifications by delegating to get_notifications with the system flag set.11 fieldspublicset_notification_readSet Notification ReadSet Notification ReadMarks a non-system notification as read, recording the read timestamp and request header.1 fieldusersubmit_app_notificationSubmit App NotificationSubmit App NotificationSends a notification to the authorized users of a target app by delegating to submit_notification.9 fieldsadminupdate_reminderUpdate ReminderUpdate ReminderChanges one of the calling account's pending reminders in place (its time, its note and, for words of its own, the words), keeping its id. With again, sets one removed in the last hour, or one that could not be sent, waiting again; at most 200 can wait at once.6 fieldsuser
get_app_pluginsGet App PluginsGet App PluginsRetrieves application plugins.2 fieldsadminget_pluginsGet PluginsGet PluginsRetrieves plugins.6 fieldspublicget_plugins_categoriesGet Plugins CategoriesGet Plugins CategoriesRetrieves plugins categories.No fieldspublicinstall_pluginInstall PluginInstall PluginInstalls the named plugin into the given application.6 fieldsadminuninstall_pluginUninstall PluginUninstall PluginUninstalls the named plugin from the given application.2 fieldsadminupload_pluginUpload PluginUpload PluginUploads plugin.4 fieldsadmin
clear_session_logsClear Session LogsClear Session LogsHandles session logs.1 fieldadminget_host_locationGet Host LocationGet Host LocationWhere a server address or host name sits, by its public IP, for the map on the External VPS screen. Gives nothing for a private address or a name that does not resolve.1 fielduserpoll_cli_authPoll CLI AuthPoll CLI AuthPoll the device-code flow for a CLI access token once the user approves.3 fieldspublicstart_cli_authStart CLI AuthStart CLI AuthBegin the device-code flow used by @xuda.ai/cli to sign a user in.4 fieldspublic
add_contact_memberAdd Contact MemberAdd Contact MemberSends a contact request to another Xuda user, found by email or by account id.4 fieldsuserassign_api_keys_to_user_group_memberAssign Api Keys To User Group MemberAssign Api Keys To User Group MemberAssigns the given API keys to the user group member identified by the team request.2 fieldsadmincancel_shareCancel ShareCancel ShareHandles share.1 fielduserconfirm_shareConfirm ShareConfirm ShareConfirms share.1 fieldusercreate_shareCreate ShareCreate ShareCreates share.16 fieldsusercreate_user_group_join_spaCreate User Group Join LinkCreate User Group Join LinkCreates a shareable user group join link granting access to the specified app.1 fieldadmindecline_shareDecline ShareDecline ShareDeclines share.1 fielduserget_contact_membersGet Contact MembersGet Contact MembersLists the caller's contact requests and connections, each with the other person's contact card.2 fieldsuserget_sharesGet SharesGet SharesRetrieves shares.4 fieldsuserget_user_group_membersGet User Group MembersGet User Group MembersRetrieves user group members.3 fieldsadminremove_shareRemove ShareRemove ShareRemoves share.6 fieldsuserresend_access_invitationResend Access InvitationResend Access InvitationResends the access or share invitation notification for the specified team request.1 fieldadminupdate_shareUpdate ShareUpdate ShareChanges what a share you made allows: its level (read, read and write, admin), and for a profile what the member may see and add.4 fieldsuser
get_support_ticketsGet Support TicketsGet Support TicketsRetrieves support tickets.1 fielduserticket_api_assignAPI: Assign TicketAPI: Assign TicketExternal service: assigns a ticket to a person, by account uid or email. Only someone on this desk's workspace team: the owner, or an accepted member of the workspace (ticket_api_team lists them). Naming the current assignee again changes nothing.3 fieldsuserticket_api_closeAPI: Close TicketAPI: Close TicketExternal service: closes a ticket. A customer reply inside the reopen window still brings it back.2 fieldsuserticket_api_getAPI: Get TicketAPI: Get TicketExternal service: one ticket with its public interactions. Internal notes are never returned.1 fielduserticket_api_listAPI: List TicketsAPI: List TicketsExternal service: lists tickets on the desk owned by the API key, with the same filters as the manager.13 fieldsuserticket_api_replyAPI: Reply To TicketAPI: Reply To TicketExternal service: replies to a ticket as the desk, or as the requester with as_requester. Always public, never an internal note.3 fieldsuserticket_api_set_stageAPI: Set Ticket StageAPI: Set Ticket StageExternal service: moves a ticket to a stage: new, in_progress (being worked), waiting_customer (waiting on the requester) or resolved (marked resolved, still open). A closed ticket is refused unless reopen is true, which opens it again at that stage. Naming the stage an open ticket already has changes nothing. To close a ticket, use ticket_api_close.3 fieldsuserticket_api_submitAPI: Submit TicketAPI: Submit TicketExternal service: opens a ticket on the desk owned by the API key. Requires a plan with full API access.14 fieldsuserticket_api_teamAPI: Get TeamAPI: Get TeamExternal service: the people this desk's tickets can be assigned to, its workspace team (the owner and the accepted members of the workspace), each with uid, name and email, for assignee_uid or assignee_email.No fieldsuserticket_api_topicsAPI: Get TopicsAPI: Get TopicsExternal service: the desk topics and sub topics, so a third party UI can render the picker.No fieldsuser
verify_session_createVerify: create a verification sessionVerify: create a verification sessionCreates a verification session for one of your users and returns a hosted link to send them. Callable with an API key.2 fieldsuserverify_session_listVerify: list verification sessionsVerify: list verification sessionsThe verification sessions you created, newest first, one page per call. Callable with an API key.2 fieldsuserverify_session_resultVerify: read a verification sessionVerify: read a verification sessionThe current status and result of a verification session you created. Callable with an API key.1 fielduser
accept_voice_termsAccept Phone TermsAccept Phone TermsRecords versioned acceptance of Xuda phone, messaging, abuse, and downstream-provider terms.5 fieldsuseractivate_voice_serviceActivate Phone ServiceActivate Phone ServiceIdempotently creates or reuses one Twilio subaccount for the authenticated Xuda customer. Requires parent management credentials on the backend.No fieldsuseradopt_voice_numberAdopt Platform Phone NumberAdopt Platform Phone NumberSuperuser only. Assigns a number Xuda already owns to a business profile without a purchase or a Stripe subscription, and returns it to the platform parent on release instead of releasing it to the carrier.6 fieldsadminattach_voice_numberAttach Voice NumberAttach Voice NumberAttaches one of the account's phone numbers to a profile, giving that profile a line. Its members become ring targets and the AI is told who staffs it. A number can be attached to one profile at a time, and the main profile can never hold one.2 fieldsusercreate_voice_call_intentCreate Phone Call IntentCreate Phone Call IntentCreates a one-time, short-lived, server-authorized outbound call intent for the browser dialer.3 fieldsusercreate_voice_client_call_intentCreate Xuda Call IntentCreate Xuda Call IntentCreates a one-time, short-lived intent for a browser-to-browser Xuda call. No phone number is involved on either side; the target must be an accepted contact.1 fielduserdetach_voice_numberDetach Voice NumberDetach Voice NumberDetaches a phone number from the profile it is attached to. The number is NOT released and keeps its own answering settings and billing, it is simply no longer any profile's line.1 fielduserget_profile_answering_rulesGet Answering RulesGet Answering RulesReturns the answering rules for one line (business hours, ring timeout, which members are rung, forwarding to a mobile, voicemail and recording), what the current plan actually allows, who can be rung, and the option lists for the editor.2 fieldsuserget_voice_agent_optionsGet Voice Agent OptionsGet Voice Agent OptionsReturns the backend-controlled voice and personality-tone menus for the phone AI, so the profile screen renders only valid choices.1 fielduserget_voice_browser_tokenGet Browser Phone TokenGet Browser Phone TokenReturns a short-lived Twilio Voice SDK token scoped to the customer's subaccount and owned profile.2 fieldsuserget_voice_call_transcriptGet Call TranscriptGet Call TranscriptReturns the text transcript turns of one of the authenticated customer's calls. Text only, no audio is recorded.1 fielduserget_voice_compliance_statusGet Phone Compliance StatusGet Phone Compliance StatusReturns terms, KYB, regulatory bundle, and purchase-readiness state for a country.3 fieldsuserget_voice_country_catalogGet Phone Country CatalogGet Phone Country CatalogReturns the backend-controlled country and number-type availability catalog without provider wholesale pricing.No fieldsuserget_voice_identity_requirementsGet Phone Identity RequirementsGet Phone Identity RequirementsReturns the entity types and identity fields a country requires, so the business profile form is built from the backend rule rather than a hard-coded field list.1 fielduserget_voice_number_ratesGet Phone Number RatesGet Phone Number RatesLive provider call and message rates with Xuda markup applied, plus the number's fixed capabilities and the release-and-repurchase policy, for display before a number is bought.2 fieldsuserget_voice_number_setupGet Voice Number SetupGet Voice Number SetupEverything that decides how one phone number answers, in a single read: the profile it is attached to, the account plan entitlements, whether the AI picks up, the voice and personality, the answering rules and the option lists behind them.1 fielduserget_voice_plansGet Voice PlansGet Voice PlansReturns the ACCOUNT's phone plan ladder: the tiers with their prices, features and number allowances, which tier the account is on, whether the plan has been activated, and whether the account is on a paid Xuda plan (the phone product requires one). One plan covers every number the account holds.1 fielduserget_voice_service_statusGet Phone Service StatusGet Phone Service StatusReturns backend readiness and the authenticated account's Twilio subaccount provisioning state.No fieldsuserget_voice_usageGet Phone UsageGet Phone UsageReturns the caller's call and message usage for a window, with estimated and settled amounts kept separate and the monthly spend cap remaining. Excludes number rental, which is billed as a subscription.3 fieldsuserinvestigate_voice_complianceInvestigate Phone ComplianceInvestigate Phone ComplianceSuperuser only. Verifies the submitted identity with a web-searching model and either auto-approves KYB on a confident pass or escalates to a human with findings. Never sets the regulatory bundle, which is a provider fact.3 fieldsadminlist_voice_callsList Phone CallsList Phone CallsReturns the authenticated customer's inbound and outbound call history without provider credentials.3 fieldsuserlist_voice_message_threadsList Phone Message ThreadsList Phone Message ThreadsLists SMS conversations for the authenticated customer with last message, unread count and opt-out state.3 fieldsuserlist_voice_messagesList Phone MessagesList Phone MessagesReturns one SMS conversation in chronological order together with its thread state.2 fieldsuserlist_voice_numbersList Phone NumbersList Phone NumbersLists the authenticated customer's active phone numbers with profile binding, capabilities, routing state, and retail billing.2 fieldsuserlist_voice_profile_membersList Voice Profile MembersList Voice Profile MembersLists the active members of a profile the caller owns.1 fielduserlist_voice_transfer_targetsList Voice Transfer TargetsList Voice Transfer TargetsLists who a live call can be transferred to (the account owner plus the profile members, excluding the caller). Any participant on the call may read it.1 fieldusermark_voice_message_thread_readMark Phone Thread ReadMark Phone Thread ReadClears the unread counter on one SMS conversation.1 fielduserops_list_voice_complianceList Phone Compliance QueueList Phone Compliance QueueSuperuser-only operator queue of customer phone compliance records with terms, KYB and regulatory bundle state. Returns no provider identifiers.3 fieldsadminpreview_voicePreview VoicePreview VoiceReturns a short spoken sample of a voice and personality as base64 audio, so the picker can be heard before it is saved. Cached per voice and tone, and per voice and language for an ElevenLabs voice.3 fieldsuserpurchase_voice_numberPurchase Phone NumberPurchase Phone NumberCharges the recurring Xuda phone rental, acquires the quoted number in the customer's Twilio subaccount, and binds it to the owned profile with rollback on failure.4 fieldsuserquote_voice_numberQuote Phone NumberQuote Phone NumberCreates an expiring retail number-rental quote with the Xuda service fee and versioned pricing snapshotted; wholesale provider cost remains server-only.4 fieldsuserreconcile_voice_bundlesReconcile Phone RegistrationsReconcile Phone RegistrationsSuperuser only: reads every registration still in review back from Twilio, records the decisions and tells each customer. Runs on the voice reconcile cron, behind the status callback.1 fieldadminreconcile_voice_usageReconcile Phone UsageReconcile Phone UsageSuperuser-only. Settles estimated usage rows from the provider's own final price. Safe to re-run; rows already final are skipped.3 fieldsadminrelease_voice_numberRelease Phone NumberRelease Phone NumberReleases an owned Twilio number, stops its recurring Stripe subscription, and removes the profile binding.1 fielduserreview_voice_complianceReview Phone ComplianceReview Phone ComplianceSuperuser-only review record for KYB and Twilio regulatory bundle approval.6 fieldsadminrevoke_voice_profile_memberRevoke Voice Profile MemberRevoke Voice Profile MemberRemoves a member from a profile the caller owns.2 fieldsusersearch_voice_numbersSearch Phone NumbersSearch Phone NumbersSearches only country and number types enabled by the server catalog inside the customer's Twilio subaccount.7 fieldsusersend_voice_announcementSpeak A Message To A ContactSpeak A Message To A ContactPlaces a call from an owned voice-capable number and speaks a typed message to the person who answers, then hangs up. This is the Voice channel of the contact composer: you type, the line says it. Refuses anyone who has opted out on that number, honours the destination allow and block lists and the spend cap, and de-duplicates on the idempotency key so a double press cannot ring twice.5 fieldsusersend_voice_messageSend Phone MessageSend Phone MessageSends a one to one SMS from an owned SMS-capable number, refusing any contact who has opted out and de-duplicating on the idempotency key.5 fieldsuserset_voice_agentSet Voice AgentSet Voice AgentSets the phone AI voice and personality for a profile the caller owns. Unknown voice or tone values are rejected; an empty value clears the field back to the global default.7 fieldsuserset_voice_planSet Voice PlanSet Voice PlanActivates, upgrades or downgrades the account's phone plan, which covers every number it holds. Takes either `tier` (free, phone) or the module plan id (`profile_phone_phone`), so the phone checkout and the module switch call it the same way. One of the two is required. Needs a paid Xuda account. The plan fee is charged once: it rides the first number's subscription and is repriced there, prorated from today.4 fieldsusershare_voice_profileShare Voice ProfileShare Voice ProfileShares a non-main profile with another Xuda user, making them a member who can take its calls and whom the AI knows about. Owner-gated; the main profile cannot be shared.2 fieldsusersubmit_voice_bundleSubmit Phone RegistrationSubmit Phone RegistrationBuilds the account's Twilio registration for a regulated country and number type from its identity, its answers and the documents already sent, asks Twilio whether it meets the regulation, and submits it for review only when it does. Otherwise returns Twilio's reasons and submits nothing.3 fieldsusersubmit_voice_complianceSubmit Phone ComplianceSubmit Phone ComplianceSnapshots the profile identity onto the country compliance record so an approval is auditable against exactly what was reviewed, then starts the AI investigation.2 fieldsusertakeover_voice_callTake Over CallTake Over CallMoves a live call off the AI receptionist onto the caller's browser by replacing the TwiML on the parent call.1 fieldusertransfer_voice_callTransfer Voice CallTransfer Voice CallTransfers a live call to another person on the profile, ringing their browser and their phone in parallel. Allowed for the account owner or a member of the call's profile.2 fieldsuserupdate_profile_answering_rulesUpdate Answering RulesUpdate Answering RulesSaves a profile's answering rules. A setting the current plan does not include is refused with voice_plan_upgrade_required rather than silently dropped.3 fieldsuserupdate_profile_business_identityUpdate Profile Business IdentityUpdate Profile Business IdentityStores the business identity on the profile that will own the number and reports per-country completeness. The profile is the regulated end user, not the account.4 fieldsuserupdate_voice_number_setupUpdate Voice Number SetupUpdate Voice Number SetupSaves the setup for one phone number. Each section is only touched when it is sent, so saving the voice never resets the open hours. A setting the account's plan does not include is refused with voice_plan_upgrade_required rather than silently dropped.4 fieldsuserupload_voice_compliance_documentUpload Phone Registration DocumentUpload Phone Registration DocumentSends one document of a regulated country's Twilio registration straight to Twilio, in the account's own subaccount. The file is the multipart file field (PDF, JPEG or PNG, 10 MB at most). A second upload for the same requirement replaces the first.5 fieldsuser