Skip to content

Documentation / @agentick/client / ClientExecutionHandle

Interface: ClientExecutionHandle ​

Defined in: client/src/types.ts:198

Handle for streaming a single execution from the client.

Properties ​

executionId ​

readonly executionId: string

Defined in: client/src/types.ts:202

Execution ID (assigned by server)


result ​

readonly result: Promise<SessionResultPayload>

Defined in: client/src/types.ts:214

Final result for this execution.


sessionId ​

readonly sessionId: string

Defined in: client/src/types.ts:200

Session ID this execution belongs to


status ​

readonly status: "running" | "error" | "completed" | "aborted"

Defined in: client/src/types.ts:204

Current status

Methods ​

[asyncIterator]() ​

[asyncIterator](): AsyncIterator<StreamEvent>

Defined in: client/src/types.ts:209

Async iterator for events from this execution only.

Returns ​

AsyncIterator<StreamEvent>


abort() ​

abort(reason?): void

Defined in: client/src/types.ts:219

Abort this execution.

Parameters ​

reason? ​

string

Returns ​

void


queueMessage() ​

queueMessage(message): void

Defined in: client/src/types.ts:224

Queue a message during execution.

Parameters ​

message ​

Message

Returns ​

void


submitToolResult() ​

submitToolResult(toolUseId, result): void

Defined in: client/src/types.ts:229

Submit tool confirmation result.

Parameters ​

toolUseId ​

string

result ​

ToolConfirmationResponse

Returns ​

void

Released under the ISC License.