Skip to content
docs/API reference/SessionService

SessionService

The SessionService methods and their request and response messages.

Generated from session.proto. Every method is POST /rpc/engram.app.v1.SessionService/<Method> with a JSON or protobuf body and an x-api-key header.

Method Request Response
ListSessions ListSessionsRequest ListSessionsResponse
CreateSession CreateSessionRequest CreateSessionResponse
GetSession GetSessionRequest GetSessionResponse
DeleteSession DeleteSessionRequest DeleteSessionResponse
SendPrompt SendPromptRequest SendPromptResponse
Interrupt InterruptRequest InterruptResponse
EditQueuedPrompt EditQueuedPromptRequest EditQueuedPromptResponse
DequeueQueuedPrompt DequeueQueuedPromptRequest DequeueQueuedPromptResponse
CompleteToolCall CompleteToolCallRequest CompleteToolCallResponse
StreamEvents StreamEventsRequest SessionEvent (stream)
ListSessionEvents ListSessionEventsRequest ListSessionEventsResponse
Exec ExecRequest ExecOutput (stream)
CancelExec CancelExecRequest CancelExecResponse
WriteFile WriteFileRequest (stream) WriteFileResponse
ReadFile ReadFileRequest ReadFileResponse (stream)
CopyFiles CopyFilesRequest CopyFilesResponse
GetLog GetLogRequest GetLogResponse
Snapshot SnapshotRequest SnapshotResponse
EnsureBrowser EnsureBrowserRequest EnsureBrowserResponse
EnsureIde EnsureIdeRequest EnsureIdeResponse
Resume ResumeRequest ResumeResponse
EvictLocal EvictLocalRequest EvictLocalResponse
EvictIdle EvictIdleRequest EvictIdleResponse
GetCowState GetCowStateRequest GetCowStateResponse
ListCheckpoints ListCheckpointsRequest ListCheckpointsResponse
GetArtifact GetArtifactRequest GetArtifactResponse (stream)
CreateArtifactFromPath CreateArtifactFromPathRequest CreateArtifactFromPathResponse
Field Type
hostname string
port uint32
Field Type
media_type string
size_bytes uint64
file_name string
Field Type
session_id string
exec_id string

No fields.

Field Type
snapshot_id string
created_at string
size_bytes uint64
events_cursor int64 (optional)
recoverable bool
is_latest bool
Field Type
session_id string
tool_call_id string
result_json string
Field Type
session_id string
note string
Field Type
idx int64
kind string
at string
payload_json string
Field Type
path string
size_bytes uint64
sha256 string
Field Type
source_session_id string
target_session_id string
paths repeated string
Field Type
files repeated CopyFileResult
Field Type
sandbox_id string
session_id string (optional)
disk_manifest_id string
disk_manifest_version uint64
dirty_chunks uint32
dirty_bytes uint64
last_flush_at string (optional)
base_chunks uint32
base_chunks_local uint32
memory_manifest_id string (optional)
memory_manifest_version uint64 (optional)
last_snapshot_at string (optional)
Field Type
session_id string
path string
caption string (optional)
suppress_event bool
Field Type
artifact_id string
media_type string
size_bytes uint64
Field Type
image_uri string
mode string
prompt string (optional)
prompt_id string (optional)
secrets map<string, string>
harness_env map<string, string>
selected_skills repeated string
capabilities repeated string
integration_policy_json string
harness string (optional)
oauth_credential OAuthCredentialBinding
harness_mode string (optional)
requested_session_id string (optional)
apps repeated AppEndpoint
Field Type
session_id string
status string
image_version string
kind string
Field Type
session_id string

No fields.

Field Type
session_id string
prompt_id string
Field Type
session_id string
note string
Field Type
session_id string
prompt_id string
text string
Field Type
session_id string
note string
Field Type
session_id string
Field Type
port uint32
Field Type
session_id string
Field Type
port uint32
Field Type
session_id string
Field Type
session_id string
status string
Field Type
session_id string

No fields.

Field Type
exit_status int32 (optional)
rusage ExecRusage
Field Type
started ExecStarted (one of event)
stdout bytes (one of event)
stderr bytes (one of event)
exit ExecExit (one of event)
Field Type
session_id string
command string (optional)
argv repeated string
env map<string, string>
workdir string (optional)
timeout_secs uint64 (optional)
exec_id string (optional)
stdout_offset uint64 (optional)
stderr_offset uint64 (optional)
wake bool (optional)
Field Type
wall_ms uint64
peak_rss_kb uint64 (optional)
user_cpu_ms uint64 (optional)
sys_cpu_ms uint64 (optional)
Field Type
exec_id string
Field Type
session_id string
artifact_id string
Field Type
metadata ArtifactMetadata (one of msg)
chunk bytes (one of msg)
Field Type
session_id string
Field Type
session_id string
state CowStateView (optional)
Field Type
session_id string
kind string (optional)
limit int64 (optional)
tail bool (optional)
Field Type
session_id string
kind string
events repeated ConversationEntry
Field Type
session_id string
Field Type
session Session
Field Type
session_id string
source string
Field Type
session_id string
note string
Field Type
session_id string
Field Type
session_id string
checkpoints repeated CheckpointSummary
Field Type
session_id string
after_idx int64 (optional)
limit int64 (optional)
before_idx int64 (optional)
kinds repeated string
tool_names repeated string
Field Type
events repeated SessionEvent
next_after_idx int64

No fields.

Field Type
sessions repeated SessionListItem
Field Type
subject OAuthSubject
provider string
Field Type
path string
size_bytes uint64
sha256 string
file_name string
Field Type
session_id string
path string
Field Type
metadata ReadFileMetadata (one of frame)
chunk bytes (one of frame)
Field Type
session_id string
Field Type
session_id string
snapshot_id string (optional)
size_bytes uint64 (optional)
note string
Field Type
session_id string
text string
prompt_id string
harness_mode string (optional)
Field Type
session_id string
note string
Field Type
id string
status string
host_id string (optional)
sandbox_id string (optional)
image string
mode string
created_at string
last_active_at string
suggested_title string (optional)
last_event_at string (optional)
Field Type
idx int64 (optional)
kind string
payload_json string
Field Type
session Session
owner_email string (optional)
owner_name string (optional)
owner_kind string (optional)
Field Type
session_id string
Field Type
session_id string
snapshot_id string (optional)
size_bytes uint64 (optional)
note string
Field Type
session_id string
since int64 (optional)
durable_only bool
Field Type
session_id string
path string
size_bytes uint64
sha256 string
mode uint32 (optional)
Field Type
metadata WriteFileMetadata (one of frame)
chunk bytes (one of frame)
Field Type
path string
size_bytes uint64
sha256 string