Engine methods
Every method the Bandicot engine answers, grouped by what it touches, with whether it reads, writes, spends model time or reaches outside.
Available now. A current user-facing path exists within the stated scope.
How to read this list
Each method has an effect: read only looks, write changes Bandicot's state, spends starts model work, and outside reaches the network, a browser, the Mac or other people.
Call any of them with bandicot rpc. The params column is what the method reads; ? marks an optional key. bandicot methods prints the same list from the app you have installed.
Engine and status
Engine and status: 16 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
snapshot | read | {} |
command_list | read | {} |
capabilities_get | read | {} |
workspace_status | read | {} |
workspace_open | write | {path} |
helper_status | read | {} |
helper_restart | write | {helper:browser|team} |
tenancy | read | {} |
data_owner | read | {} |
data_owner_yield | write | {} |
engine_idle | read | {} |
local_owner_status | read | {} |
local_owner_bind | write | {} |
local_owner_unbind | write | {} |
entitlement_apply | write | {grant} |
plan_set | write | {plan, is_admin?, unlimited_profiles?} |
Chats
Chats: 20 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
session_list | read | {} |
session_create | write | {id?, title?, type?, ephemeral?, parent_session_id?} |
session_open | write | {session_id} |
session_activity | write | {} |
session_history | read | {session_id} |
session_read | read | {session_key:{profile_id, project_id:null, session_id} (copy it from session_list), limit?:1..200, direction?:backward|forward, cursor?} |
history_view | read | {session_id, around:1..} |
session_stats | read | {session_id} |
session_rename | write | {session_id, title} |
session_delete | write | {session_id} |
session_compact | spends | {mode?:auto|jev|summary} |
session_rewind_preview | read | {session_id, entry_id, files?, conversation?} |
session_rewind | write | {session_id, preview_id} |
sub_session_decide | spends | {id, decision: start|always|not_now} |
sub_session_resume | spends | {id} |
sub_session_list | read | {parent_session_id?} |
sub_session_stop | write | {id} |
sub_session_archive | write | {id} |
sub_session_thread | read | {parent_session_id} |
sub_session_cost | read | {parent_session_id} |
Runs, steering and answers
Runs, steering and answers: 21 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
prompt | spends | {text, session_id?} |
run_start | spends | {session_key:{profile_id, project_id:null, session_id} (copy it from session_list), idempotency_key, user_text|text, workspace_mode?:root|isolated} |
run_get | read | {run_key} |
run_stop | write | {run_key} |
run_timeline | read | {session_id, before?, limit?, line?} |
session_steer | spends | {run_key, message_id, text} |
steer | spends | {session_id?, message_id, text} |
follow_up | spends | {session_id?, message_id, text} |
session_subscribe | read | {session_key:{profile_id, project_id:null, session_id} (copy it from session_list), cursor?:{session_key, event_seq}, after_seq?} |
session_unsubscribe | read | {subscription_id} |
approval_answer | spends | {request_id, decision, revision?, run_key?, session_id?} |
question_answer | spends | {question_id, revision?, text?, run_key?, session_id?} |
permission_action | spends | {request_id, decision, run_key?, session_id?} |
abort | write | {} |
command | spends | {text} |
tool_run | spends | {name, arguments:{..}, session_id?} |
pause_run | write | {} |
resume_run | write | {} |
efficiency_snapshot | read | {session_id, session_key?, before?, evidence_seq?} |
efficiency_subscribe | read | {session_id?, session_key?, after_seq?, unsubscribe?} |
efficiency_action | spends | {session_id, session_key?, action, retention_days?, runtime_limit_ms?, continue_after_answer?} |
Models, providers and accounts
Models, providers and accounts: 25 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
provider_list | read | {} |
provider_presets | read | {} |
model_list | read | {profile_id?} |
gateway_catalog_get | read | {profile_id?} |
gateway_catalog_refresh | outside | {profile_id?, provider} |
gateway_model_enabled_set | write | {profile_id?, provider, model, enabled} |
gateway_provider_enabled_set | write | {profile_id?, provider, enabled} |
provider_upsert | write | {profile_id?, provider settings} |
provider_remove | write | {profile_id?, provider} |
model_select | write | {profile_id?, provider, model} |
provider_select | write | {provider} |
model_library | outside | {op, id?, repo?, revision?, license?, level?, context?, limit?, refresh?, throttle_bps?} |
usage_ledger | read | {profile_id?, since_ms?, until_ms?} |
model_behavior | read | {profile_id?, since_ms?, until_ms?} |
slow_lane | read | {} |
slow_lane_set | write | {provider:anthropic|openai, on} |
credential_grant | write | {provider} |
account_bind | write | {account_id, email?, name?} |
account_connect | outside | {provider, profile_id?, method?, secret?, device_auth_id?, user_code?, interval?} |
account_login_poll | outside | {provider, profile_id?, authorization_code?, code_verifier?} |
account_disconnect | write | {provider, profile_id?} |
account_unbind | write | {} |
account_usage | read | {provider?} |
ai_usage_limits_get | read | {} |
ai_usage_limits_set | write | {revision, enabled, cap_micros} |
Profiles
Profiles: 12 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
work_profile_catalog | read | {} |
work_profile_select | write | {profile_id} |
work_profile_save | write | {profile_json} |
work_profile_delete | write | {profile_id} |
profile_list | read | {} |
profile_create | write | {name, mode?, parent_profile_id?, avatar_color?, avatar_json?} |
profile_select | write | {id} |
profile_ensure_engineer | write | {} |
profile_update | write | {id, name?, mode?, avatar_color?, avatar_json?} |
profile_rename | write | {id, name} |
profile_delete | write | {id, confirm, sessions?, automations?} |
profile_analytics | read | {profile_id?, since_ms?, until_ms?} |
Settings
Settings: 24 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
settings_get | read | {} |
settings_caps_get | read | {} |
ui_prefs_get | read | {} |
settings_set | write | {axis, value} |
settings_caps_set | write | {caps?, tools?, compaction?, browser_access?, outside_project?, brain_*?, context_*?, jev_*?, plan_chain_auto_continue?} |
settings_folders_get | read | {} |
settings_folders_set | write | {folders_json | path, access} |
ui_prefs_set | write | {base_revision, prefs_json} |
permissions_file_get | read | {} |
permissions_file_save | write | {text} |
agent_style_get | read | {} |
agent_style_save | write | {style?, profile_text?, behaviour?, reset?} |
agent_project_instructions_save | write | {text, workspace?} |
agent_style_apply | write | {} |
decision_settings_get | read | {} |
decision_settings_set | write | {decision:{..}} |
decision_capabilities | read | {} |
decision_run | spends | {decision arguments} |
decision_shadow_tail | read | {limit?} |
rack_get | read | {} |
rack_set | write | {base_revision, state_json} |
rack_compile | write | {} |
rack_speech | read | {} |
rack_transcribe | spends | {audio_base64} |
Memory and plans
Memory and plans: 16 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
memory_list | read | {} |
memory_get | read | {id} |
memory_put | write | {id?, title, text} |
memory_forget | write | {id} |
memory_reveal | outside | {id} |
memory_share | outside | {id, shared} |
memory_share_all | outside | {on} |
memory_team_forget | write | {member, id} |
memory_suggestions | read | {} |
memory_suggestion_keep | write | {scope, id, text?} |
memory_suggestion_dismiss | write | {scope, id} |
memory_suggestion_undo | write | {scope, id} |
memory_tidy_set | write | {jev} |
agent_plan_get | read | {} |
agent_plan_set | write | {steps?, id?, status?, text?} |
plan_edit | write | {session_id, op, expected_revision, scope?, index?, plan_index?, steps?} |
Tools, skills and plugins
Tools, skills and plugins: 12 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
tool_list | read | {} |
agent_list | read | {} |
skill_list | read | {} |
extensions_list | read | {} |
extensions_install | write | {path} |
extensions_trust | write | {path} |
plugin_list | read | {} |
plugin_search | read | {query?} |
plugin_preview | read | {name} |
plugin_install | write | {name, fingerprint} |
plugin_activate | write | {name, fingerprint} |
plugin_deactivate | write | {name} |
Files, artifacts and canvas
Files, artifacts and canvas: 18 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
file_list | read | {dir} |
file_fetch | read | {path} |
artifact_list | read | {} |
artifact_read | read | {id, max_bytes?} |
artifact_edit | write | {id, content} |
artifact_slice | read | {id, offset?, limit?} |
artifact_search | read | {id, pattern, limit?} |
board_get | read | {session_id} |
board_edit | write | {session_id, op, json} |
drawing_get | read | {session_id} |
drawing_edit | write | {session_id, op, json} |
graph_get | read | {} |
mutation_history | read | {} |
mutation_diff | read | {} |
mutation_preview | read | {effect_id, path, old, new?, expected_occurrences?} |
mutation_restore | write | {effect_id} |
mutation_checkpoint | write | {effect_id} |
mutation_resolve | write | {effect_id, decision} |
Versions
Versions: 35 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
versions_list | read | {profile_id?, project_id?, scope?} |
versions_history | read | {profile_id?, project_id?, scope?} |
versions_share | outside | {profile_id?, project_id?, scope?, team_id, share_id?} |
versions_shares | read | {profile_id?, project_id?, scope?} |
versions_unshare | outside | {profile_id?, project_id?, scope?, share_id} |
versions_sync_now | outside | {profile_id?, project_id?, scope?} |
versions_conflicts | read | {profile_id?, project_id?, scope?} |
versions_resolve | write | {profile_id?, project_id?, scope?, path, choice} |
versions_status | read | {profile_id?, project_id?, scope?} |
versions_enroll_preview | read | {profile_id?, project_id?, scope?} |
versions_enroll | write | {profile_id?, project_id?, scope?, confirm:true, preview_id} |
versions_log | read | {profile_id?, project_id?, scope?, limit?, before?} |
versions_runs | read | {profile_id?, project_id?, scope?, limit?, before?} |
versions_run_undo_preview | read | {profile_id?, project_id?, scope?, run_id, paths?} |
versions_run_undo | write | {profile_id?, project_id?, scope?, preview_id, idempotency_key, expected_head?, choices?, hunks?} |
versions_diff | read | {profile_id?, project_id?, scope?, path, version?, offset?, limit?} |
versions_show | read | {profile_id?, project_id?, scope?, path, version?, offset?, limit?} |
versions_restore | write | {profile_id?, project_id?, scope?, action, path, version?, expected_head?, preview_id?, idempotency_key?} |
versions_undo | write | {profile_id?, project_id?, scope?, action, operation?, expected_head?} |
versions_describe | write | {profile_id?, project_id?, scope?, description, expected_head?, operation?} |
versions_storage | read | {profile_id?, project_id?, scope?} |
versions_export_preview | read | {profile_id?, project_id?, scope?, destination, version?} |
versions_export | write | {profile_id?, project_id?, scope?, confirm, preview_id} |
versions_changes | read | {profile_id?, project_id?, scope?, limit?, before?} |
change_preview | read | {profile_id?, project_id?, scope?, change_id} |
change_diff | read | {profile_id?, project_id?, scope?, change_id, path} |
apply_change | write | {profile_id?, project_id?, scope?, preview_id, idempotency_key, expected_head?, choices?, hunks?} |
discard_change | write | {profile_id?, project_id?, scope?, change_id} |
change_choices_set | write | {profile_id?, project_id?, scope?, change_id, choices} |
versions_hunks | read | {profile_id?, project_id?, scope?, path, preview_id? | change_id?} |
versions_mark | write | {profile_id?, project_id?, scope?, label, operation?} |
versions_marks | read | {profile_id?, project_id?, scope?} |
versions_unmark | write | {profile_id?, project_id?, scope?, label} |
versions_folder_restore_preview | read | {profile_id?, project_id?, scope?, path, operation} |
versions_folder_restore | write | {profile_id?, project_id?, scope?, preview_id, expected_head?} |
Versions backups
Versions backups: 8 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
versions_backup_status | read | {} |
versions_backup_now | outside | {} |
versions_backup_disk | write | {name, keep} |
versions_backup_icloud | write | {keep} |
versions_backup_find | read | {icloud?} |
versions_backup_open | read | {path, kit} |
versions_backup_seal | write | {kit, confirm?, old_kit?} |
versions_backup_restore | write | {path, kit} |
Tasks and automations
Tasks and automations: 8 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
tasks_today | read | {since_ms?} |
tasks_list | read | {since_ms?, until_ms?, limit?, model?, outcome?, workspace?} |
automaton_runs | read | {id?, limit?} |
automation_list | read | {} |
automation_upsert | write | {id?, automation fields} |
automation_toggle | write | {id, enabled} |
automation_delete | write | {id} |
automation_run | spends | {id, idempotency_key, expected_revision?, prompt?} |
Browser and computer
Browser and computer: 11 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
browser_status | read | {} |
browser_action | outside | {action, ref?, expression?} |
browser_stream | write | {state, width?, height?, dpr?} |
browser_input | outside | {kind, generation, type?, x?, y?, button?, buttons?, key?, code?, text?, modifiers?} |
browser_navigate | outside | {url} |
browser_history | outside | {action} |
browser_tabs | outside | {action, id?, url?} |
computer_status | read | {} |
computer_permissions | outside | {kind} |
simulator_status | read | {} |
simulator_select | write | {} |
Voice
Voice: 4 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
voice_start | outside | {session_id?, engine?, language?} |
voice_stop | write | {} |
voice_forget | write | {relearn?} |
voice_mute | write | {muted} |
Team roster
Team roster: 5 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
team_snapshot | read | {} |
team_roster_save | write | {members:[{id, name, handle, email, role, status, hue}]} |
team_agent_assign | write | {agent_id, owner_id} |
team_agent_run | spends | {agent_id, text|prompt, session_id?, title?} |
team_sync | read | {} |
Team channels
Team channels: 25 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
team_channel_snapshot | read | {} |
team_channel_set_name | outside | {..} |
team_channel_create | outside | {..} |
team_channel_invite | outside | {..} |
team_channel_revoke_invite | outside | {..} |
team_channel_join | outside | {..} |
team_channel_cancel_join | outside | {..} |
team_channel_send | outside | {..} |
team_channel_channel_create | outside | {..} |
team_channel_channel_rename | outside | {..} |
team_channel_channel_archive | outside | {..} |
team_channel_remove | outside | {..} |
team_channel_forget | write | {..} |
team_channel_sync | outside | {..} |
team_channel_agent_grant | outside | {..} |
team_channel_approve_post | outside | {..} |
team_channel_discard_post | write | {..} |
team_channel_export | write | {..} |
team_channel_transfer | outside | {..} |
team_channel_devices_start | outside | {..} |
team_channel_devices_pair | outside | {..} |
team_channel_devices_check | read | {..} |
team_channel_devices_revoke | outside | {..} |
team_channel_devices_recovery_kit | write | {..} |
team_channel_devices_restore | write | {..} |
Your Macs and phone
Your Macs and phone: 12 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
remote_list | read | {} |
remote_settings | write | {approvals?, run?, reach?, chats?} |
remote_captain | write | {} |
remote_read | read | {method:session_list|session_read, params?, member_id?} |
remote_run | spends | {member_id, automation_id, label?} |
remote_answer | spends | {token, decision, proof?} |
remote_prompt | spends | {member_id, text, session_id?} |
remote_stop | outside | {member_id, run} |
remote_device | outside | {key, push_to?, push_key?} |
remote_power | outside | {change:sleep|wake} |
reachable_get | read | {} |
reachable_set | write | {reachable?, let_sleep?, lid_closed?} |
Setup files and hooks
Setup files and hooks: 8 methods.
Call any of these with bandicot rpc, the method name and its params as JSON. Add --yes to anything that is not a read.
| Method | Effect | Params |
|---|---|---|
setup_status | read | {} |
setup_plan | read | {path?, overwrite?, prune?} |
setup_receipts | read | {} |
setup_apply | write | {fingerprint, allow_sensitive?} |
setup_undo | write | {receipt?, overwrite?} |
setup_export | write | {dir} |
hooks_user_status | read | {} |
hooks_user_trust | write | {} |
Questions
Where does the method list come from?
From the engine's own catalog, which bandicot methods prints. This page is regenerated from it.