Skip to content

Graphorin API reference v0.15.1


Graphorin API reference / @graphorin/server / / SessionApi

Interface: SessionApi ​

Defined in: packages/server/src/routes/sessions.ts:31

Stable

Minimal contract route handlers consume. Real deployments wire @graphorin/sessions.SessionManager in directly; tests pass a lighter stub.

Methods ​

create() ​

ts
create(input): Promise<unknown>;

Defined in: packages/server/src/routes/sessions.ts:37

Parameters ​

ParameterType
input{ agentId: string; sessionId?: string; tags?: readonly string[]; title?: string; userId: string; }
input.agentIdstring
input.sessionId?string
input.tags?readonly string[]
input.title?string
input.userIdstring

Returns ​

Promise&lt;unknown&gt;


exportSession()? ​

ts
optional exportSession(sessionId, opts): Promise<unknown>;

Defined in: packages/server/src/routes/sessions.ts:50

Parameters ​

ParameterType
sessionIdstring
opts{ hash?: boolean; includeAuditEntries?: boolean; }
opts.hash?boolean
opts.includeAuditEntries?boolean

Returns ​

Promise&lt;unknown&gt;


get() ​

ts
get(sessionId): Promise<unknown>;

Defined in: packages/server/src/routes/sessions.ts:36

Parameters ​

ParameterType
sessionIdstring

Returns ​

Promise&lt;unknown&gt;


list() ​

ts
list(opts): Promise<readonly unknown[]>;

Defined in: packages/server/src/routes/sessions.ts:32

Parameters ​

ParameterType
opts{ agentId?: string; userId?: string; }
opts.agentId?string
opts.userId?string

Returns ​

Promise&lt;readonly unknown[]&gt;


listHandoffs() ​

ts
listHandoffs(sessionId): Promise<readonly unknown[]>;

Defined in: packages/server/src/routes/sessions.ts:49

Parameters ​

ParameterType
sessionIdstring

Returns ​

Promise&lt;readonly unknown[]&gt;


listMessages() ​

ts
listMessages(sessionId, opts): Promise<readonly unknown[]>;

Defined in: packages/server/src/routes/sessions.ts:45

Parameters ​

ParameterType
sessionIdstring
opts{ limit?: number; }
opts.limit?number

Returns ​

Promise&lt;readonly unknown[]&gt;


remove() ​

ts
remove(sessionId): Promise<boolean>;

Defined in: packages/server/src/routes/sessions.ts:44

Parameters ​

ParameterType
sessionIdstring

Returns ​

Promise&lt;boolean&gt;


replaySession()? ​

ts
optional replaySession(sessionId, opts): AsyncIterable<unknown>;

Defined in: packages/server/src/routes/sessions.ts:57

Parameters ​

ParameterType
sessionIdstring
opts{ fromMessageId?: string; raw?: boolean; }
opts.fromMessageId?string
opts.raw?boolean

Returns ​

AsyncIterable&lt;unknown&gt;