Class Conversation

Stateful conversation wrapper that handles history, tool execution, persistence, and running token/cost totals.

Example

const conversation = await client.conversation({
  sessionId: 'support-1',
  system: 'Be concise.',
});

await conversation.send('Summarise the issue.');

Index

Constructors

constructor

new Conversation(
client: ConversationClient,
options?: ConversationOptions,
): Conversation
Parameters
- client: ConversationClient
- options: ConversationOptions = {}
Returns Conversation
- Defined in src/conversation.ts:151

Accessors

cost

get cost(): string
Returns string
- Defined in src/conversation.ts:176

history

get history(): CanonicalMessage[]
Returns CanonicalMessage[]
- Defined in src/conversation.ts:180

id

get id(): string
Returns string
- Defined in src/conversation.ts:184

totals

get totals(): {
    cachedTokens: number;
    cost: string;
    costUSD: number;
    inputTokens: number;
    outputTokens: number;
}
Returns {
    cachedTokens: number;
    cost: string;
    costUSD: number;
    inputTokens: number;
    outputTokens: number;
}
- Defined in src/conversation.ts:188

Methods

send

send(
input: string | CanonicalPart[],
options?: { signal?: AbortSignal },
): Promise<CanonicalResponse>
Appends a user turn, executes the model/tool loop, and commits state.
Parameters
- input: string | CanonicalPart[]
- options: { signal?: AbortSignal } = {}
Returns Promise<CanonicalResponse>
- Defined in src/conversation.ts:205

sendStream

sendStream(
input: string | CanonicalPart[],
options?: { signal?: AbortSignal },
): CancelableStream<StreamChunk>
Streams a user turn and commits state when the final done chunk arrives.
Parameters
- input: string | CanonicalPart[]
- options: { signal?: AbortSignal } = {}
Returns CancelableStream<StreamChunk>
- Defined in src/conversation.ts:217

clear

clear(): void
Clears non-system history while preserving running totals.

Returns void
- Defined in src/conversation.ts:235

serialise

serialise(): ConversationSnapshot
Serializes the conversation for storage or transport.

Returns ConversationSnapshot
- Defined in src/conversation.ts:241

toMessages

toMessages(): CanonicalMessage[]
Returns the full message list including the pinned system prompt.

Returns CanonicalMessage[]
- Defined in src/conversation.ts:273

toMarkdown

toMarkdown(): string
Exports the conversation as a markdown transcript.

Returns string
- Defined in src/conversation.ts:280

`Static`restore

restore(
    client: ConversationClient,
    snapshot: ConversationSnapshot,
    options?: Omit<ConversationOptions, "messages">,
): Conversation
Restores a conversation from a serialized snapshot.
Parameters
- client: ConversationClient
- snapshot: ConversationSnapshot
- options: Omit<ConversationOptions, "messages"> = {}
Returns Conversation
- Defined in src/conversation.ts:315

Class Conversation

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Conversation

Accessors

cost

Returns string

history

Returns CanonicalMessage[]

id

Returns string

totals

Returns {
    cachedTokens: number;
    cost: string;
    costUSD: number;
    inputTokens: number;
    outputTokens: number;
}

Methods

send

Parameters

Returns Promise<CanonicalResponse>

sendStream

Parameters

Returns CancelableStream<StreamChunk>

clear

Returns void

serialise

Returns ConversationSnapshot

toMessages

Returns CanonicalMessage[]

toMarkdown

Returns string

`Static`restore

Parameters

Returns Conversation

Settings

On This Page

Class Conversation

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Conversation

Accessors

cost

Returns string

history

Returns CanonicalMessage[]

id

Returns string

totals

Returns { cachedTokens: number; cost: string; costUSD: number; inputTokens: number; outputTokens: number;}

Methods

send

Parameters

Returns Promise<CanonicalResponse>

sendStream

Parameters

Returns CancelableStream<StreamChunk>

clear

Returns void

serialise

Returns ConversationSnapshot

toMessages

Returns CanonicalMessage[]

toMarkdown

Returns string

Staticrestore

Parameters

Returns Conversation

Settings

On This Page

Returns {
cachedTokens: number;
cost: string;
costUSD: number;
inputTokens: number;
outputTokens: number;
}

`Static`restore