Gateway RPC Methods Reference Methods Reference Overview of all Gateway RPC method namespaces
The Aleph Gateway exposes its functionality through namespaced JSON-RPC 2.0 methods. Each namespace groups related operations, and every method follows the same request/response conventions.
All RPC requests use the JSON-RPC 2.0 envelope:
{ "jsonrpc" : "2.0" , "id" : "unique-id" , "method" : "namespace.method" , "params" : { ... } }
id can be a string, number, or null (null for notifications).method follows the namespace.action naming convention.params is an optional JSON object specific to each method.
Success:
{ "jsonrpc" : "2.0" , "id" : "unique-id" , "result" : { ... } } Error:
{ "jsonrpc" : "2.0" , "id" : "unique-id" , "error" : { "code" : -32601 , "message" : "Method not found" , "data" : null } } Code Name Description -32700 Parse error Malformed JSON -32600 Invalid Request Missing required fields -32601 Method not found Unknown method name -32602 Invalid params Bad or missing parameters -32603 Internal error Server-side failure -32000 Auth required No credentials provided -32001 Auth failed Invalid token or signature -32002 Permission denied Insufficient permissions -32003 Rate limited Too many requests -32004 Resource not found Requested entity does not exist -32005 Timeout Operation timed out -32006 Tool error Tool execution failed
Core agent execution and control. Start runs, stream responses, check status, and manage conversation history.
Full reference -->
Session lifecycle management. Create, list, inspect, export, and delete conversation sessions.
Full reference -->
Runtime configuration management. Read, patch, replace, and reload configuration without restarting the server.
Full reference -->
Command execution approval system. Request, resolve, and manage approval policies for shell commands.
Full reference -->
Multi-step configuration wizards. Start guided setup flows, answer steps, and track wizard progress.
Full reference -->
Scheduled job management. Create, list, trigger, pause, and resume cron jobs that execute agent prompts on a schedule.
Full reference -->
Event subscription and streaming. Subscribe to real-time events using glob patterns.
Full reference -->
Browser automation via Chrome DevTools Protocol. Navigate pages, interact with elements, take screenshots, and extract content.
Full reference -->
These namespaces provide access to extended functionality. Methods marked with * are wired at runtime; stubs/placeholders return errors until their subsystem is initialized.
Namespace Methods Description auth.*connect, pairing.approve, pairing.reject, pairing.list, devices.list, devices.revoke, auth.show_token, auth.reset_token, auth.list_sessions, auth.revoke_sessionAuthentication and device management agents.*list, get, create, update, delete, set_default, files.list, files.get, files.set, files.delete, tools_schema, bindings, teamsAgent CRUD and file management sessions.*list, history, reset, delete, new, set_topic, patch, preview, compaction.list, compaction.restore, compaction.branchSession lifecycle (plural namespace) session.*create, usage, compactSession operations (singular namespace) channels.*list, status, set_agentChannel management channel.*start, stop, pairing_data, send, create, deleteSingle channel operations
Namespace Methods Description config.*reload, get, validate, path, get_tool_permissions, update_tool_permissionsRuntime configuration providers.*list, get, create, update, delete, setDefault, test, needsSetup, oauthLogin, oauthLogout, oauthStatusAI provider management agent_config.*get, update, get_file_ops, update_file_ops, get_code_exec, update_code_exec, get_tool_permissions, update_tool_permissionsPer-agent configuration general_config.*get, updateGeneral settings browser_config.*get, updateBrowser automation settings behavior_config.*get, updateAgent behavior settings generation_config.*get, updateGeneration settings execution_config.*get, updateExecution settings memory_config.*get, updateMemory system settings mcp_config.*list, get, create, update, deleteMCP server configuration rerank_config.*get, update, testReranker configuration search_config.*get, update, test, deleteBackendSearch backend configuration security_config.*get, update, list_devices, revoke_deviceSecurity settings routing_rules.*list, get, create, update, delete, moveTask routing rules
Namespace Methods Description memory.*search, stats, delete, clear, listFacts, clearFacts, appList, compress, reembed, reembed.cancel, retrieve_with_traceMemory system graph.*query, neighbors, node_detail, searchKnowledge graph
Namespace Methods Description skills.*status, update, install_dep, remove, installSkill System v2 management plugin.*list, install, installFromZip, uninstall, enable, disable, load, unload, reload, callTool, executeCommandPlugin lifecycle (canonical) plugins.*list, install, installFromZip, uninstall, enable, disable, load, unload, callTool, executeCommandPlugin lifecycle (legacy) plugin.marketplace.*list, add, update, remove, installPlugin marketplace tools.*catalog, effectiveTool visibility commands.*list, executeCommand discovery and execution
Namespace Methods Description agent.*run, status, cancel, respondToInput, listAgent execution control chat.*send, abort, history, clearChat interface run.*wait, queue_messageRun lifecycle (from runs.rs)
Namespace Methods Description group_chat.*start, continue, mention, end, list, historyMulti-agent group chat teams.*list, get, disband, deleteTeam management arena.*create, query, settleMulti-agent arena clawhub.*search, browse, detail, installClawHub agent registry
Namespace Methods Description cron.*list, get, create, update, delete, status, run, runs, toggleScheduled jobs heartbeat.*list, get, create, update, delete, toggle, wake, runsHeartbeat probes services.*start, stop, list, statusBackground services
Namespace Methods Description system.*infoSystem metrics healthhealthHealth check versionversionServer version echoechoEcho test logs.*getLevel, setLevel, getDirectoryLog management daemon.*status, shutdown, logsDaemon control trace.*list, getTrace replay activity.*statsActivity statistics
Namespace Methods Description identity.*get, set, clear, listIdentity/soul management guests.*createInvitation, listPending, revokeInvitation, listSessions, terminateSession, getActivityLogsGuest session management
Namespace Methods Description workspace.*create, list, get, update, archiveWorkspace isolation runtimes.*list, refresh, installRuntime capability management
Namespace Methods Description generation_providers.*list, get, create, update, delete, setDefault, test, voicesMedia generation providers embedding_providers.*list, get, add, update, remove, setActive, test, presetsEmbedding providers
Namespace Methods Description mcp.*list_pending_approvals, respond_approval, cancel_approvalMCP approval handling acp.*list, get, create, update, delete, test, set_enabled, presets, presets_metaACP harness config
Namespace Methods Description schema.*list, get, protocol, openapiSchema introspection config.schemaconfig.schemaConfig schema
Namespace Methods Description discord.*validate_token, save_config, list_guilds, list_channels, audit_permissions, update_allowlistsDiscord control panel
Methods that return lists accept optional limit and offset parameters:
{ "jsonrpc" : "2.0" , "id" : 1 , "method" : "session.list" , "params" : { "limit" : 20 , "offset" : 0 } } List methods support an optional filter parameter for narrowing results:
{ "jsonrpc" : "2.0" , "id" : 1 , "method" : "cron.list" , "params" : { "filter" : { "enabled" : true , "agent_id" : "main" } } } Methods like agent.run trigger streaming events. Subscribe to stream.* topics to receive real-time data:
// 1. Subscribe to stream events { "jsonrpc" : "2.0" , "id" : 1 , "method" : "events.subscribe" , "params" : { "patterns" : [ "stream.*" ] } } // 2. Start an agent run { "jsonrpc" : "2.0" , "id" : 2 , "method" : "agent.run" , "params" : { "message" : "Hello" } } // 3. Receive stream events (no id = notification) { "jsonrpc" : "2.0" , "method" : "event" , "params" : { "topic" : "stream.chunk" , "data" : { "text" : "Hi!" } } }