Methods
active()
Parameters
{ pageSize: number; pageToken: string }
Returns
Promise<Page<ActiveConversationRun>>
A page of active runs with session and status metadata.
activeBySession()
Parameters
readonly string[]
required
Up to 100 session ids.
Returns
Promise<ActiveConversationRun[]>
Active runs matching any of the given sessions.
cancel()
Parameters
string
required
Run id to cancel.
Returns
Promise<void>
create()
Parameters
string | number
required
Workflow id or slug to run.
object
required
Run body (
message, optional sessionId, optional version as published or draft).{ idempotencyKey: string }
Returns
AgentRunStream
A stream of run events (tokens, completion, errors, and related signals).
createModus()
Parameters
object
required
Run body (
message, optional sessionId, optional subordinateSkillIds to narrow context).{ idempotencyKey: string }
Returns
AgentRunStream
A stream of run events.
createScope()
Parameters
string | number
required
Scope id to run.
object
required
Run body (
message, optional sessionId, optional version as published or draft).{ idempotencyKey: string }
Returns
AgentRunStream
A stream of run events.
editQueued()
Parameters
string
required
Queued run id.
Returns
Promise<void>
events()
Parameters
string
required
Run id.
Returns
Promise<unknown>
Run event history for replay or inspection.
get()
Parameters
string | number
required
Workflow id or slug the run belongs to.
string
required
Run id.
{ temporalRunId: string }
Returns
Promise<object>
Run details including status and output.
interrupt()
Parameters
string
required
Run id to interrupt.
Returns
Promise<void>
list()
Parameters
string | number
required
Workflow id or slug.
Returns
Promise<Page<object>>
A page of run summaries.
resume()
Parameters
string
required
Run id to resume.
object
required
Resume body (
message, sessionId, and decision: approve / deny / connected / cancelled).{ idempotencyKey: string }
Returns
AgentRunStream
A stream of run events.
stream()
Parameters
string
required
Run id to follow.
{ lastEventId: string }
Returns
AgentRunStream
A stream of run events from the current execution point.