ForgeClient

@forge/monorepo

---

@forge/monorepo / frontend/src / ForgeClient

Interface: ForgeClient

Defined in: frontend/src/client.ts:14

Methods

answerQuestion()

answerQuestion(input): Promise<void>

Defined in: frontend/src/client.ts:19

Parameters

input

answers

Record<string, string>

interactionId

string

runId

string

Returns

Promise<void>

---

cancelRun()

cancelRun(input): Promise<void>

Defined in: frontend/src/client.ts:18

Parameters

input

runId

string

Returns

Promise<void>

---

decideApproval()

decideApproval(input): Promise<void>

Defined in: frontend/src/client.ts:20

Parameters

input

decision

"allow-once" | "allow-conversation" | "allow-always" | "deny"

interactionId

string

runId

string

Returns

Promise<void>

---

getArtifact()?

optional getArtifact(input): Promise<{ content: string; title: string; versionId: string; }>

Defined in: frontend/src/client.ts:24

Parameters

input

artifactId

string

Returns

Promise<{ content: string; title: string; versionId: string; }>

---

getConversationContext()?

optional getConversationContext(input): Promise<ContextInspection>

Defined in: frontend/src/client.ts:26

The context inspection for a conversation/run — what shaped the prompt (Context panel, #39).

Parameters

input

conversationId

string

runId?

string

Returns

Promise<ContextInspection>

---

listConversations()

listConversations(input): Promise<Paged<ConversationSummary>>

Defined in: frontend/src/client.ts:15

Parameters

input

cursor?

string

includeArchived?

boolean

Returns

Promise<Paged<ConversationSummary>>

---

listMessages()

listMessages(input): Promise<Paged<Message>>

Defined in: frontend/src/client.ts:16

Parameters

input

conversationId

string

cursor?

string

Returns

Promise<Paged<Message>>

---

sendMessage()

sendMessage(input): Promise<{ runId: string; }>

Defined in: frontend/src/client.ts:17

Parameters

input

conversationId

string

text

string

Returns

Promise<{ runId: string; }>

---

subscribeRun()

subscribeRun(input): AsyncIterable<RunEvent>

Defined in: frontend/src/client.ts:22

Resumable event stream for a run; after is the last-seen sequence (0 from the start).

Parameters

input

after

number

conversationId

string

runId

string

Returns

AsyncIterable<RunEvent>

---

uploadAttachment()?

optional uploadAttachment(file, filename, onProgress?): Promise<{ fileId: string; }>

Defined in: frontend/src/client.ts:23

Parameters

file

Blob

filename

string

onProgress?

(fraction) => void

Returns

Promise<{ fileId: string; }>