Default package
Get desktop application:
View/edit binary Protocol Buffers messages
service AgentStore
agent_store.proto:5Manage Agents
rpc CreateAgent (, )
agent_store.proto:6message
agent_store.proto:21optional uint64 point = 2
if not provided, will be generated internally
message
agent_store.proto:25bytes agent_id = 1
uint64 point = 2
rpc DeleteAgent (, )
agent_store.proto:7message
agent_store.proto:30oneof delete_by
bytes agent_id = 1
uint64 point = 2
message
agent_store.proto:36(message has no fields)
rpc GetAgent (, )
agent_store.proto:8message
agent_store.proto:38oneof get_by
bytes agent_id = 1
uint64 point = 2
message
agent_store.proto:45optional bytes agent_id = 1
optional uint64 point = 2
bool exists = 3
rpc GetAgents (, )
agent_store.proto:9message
agent_store.proto:51map<string, string> var_filters = 1
if set, filters the agents to the ones that have the specified key-value pairs
message
agent_store.proto:56map<uint64, bytes> agents = 1
rpc SetVar (, )
agent_store.proto:11message
agent_store.proto:64bytes agent_id = 1
string key = 2
string value = 3
rpc GetVar (, )
agent_store.proto:12message
agent_store.proto:70bytes agent_id = 1
string key = 2
message
agent_store.proto:75bytes agent_id = 1
string key = 2
optional string value = 3
rpc GetVars (, )
agent_store.proto:13message
agent_store.proto:81bytes agent_id = 1
optional string key_prefix = 2
message
agent_store.proto:86bytes agent_id = 1
map<string, bytes> vars = 2
rpc DeleteVar (, )
agent_store.proto:14message
agent_store.proto:91bytes agent_id = 1
string key = 2
service ApexApi
apex_api.proto:4APIs for CLI and Web
rpc GetApexStatus (, )
apex_api.proto:6message
apex_api.proto:56(message has no fields)
message
apex_api.proto:58GetApexStatusResponse.ApexStatus status = 1
string store_address = 3
repeated workers = 10
rpc GetRunningAgents (, )
apex_api.proto:8message
apex_api.proto:34(message has no fields)
message
apex_api.proto:36repeated agents = 10
rpc GetRunningAgent (, )
apex_api.proto:9message
apex_api.proto:40bytes agent_id = 1
message
apex_api.proto:44optional agent = 10
rpc StartAgent (, )
apex_api.proto:10message
apex_api.proto:20========================================================= Agent Management =========================================================
bytes agent_id = 1
message
apex_api.proto:24(message has no fields)
rpc StopAgent (, )
apex_api.proto:11message
apex_api.proto:27bytes agent_id = 1
message
apex_api.proto:31(message has no fields)
service ApexWorkers
apex_workers.proto:6Internal service for worker nodes to communicate with the Apex node
rpc RegisterWorker (, )
apex_workers.proto:8Registers a worker to get ready for a streaming connection.
message
apex_workers.proto:17string worker_id = 1
string worker_address = 2
how to connect to the worker
message
apex_workers.proto:22string ticket = 1
used to connect to the stream
rpc ConnectWorker (stream , stream )
apex_workers.proto:10Connects a long running worker to the apex node via two-way streaming. Worker needs to register first.
message
apex_workers.proto:63WorkerToApexMessage.MessageType type = 1
always required
string worker_id = 2
string ticket = 3
oneof payload
manifest = 10
READY event
assignment = 11
RETURN_AGENT
message
apex_workers.proto:48ApexToWorkerMessage.MessageType type = 1
always required
oneof payload
assignment = 10
GIVE_AGENT, YANK_AGENT
service GritStore
grit_store.proto:5Service methods for Grit object and reference store
rpc Store (, )
grit_store.proto:7message
grit_store.proto:24bytes agent_id = 1
optional bytes object_id = 3
bytes data = 10
rpc Load (, )
grit_store.proto:8message
grit_store.proto:31bytes agent_id = 1
bytes object_id = 3
message
grit_store.proto:36bytes agent_id = 1
bytes object_id = 3
optional bytes data = 10
rpc SetRef (, )
grit_store.proto:10message
grit_store.proto:42bytes agent_id = 1
string ref = 2
bytes object_id = 3
rpc GetRef (, )
grit_store.proto:11message
grit_store.proto:51bytes agent_id = 1
string ref = 2
message
grit_store.proto:56bytes agent_id = 1
string ref = 2
optional bytes object_id = 3
rpc GetRefs (, )
grit_store.proto:12message
grit_store.proto:62bytes agent_id = 1
optional string ref_prefix = 2
message
grit_store.proto:67bytes agent_id = 1
map<string, bytes> refs = 2
service WorkerApi
worker_api.proto:4APIs for CLI and Web
rpc InjectMessage (, )
worker_api.proto:7Sends a message to the recipient actor, the sender is the root actor, which represents the agent.
message
worker_api.proto:16========================================================= Agent or Actor Interactions =========================================================
bytes agent_id = 1
bytes recipient_id = 2
oneof message
bytes message_id = 5
externally crafted message, with a valid message structure (advanced use case)
message_data = 6
message_id will be created by runtime by creating the required Grit objects
message
worker_api.proto:41bytes agent_id = 1
bytes message_id = 2
rpc RunQuery (, )
worker_api.proto:8message
worker_api.proto:46bytes agent_id = 1
bytes actor_id = 2
string query_name = 4
optional bytes context = 5
message
worker_api.proto:53bytes agent_id = 1
32 bytes, of actor_id type
bytes actor_id = 2
32 bytes, actor_id
optional bytes result = 10
can be a tree_id or a serizlized Grit Blob
rpc SubscribeToAgent (, stream )
worker_api.proto:9message
worker_api.proto:59bytes agent_id = 1
TODO: add filters
message
worker_api.proto:64bytes agent_id = 1
bytes sender_id = 2
bytes message_id = 3
optional message_data = 4
message
apex_workers.proto:34Used in: ,
bytes agent_id = 1
32 bytes, of actor_id type
uint64 point = 2
map<string, string> capabilities = 10
what capabilities are requested by the agent
message
apex_workers.proto:41Used in: ,
bytes agent_id = 1
required
optional agent = 2
only needed when giving to worker
message
apex_api.proto:48Used in: ,
bytes agent_id = 1
uint64 point = 2
string worker_id = 3
string worker_address = 4
map<string, string> capabilities = 10
Used in:
PING = 0
GIVE_AGENT = 10
give to worker
YANK_AGENT = 11
take from worker
Used in:
UNKNOWN = 0
STARTING = 1
RUNNING = 2
STOPPING = 3
ERROR = 10
message
worker_api.proto:28Used in: ,
map<string, string> headers = 3
bool is_signal = 4
bytes previous_id = 5
oneof content
bytes content_id = 10
blob_id or tree_id (see Grit Message)
bytes content_blob = 11
valid serialized Grit blob object
BLOB = 0
TREE = 1
MESSAGE = 4
MAILBOX = 5
STEP = 10
message
apex_api.proto:71Used in:
string worker_id = 1
string worker_address = 2
repeated bytes current_agents = 3
map<string, string> capabilities = 10
message
apex_workers.proto:26Used in:
string worker_id = 1
map<string, string> capabilities = 10
what capabilities can it satisfy
repeated current_agents = 20
not allowed to have any workers in it on READY (aka connect)
repeated bytes desired_agents = 21
the agents that the worker wants to have (maybe because it had them previosuly, local caches, etc)
Used in:
PING = 0
READY = 1
start receiving messages from apex
RETURN_AGENT = 11
MANIFEST_UPDATE = 2; // send a manifest update to apex (esp, when capacity changes)
return agent to apex