Graphorin API reference v0.4.0
Graphorin API reference / @graphorin/server / / SessionApi
Interface: SessionApi
Defined in: packages/server/src/routes/sessions.ts:33
Minimal contract route handlers consume. Real deployments wire @graphorin/sessions.SessionManager in directly; tests pass a lighter stub.
Stable
Methods
create()
create(input): Promise<unknown>;Defined in: packages/server/src/routes/sessions.ts:39
Parameters
| Parameter | Type |
|---|---|
input | { agentId: string; sessionId?: string; tags?: readonly string[]; title?: string; userId: string; } |
input.agentId | string |
input.sessionId? | string |
input.tags? | readonly string[] |
input.title? | string |
input.userId | string |
Returns
Promise<unknown>
exportSession()?
optional exportSession(sessionId, opts): Promise<unknown>;Defined in: packages/server/src/routes/sessions.ts:52
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
opts | { hash?: boolean; includeAuditEntries?: boolean; } |
opts.hash? | boolean |
opts.includeAuditEntries? | boolean |
Returns
Promise<unknown>
get()
get(sessionId): Promise<unknown>;Defined in: packages/server/src/routes/sessions.ts:38
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
Returns
Promise<unknown>
list()
list(opts): Promise<readonly unknown[]>;Defined in: packages/server/src/routes/sessions.ts:34
Parameters
| Parameter | Type |
|---|---|
opts | { agentId?: string; userId?: string; } |
opts.agentId? | string |
opts.userId? | string |
Returns
Promise<readonly unknown[]>
listHandoffs()
listHandoffs(sessionId): Promise<readonly unknown[]>;Defined in: packages/server/src/routes/sessions.ts:51
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
Returns
Promise<readonly unknown[]>
listMessages()
listMessages(sessionId, opts): Promise<readonly unknown[]>;Defined in: packages/server/src/routes/sessions.ts:47
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
opts | { limit?: number; } |
opts.limit? | number |
Returns
Promise<readonly unknown[]>
remove()
remove(sessionId): Promise<boolean>;Defined in: packages/server/src/routes/sessions.ts:46
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
Returns
Promise<boolean>
replaySession()?
optional replaySession(sessionId, opts): AsyncIterable<unknown>;Defined in: packages/server/src/routes/sessions.ts:59
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
opts | { fromMessageId?: string; raw?: boolean; } |
opts.fromMessageId? | string |
opts.raw? | boolean |
Returns
AsyncIterable<unknown>