Skip to content

storage:session

FieldValue
Prefixstorage:session
Namespace constantSessionStorageNamespace
Subjects constantSessionStorageSubjects
Kindstorage
Schema record<inline>
Tierframework
Package@makaio/contracts
Defined inpackages/contracts/src/session/session-storage-namespace.ts
KeyWireTypeSchema
deletestorage:session.deleterpc
getstorage:session.getrpc
getByAdapterSessionIdstorage:session.getByAdapterSessionIdrpc
getChildrenstorage:session.getChildrenrpc
getStatusCountsstorage:session.getStatusCountsrpc
liststorage:session.listrpc
searchstorage:session.searchrpc
setstorage:session.setrpc
updatestorage:session.updaterpc

Delete a session by ID.

Subject: storage:session.delete Type: Request (RPC)

Request:

FieldTypeRequired
sessionIdstringyes

Response:

FieldTypeRequired
successbooleanyes

Get a session by ID.

Subject: storage:session.get Type: Request (RPC)

Request:

FieldTypeRequired
sessionIdstringyes

Response:

FieldTypeRequired
session{ sessionId: string; createdAt: number; lastActivityAt: number; agents: { agentId: string; adapterId: string; adapterName: string; sessionId: string; role: "lead" | "member"; status: "active" | "idle" | "dead" | "disposed"; createdAt: number; lastActivityAt: number; adapterSessionId?: string | undefined; model?: string | undefined; cwd?: string | undefined; providerConfigId?: string | undefined; personaId?: string | undefined; profileId?: string | undefined; harnessId?: string | undefined; clientId?: string | undefined; compressionMode?: "auto" | "manual" | "off" | undefined; }[]; status: "discovered" | "active" | "closed" | "archived"; leadAgentId?: string | undefined; parentSessionId?: string | undefined; rootSessionId?: string | undefined; forkPointMessageId?: string | undefined; branchKind?: "fork" | "subagent" | "compress" | "branch" | "rewrite" | "coordinator" | "aside" | undefined; adapterName?: string | undefined; adapterSessionId?: string | undefined; adapterId?: string | undefined; clientId?: string | undefined; clientAccountId?: string | undefined; lastClientIdentityObservation?: { clientId: string; source: string; kind: string; observedAt: number; payload: Record<string, unknown>; } | undefined; isOrchestrated?: boolean | undefined; title?: string | undefined; summary?: string | undefined; summaryUpdatedAt?: number | undefined; isImported?: boolean | undefined; forkTransforms?: { removedMessageIds?: string[] | undefined; appliedPipeline?: { actionId: string; options?: Record<string, unknown> | undefined; }[] | undefined; segments?: { fromMessageId: string; toMessageId: string; policy: "verbatim" | "summarize" | "exclude"; stripReasoning?: boolean | undefined; stripToolOutputs?: boolean | undefined; overrides?: Record<string, "exclude"> | undefined; summaryText?: string | undefined; }[] | undefined; } | undefined; targetWorkingDirectory?: string | undefined; executionTargetId?: string | undefined; spawningToolCallId?: string | undefined; approvalPolicyOverride?: "reject" | "always-ask" | "full-access" | null | undefined; } | nullyes

storage:session.getByAdapterSessionId (rpc)

Section titled “storage:session.getByAdapterSessionId (rpc)”

Get a session by its adapter session ID.

Subject: storage:session.getByAdapterSessionId Type: Request (RPC)

Request:

FieldTypeRequired
adapterSessionIdstringyes

Response:

FieldTypeRequired
session{ sessionId: string; createdAt: number; lastActivityAt: number; agents: { agentId: string; adapterId: string; adapterName: string; sessionId: string; role: "lead" | "member"; status: "active" | "idle" | "dead" | "disposed"; createdAt: number; lastActivityAt: number; adapterSessionId?: string | undefined; model?: string | undefined; cwd?: string | undefined; providerConfigId?: string | undefined; personaId?: string | undefined; profileId?: string | undefined; harnessId?: string | undefined; clientId?: string | undefined; compressionMode?: "auto" | "manual" | "off" | undefined; }[]; status: "discovered" | "active" | "closed" | "archived"; leadAgentId?: string | undefined; parentSessionId?: string | undefined; rootSessionId?: string | undefined; forkPointMessageId?: string | undefined; branchKind?: "fork" | "subagent" | "compress" | "branch" | "rewrite" | "coordinator" | "aside" | undefined; adapterName?: string | undefined; adapterSessionId?: string | undefined; adapterId?: string | undefined; clientId?: string | undefined; clientAccountId?: string | undefined; lastClientIdentityObservation?: { clientId: string; source: string; kind: string; observedAt: number; payload: Record<string, unknown>; } | undefined; isOrchestrated?: boolean | undefined; title?: string | undefined; summary?: string | undefined; summaryUpdatedAt?: number | undefined; isImported?: boolean | undefined; forkTransforms?: { removedMessageIds?: string[] | undefined; appliedPipeline?: { actionId: string; options?: Record<string, unknown> | undefined; }[] | undefined; segments?: { fromMessageId: string; toMessageId: string; policy: "verbatim" | "summarize" | "exclude"; stripReasoning?: boolean | undefined; stripToolOutputs?: boolean | undefined; overrides?: Record<string, "exclude"> | undefined; summaryText?: string | undefined; }[] | undefined; } | undefined; targetWorkingDirectory?: string | undefined; executionTargetId?: string | undefined; spawningToolCallId?: string | undefined; approvalPolicyOverride?: "reject" | "always-ask" | "full-access" | null | undefined; } | nullyes

List direct child sessions for a parent session.

Subject: storage:session.getChildren Type: Request (RPC)

Request:

FieldTypeRequired
sessionIdstringyes

Response:

FieldTypeRequired
children{ sessionId: string; title: string | null; forkPointMessageId: string | null; branchKind: "fork" | "subagent" | "compress" | "branch" | "rewrite" | "coordinator" | "aside" | null; messageCount: number; hasChildren: boolean; spawningToolCallId?: string | undefined; }[]yes

Get session counts by status.

Subject: storage:session.getStatusCounts Type: Request (RPC)

Request:

Empty object.

Response:

FieldTypeRequired
activenumberyes
allnumberyes
archivednumberyes
closednumberyes
discoverednumberyes

List sessions with optional status filter and preview data.

Subject: storage:session.list Type: Request (RPC)

Request:

FieldTypeRequired
executionTargetIdstring | undefinedno
includePreviewboolean | undefinedno
limitnumber | undefinedno
offsetnumber | undefinedno
status"discovered" | "active" | "closed" | "archived" | "all" | undefinedno

Response:

FieldTypeRequired
sessions{ sessionId: string; createdAt: number; lastActivityAt: number; agents: { agentId: string; adapterId: string; adapterName: string; sessionId: string; role: "lead" | "member"; status: "active" | "idle" | "dead" | "disposed"; createdAt: number; lastActivityAt: number; adapterSessionId?: string | undefined; model?: string | undefined; cwd?: string | undefined; providerConfigId?: string | undefined; personaId?: string | undefined; profileId?: string | undefined; harnessId?: string | undefined; clientId?: string | undefined; compressionMode?: "auto" | "manual" | "off" | undefined; }[]; status: "discovered" | "active" | "closed" | "archived"; leadAgentId?: string | undefined; parentSessionId?: string | undefined; rootSessionId?: string | undefined; forkPointMessageId?: string | undefined; branchKind?: "fork" | "subagent" | "compress" | "branch" | "rewrite" | "coordinator" | "aside" | undefined; adapterName?: string | undefined; adapterSessionId?: string | undefined; adapterId?: string | undefined; clientId?: string | undefined; clientAccountId?: string | undefined; lastClientIdentityObservation?: { clientId: string; source: string; kind: string; observedAt: number; payload: Record<string, unknown>; } | undefined; isOrchestrated?: boolean | undefined; title?: string | undefined; summary?: string | undefined; summaryUpdatedAt?: number | undefined; isImported?: boolean | undefined; forkTransforms?: { removedMessageIds?: string[] | undefined; appliedPipeline?: { actionId: string; options?: Record<string, unknown> | undefined; }[] | undefined; segments?: { fromMessageId: string; toMessageId: string; policy: "verbatim" | "summarize" | "exclude"; stripReasoning?: boolean | undefined; stripToolOutputs?: boolean | undefined; overrides?: Record<string, "exclude"> | undefined; summaryText?: string | undefined; }[] | undefined; } | undefined; targetWorkingDirectory?: string | undefined; executionTargetId?: string | undefined; spawningToolCallId?: string | undefined; approvalPolicyOverride?: "reject" | "always-ask" | "full-access" | null | undefined; preview?: { messageCount: number; firstUserMessage: string | null; } | undefined; }[]yes
totalnumberyes

Search sessions by content using FTS5.

Subject: storage:session.search Type: Request (RPC)

Request:

FieldTypeRequired
isImportedboolean | undefinedno
limitnumber | undefinedno
querystringyes
status"discovered" | "active" | "closed" | "archived" | "all" | undefinedno

Response:

FieldTypeRequired
sessions{ sessionId: string; createdAt: number; lastActivityAt: number; agents: { agentId: string; adapterId: string; adapterName: string; sessionId: string; role: "lead" | "member"; status: "active" | "idle" | "dead" | "disposed"; createdAt: number; lastActivityAt: number; adapterSessionId?: string | undefined; model?: string | undefined; cwd?: string | undefined; providerConfigId?: string | undefined; personaId?: string | undefined; profileId?: string | undefined; harnessId?: string | undefined; clientId?: string | undefined; compressionMode?: "auto" | "manual" | "off" | undefined; }[]; status: "discovered" | "active" | "closed" | "archived"; preview: { messageCount: number; firstUserMessage: string | null; }; leadAgentId?: string | undefined; parentSessionId?: string | undefined; rootSessionId?: string | undefined; forkPointMessageId?: string | undefined; branchKind?: "fork" | "subagent" | "compress" | "branch" | "rewrite" | "coordinator" | "aside" | undefined; adapterName?: string | undefined; adapterSessionId?: string | undefined; adapterId?: string | undefined; clientId?: string | undefined; clientAccountId?: string | undefined; lastClientIdentityObservation?: { clientId: string; source: string; kind: string; observedAt: number; payload: Record<string, unknown>; } | undefined; isOrchestrated?: boolean | undefined; title?: string | undefined; summary?: string | undefined; summaryUpdatedAt?: number | undefined; isImported?: boolean | undefined; forkTransforms?: { removedMessageIds?: string[] | undefined; appliedPipeline?: { actionId: string; options?: Record<string, unknown> | undefined; }[] | undefined; segments?: { fromMessageId: string; toMessageId: string; policy: "verbatim" | "summarize" | "exclude"; stripReasoning?: boolean | undefined; stripToolOutputs?: boolean | undefined; overrides?: Record<string, "exclude"> | undefined; summaryText?: string | undefined; }[] | undefined; } | undefined; targetWorkingDirectory?: string | undefined; executionTargetId?: string | undefined; spawningToolCallId?: string | undefined; approvalPolicyOverride?: "reject" | "always-ask" | "full-access" | null | undefined; }[]yes
totalnumberyes

Store or update a session.

Subject: storage:session.set Type: Request (RPC)

Request:

FieldTypeRequired
ifAbsentboolean | undefinedno
session{ sessionId: string; createdAt: number; lastActivityAt: number; agents: { agentId: string; adapterId: string; adapterName: string; sessionId: string; role: "lead" | "member"; status: "active" | "idle" | "dead" | "disposed"; createdAt: number; lastActivityAt: number; adapterSessionId?: string | undefined; model?: string | undefined; cwd?: string | undefined; providerConfigId?: string | undefined; personaId?: string | undefined; profileId?: string | undefined; harnessId?: string | undefined; clientId?: string | undefined; compressionMode?: "auto" | "manual" | "off" | undefined; }[]; status: "discovered" | "active" | "closed" | "archived"; leadAgentId?: string | undefined; parentSessionId?: string | undefined; rootSessionId?: string | undefined; forkPointMessageId?: string | undefined; branchKind?: "fork" | "subagent" | "compress" | "branch" | "rewrite" | "coordinator" | "aside" | undefined; adapterName?: string | undefined; adapterSessionId?: string | undefined; adapterId?: string | undefined; clientId?: string | undefined; clientAccountId?: string | undefined; lastClientIdentityObservation?: { clientId: string; source: string; kind: string; observedAt: number; payload: Record<string, unknown>; } | undefined; isOrchestrated?: boolean | undefined; title?: string | undefined; summary?: string | undefined; summaryUpdatedAt?: number | undefined; isImported?: boolean | undefined; forkTransforms?: { removedMessageIds?: string[] | undefined; appliedPipeline?: { actionId: string; options?: Record<string, unknown> | undefined; }[] | undefined; segments?: { fromMessageId: string; toMessageId: string; policy: "verbatim" | "summarize" | "exclude"; stripReasoning?: boolean | undefined; stripToolOutputs?: boolean | undefined; overrides?: Record<string, "exclude"> | undefined; summaryText?: string | undefined; }[] | undefined; } | undefined; targetWorkingDirectory?: string | undefined; executionTargetId?: string | undefined; spawningToolCallId?: string | undefined; approvalPolicyOverride?: "reject" | "always-ask" | "full-access" | null | undefined; }yes
sessionIdstringyes

Response:

FieldTypeRequired
clientAccountChangedboolean | undefinedno
successbooleanyes

Update specific fields of a session (partial update).

Subject: storage:session.update Type: Request (RPC)

Request:

FieldTypeRequired
approvalPolicyOverride"reject" | "always-ask" | "full-access" | null | undefinedno
branchKind"fork" | "subagent" | "compress" | "branch" | "rewrite" | "coordinator" | "aside" | undefinedno
clientAccountIdstring | undefinedno
clientIdstring | undefinedno
createdAtnumber | undefinedno
executionTargetIdstring | null | undefinedno
forkPointMessageIdstring | undefinedno
isOrchestratedboolean | undefinedno
lastActivityAtnumber | undefinedno
lastClientIdentityObservation{ clientId: string; source: string; kind: string; observedAt: number; payload: Record<string, unknown>; } | undefinedno
parentSessionIdstring | undefinedno
rootSessionIdstring | undefinedno
sessionIdstringyes
spawningToolCallIdstring | null | undefinedno
status"discovered" | "active" | "closed" | "archived" | undefinedno
targetWorkingDirectorystring | undefinedno
titlestring | undefinedno

Response:

FieldTypeRequired
clientAccountChangedboolean | undefinedno
successbooleanyes

Auto-generated by yarn docs:bus. Do not edit manually.