User Guide
Advanced

App actions the agent can use

All 106 actions Floatboat's agent can take on the app for you, with what each one does, whether it changes anything, and where it works.

When you say "hide the file browser" or "archive these old tasks," the agent does it for you with a tool called host_action. What it can do is a fixed list. If something isn't on the list, it can't do it and can't work around it.

All 106 actions are listed below. Check here when you're not sure whether you can hand something off, or when you spot a host_action line under More details in a reply and want to know what it did. If you'd rather start with how to ask, read Let Floatboat do it for you.

Before you read the tables

It doesn't ask first. None of these actions show a "run this?" prompt. You ask, it does it. So when you want something deleted, installed, or published, say exactly which one.

The Type column tells you how much an action touches:

  • Read only: looks, changes nothing.
  • View: changes only how the window in front of you looks. Close it or switch back and things go back to how they were.
  • Changes data: changes data on your computer, but in ways you can undo, like renaming, archiving, or changing a shortcut.
  • Bigger impact: deletes, installs, publishes, runs an automation, goes online to check for updates, or quits the app. Be specific when you ask for one of these.

When the type ends in this window, the action only works in the Floatboat window you're chatting in. If the request comes from a chat app on your phone, a scheduled task, a calendar event, or a Memo, there's no such window. The action just fails instead of touching some other window.

Spaces and tasks

Everything for keeping spaces and tasks tidy: finding, creating, renaming, pinning, archiving, and deleting.

ActionWhat it doesType
workspace.listLists the spaces you can seeRead only
workspace.getShows the basics of one spaceRead only
session.listLists tasks, without reading the conversationsRead only
session.getShows a task's status and which model it usesRead only
session.list_messagesReads a task's conversation one page at a timeRead only
session.read_messageReads just part of a very long messageRead only
session.search_messagesSearches the conversations in all your tasks. You can narrow it by space, task, or timeRead only
workspace.createCreates a space from a folder you nameChanges data
workspace.renameRenames a spaceChanges data
workspace.openOpens an existing spaceChanges data
workspace.closeCloses a space you're not using. Nothing is deletedChanges data
workspace.promote_temporaryTurns a temporary space into a regular oneChanges data
workspace.set_pinnedPins or unpins a spaceChanges data
workspace.set_archivedArchives or unarchives a spaceChanges data
session.createCreates a new task in a space, without sending anything yetChanges data
session.openOpens an existing taskChanges data
session.closeCloses a task you're not using. The conversation is keptChanges data
session.renameRenames a taskChanges data
session.forkCopies a task into a new one, with the whole conversation so farChanges data
session.set_pinnedPins or unpins a taskChanges data
session.set_archivedArchives or unarchives a taskChanges data
session.bulk_set_archivedArchives or unarchives tasks you name, up to 50 at a timeChanges data
session.set_modelSwitches a task to a different modelChanges data
workspace.activateSwitches to a space that's already openView · this window
session.activateSwitches to a task that's already openView · this window
session.navigateOpens and shows any task, bringing it back if it was closed or archivedChanges data · this window
session.change_data_processorMoves a task that isn't running to a different model provider. From the next turn on, the earlier conversation goes to the new providerBigger impact
workspace.deleteDeletes an archived space. Only Floatboat's record goes; your files stay putBigger impact
session.deletePermanently deletes an archived task and its conversation. Files stay putBigger impact
session.bulk_deletePermanently deletes archived tasks you name, up to 50 at a time. If any one doesn't match, none are deletedBigger impact

Bulk archive and bulk delete handle up to 50 tasks at a time. If you're clearing out more, ask in a few rounds.

Window and preview

Use these to have it hide a panel, open Settings, or jump to a page in the preview. Most of them only change the window in front of you, not your data. Attaching a reference to the input box is the exception and counts as Changes data.

ActionWhat it doesType
ui.set_panel_visibilityShows or hides the sidebar, file browser, browser, chat, or Combo panelView · this window
ui.open_surfaceOpens the task library, archived spaces, automations, Settings, the command manager, the Combo store, or notificationsView · this window
ui.focus_surfaceSwitches to one of those pages that's already openView · this window
ui.close_surfaceCloses one of those pages. What's inside isn't affectedView · this window
ui.restore_surfaceReopens the page you just closedView · this window
ui.activate_windowBrings the Floatboat window to the frontView · this window
composer.prefillPuts text in the input box without sending itView · this window
composer.attach_referenceAttaches a file or other reference to the input box without sending itChanges data · this window
preview.openOpens a file in previewView · this window
preview.goto_locationJumps the preview to a line, page, or sectionView · this window
preview.reloadReloads the previewView · this window
preview.closeCloses the previewView · this window

Settings, shortcuts, notifications, and your account

Check settings, change shortcuts, deal with notifications, and see your balance.

ActionWhat it doesType
settings.get_preferenceShows what a setting is set toRead only
settings.set_preferenceChanges a setting. Only four can be changed: interface language, theme, sounds, and right-to-left MarkdownChanges data
shortcut.listLists all keyboard shortcutsRead only
shortcut.set_bindingSets a shortcut for an actionChanges data
shortcut.unbindRemoves the shortcut from an actionChanges data
shortcut.resetPuts an action's shortcut back to the defaultChanges data
notification.listLists notifications, as summaries like the titleRead only
notification.set_readMarks a notification read or unreadChanges data
notification.show_nativePops a notification up as a system notificationChanges data
notification.openOpens the page a notification points toView · this window
account.get_summaryShows your account, membership, subscription, and credit balance. Billing details aren't includedRead only
platform.get_runtime_component_statusChecks whether Python and other runtime pieces are installedRead only
platform.set_keep_awakeKeeps your computer from sleeping until a task finishes, for up to 4 hours, then turns itself offChanges data
app.quitQuits Floatboat. If you have unsent input or an unsaved draft, it stops firstBigger impact · this window

Commands, Skills, Combos, and workbenches

This group covers what you've added to Floatboat: saved commands, Skills, Combos, and workbenches. Go by the Type column for each one. Most actions that install, register, submit, or delete count as Bigger impact.

ActionWhat it doesType
command.listLists your saved commandsRead only
command.get_metadataShows the basics of one commandRead only
command.createCreates a command without running itChanges data
command.updateEdits a commandChanges data
command.apply_to_composerPuts a command in the input box without sending itView · this window
command.deleteDeletes a custom commandBigger impact
skill.listLists SkillsRead only
skill.get_metadataShows the basics of one SkillRead only
skill.register_hostRegisters a folder as a place to keep SkillsBigger impact
skill.scan_sourceLooks through a registered folder for Skills, without installing anyBigger impact
skill.installInstalls a Skill it foundBigger impact
skill.import_githubImports a Skill from a fixed version of a GitHub repositoryBigger impact
skill.materializePuts a Skill into another agent tool or into one of your Combo draftsBigger impact
skill.removeRemoves a Skill that isn't in use from another agent toolBigger impact
combo.list_catalogBrowses Combos on the marketplaceRead only
combo.get_marketplace_detailShows the details of one Combo on the marketplaceRead only
combo.list_installedLists the Combos you've installedRead only
combo.get_runtime_statusShows how an installed Combo is runningRead only
combo.installInstalls the current version of a Combo from the marketplaceBigger impact
combo.updateUpdates an installed Combo to the marketplace's current versionBigger impact
combo.set_session_bindingTurns an installed Combo on or off for the current taskBigger impact
combo.uninstallUninstalls a ComboBigger impact
combo.publishSubmits a Combo you made to the marketplace for reviewBigger impact
workbench.listLists the workbenches on your computerRead only
workbench.getShows where a workbench's source lives and how it's runningRead only
workbench.openOpens a workbench in the current space, next to the conversationView · this window

Memos, automations, and calendars

Saving a Memo, running an automation on demand, subscribing to a calendar: it's all here.

ActionWhat it doesType
memo.listLists your Memo titlesRead only
memo.captureSaves some text or content as a new MemoChanges data
memo.openOpens a MemoView · this window
automation.listLists your automationsRead only
automation.getShows how an automation is set upRead only
automation.list_runsShows when an automation has runRead only
automation.get_runShows the status and result of one runRead only
automation.run_nowRuns an automation right nowBigger impact
automation.cancel_runCancels a run that's queued or in progressBigger impact
calendar.list_subscriptionsLists the calendars you subscribe toRead only
calendar.get_guardian_opportunitiesShows which upcoming events Schedule Prep thinks are worth preparing forRead only
calendar.refresh_subscriptionRefreshes a subscribed calendar nowChanges data
calendar.add_subscriptionSubscribes to a calendar link or .ics fileBigger impact
calendar.remove_subscriptionRemoves a calendar subscription, along with the events imported from itBigger impact
calendar.enable_system_sourceConnects your macOS calendar, once you've allowed accessBigger impact
calendar.disable_system_sourceStops reading your macOS calendar. Your own data is keptBigger impact
calendar.publish_feedPublishes a span of your events as a public calendar linkBigger impact

Pages and updates

Have it look up a page you've published, or check for, download, and install a new version.

ActionWhat it doesType
page.getShows the basics of a page you've publishedRead only
update.get_statusShows whether an update is being checked, downloaded, or waiting to installRead only
update.checkChecks the official release channel for a new versionBigger impact
update.downloadDownloads a new version and verifies the fileBigger impact
update.installInstalls the update and restarts. If you have unsent input or an unsaved draft, it stops firstBigger impact · this window

If an app store handles updates for your copy of Floatboat, these four update.* actions aren't there.

Two helper actions

These two don't do anything for you directly. The agent uses them to check what it can do, and whether something went through.

ActionWhat it doesType
host.list_capabilitiesLists the actions it can use right now, in this conversationRead only
host.get_action_statusWhen an action didn't report back, checks whether it actually went throughRead only

If an action is missing from host.list_capabilities, it just can't be used in this conversation. Floatboat still has the feature.

What's not on the list

These either go through a different route or aren't possible at all:

  • Reading and writing files, running commands, and Git. Those use the agent's usual file and terminal tools. Before it writes a file or runs a command, you'll see Permission Required.
  • Settings beyond those four. Change the rest yourself in Settings.
  • Publishing or unpublishing pages. It can only look at pages you've already published.
  • Other apps. It only works on Floatboat itself.

Something not working?

It says an action isn't available. Check whether the action is marked "this window." If it is, ask in the Floatboat window you're chatting in. It won't work from a chat app on your phone or from a scheduled task.

It can't find what you asked it to delete. Deleting only works on archived spaces and tasks. Have it archive first, then ask it to delete.

An action never reported back. Ask it to "check whether that last step went through." It uses host.get_action_status to find out, instead of doing it again.

What's next

On this page