Agent

An agent, or one of its conversations. Returned by wardrik.agent.

Most methods make one request, to the agent.* operation of the same name.
stream and reply also follow the run that answers a message.
Methods that can act on a conversation act on conversation.

Extends

AgentOperations

Properties

agent

readonly agent: string;

The agent's ID.

Inherited from

AgentOperations.agent

conversation

readonly conversation: string | undefined;

The conversation the methods act on. undefined for the agent's own history.

Inherited from

AgentOperations.conversation

Methods

stream()

stream(input, options?): AsyncGenerator<WardrikEvent>;

Sends a message and yields the events of the run that answers it, until the run ends.

for await (const event of agent.stream("What's on fire?")) {
  if (event.type === "wardrik.message.delta") process.stdout.write(event.data.delta);
  if (event.type === "wardrik.run.interrupted") {
    for (const interrupt of event.data.interrupts) await agent.approve(interrupt.id);
  }
}

An interrupted run carries on, on the same stream, once each interrupt is approved or denied.

Parameters

Parameter	Type
`input`	`string` \| `Ask`
`options?`	`StreamAskOptions`

Returns

AsyncGenerator<WardrikEvent>

reply()

reply(input, options?): Promise<Reply>;

Sends a message and resolves when the run that answers it ends or waits on a person.

const reply = await agent.reply("What's on fire?");
if (reply.status === "completed") console.log(reply.text);

Parameters

Parameter	Type
`input`	`string` \| `Ask`
`options?`	`StreamAskOptions`

Returns

Promise<Reply>

read()

read(options?): Promise<AgentSnapshot>;

Read an agent's current status.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<AgentSnapshot>

Inherited from

AgentOperations.read

define()

define(input?, options?): Promise<AgentSnapshot>;

Define an agent.

Creates the agent from this definition, or updates a running agent from its next turn. Each call replaces the whole definition. An unsupported key returns not_supported with the key's name.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`input?`	`AgentDefinition`
`options?`	`CallOptions`

Returns

Promise<AgentSnapshot>

Inherited from

AgentOperations.define

forget()

forget(options?): Promise<void>;

Delete an agent.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<void>

Inherited from

AgentOperations.forget

ask()

ask(input, options?): Promise<{
  id: string;
  cursor: string;
}>;

Send a message to an agent.

Parameters

Parameter	Type
`input`	`Ask`
`options?`	`CallOptions`

Returns

Promise<{ id: string; cursor: string; }>

Inherited from

AgentOperations.ask

decide()

decide(input, options?): Promise<object[]>;

Approve or reject pending tool calls.

All decisions are applied together and recorded under the caller. A rejection's reason is sent to the model instead of the tool's result. An approval's note is sent with the result.

Parameters

Parameter	Type
`input`	`Decisions`
`options?`	`CallOptions`

Returns

Promise<object[]>

Inherited from

AgentOperations.decide

authorization()

authorization(interrupt, options?): Promise<Authorization>;

Read the authorization URL for a pending call.

Parameters

Parameter	Type
`interrupt`	`string`
`options?`	`CallOptions`

Returns

Promise<Authorization>

Inherited from

AgentOperations.authorization

cancel()

cancel(options?): Promise<void>;

Cancel an agent's current turn.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<void>

Inherited from

AgentOperations.cancel

events()

events(input?, options?): Promise<Events>;

Read an agent's events.

Parameters

Parameter	Type	Description
`input?`	{ `types?`: `string`[]; `after?`: `string`; `before?`: `string`; `order?`: `"oldest"` \| `"newest"`; `limit?`: `number`; }	-
`input.types?`	`string`[]	The event types to return, for example wardrik.run.completed. List each type once. Defaults to all types. wardrik.events.dropped is always returned.
`input.after?`	`string`	Return events after this cursor. Use the next value from the previous page, an event ID from a stream, or the cursor from agent.read, agent.timeline or agent.runs.
`input.before?`	`string`	With order newest, return events before this cursor. Use the next value from the previous page.
`input.order?`	`"oldest"` \| `"newest"`	oldest returns the oldest events first, after the cursor; newest returns the newest first, before the cursor or from the end. Defaults to oldest.
`input.limit?`	`number`	The maximum number to return. Defaults to 100.
`options?`	`CallOptions`	-

Returns

Promise<Events>

Inherited from

AgentOperations.events

streamEvents()

streamEvents(input?, options?): EventStream;

Like events, then follows each new event as it's written. Starts after after, or at the end of the log. See EventStream.

Parameters

Parameter	Type	Description
`input?`	{ `types?`: `string`[]; `after?`: `string`; `before?`: `string`; `order?`: `"oldest"` \| `"newest"`; }	-
`input.types?`	`string`[]	The event types to return, for example wardrik.run.completed. List each type once. Defaults to all types. wardrik.events.dropped is always returned.
`input.after?`	`string`	Return events after this cursor. Use the next value from the previous page, an event ID from a stream, or the cursor from agent.read, agent.timeline or agent.runs.
`input.before?`	`string`	With order newest, return events before this cursor. Use the next value from the previous page.
`input.order?`	`"oldest"` \| `"newest"`	oldest returns the oldest events first, after the cursor; newest returns the newest first, before the cursor or from the end. Defaults to oldest.
`options?`	`StreamOptions`	-

Returns

EventStream

Inherited from

AgentOperations.streamEvents

timeline()

timeline(options?): Promise<Timeline>;

Read an agent's conversation.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<Timeline>

Inherited from

AgentOperations.timeline

runs()

runs(options?): Promise<Runs>;

Read an agent's runs and their cost.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<Runs>

Inherited from

AgentOperations.runs

approve()

approve(
   interrupt,
   input?,
   options?
): Promise<object[]>;

Approve a pending tool call.

Same as agent.decide with one approval. Recorded under the caller.

Parameters

Parameter	Type
`interrupt`	`string`
`input?`	`Approve`
`options?`	`CallOptions`

Returns

Promise<object[]>

Inherited from

AgentOperations.approve

deny()

deny(
   interrupt,
   input?,
   options?
): Promise<object[]>;

Reject a pending tool call.

Same as agent.decide with one rejection. Recorded under the caller.

Parameters

Parameter	Type
`interrupt`	`string`
`input?`	`Deny`
`options?`	`CallOptions`

Returns

Promise<object[]>

Inherited from

AgentOperations.deny

definition()

definition(options?): Promise<DefinitionRead>;

Read an agent's definition.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<DefinitionRead>

Inherited from

AgentOperations.definition

spawn()

spawn(options?): Promise<AgentSummary>;

Start an agent.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<AgentSummary>

Inherited from

AgentOperations.spawn

stop()

stop(options?): Promise<AgentSummary>;

Stop an agent.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<AgentSummary>

Inherited from

AgentOperations.stop

clear()

clear(options?): Promise<AgentSnapshot>;

Clear an agent's history.

Deletes the agent's history. The agent, its definition and its other conversations are kept. Returns conflict while the agent is running a turn or waiting for an approval.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<AgentSnapshot>

Inherited from

AgentOperations.clear

calls()

calls(options?): Promise<object[]>;

List an agent's running tool calls.

Returns not_found while the agent is asleep.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<object[]>

Inherited from

AgentOperations.calls

runtime()

runtime(options?): Promise<AgentRuntime>;

Read an agent's resource use.

Returns the memory, mailbox size and work of a running agent's processes. Returns not_found while the agent is asleep.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<AgentRuntime>

Inherited from

AgentOperations.runtime

resolved()

resolved(options?): Promise<AgentResolved>;

Read what an agent gets.

Returns what the app gives the agent: who it works for, its policies, MCP servers and their tools, notify targets, channels and workspaces.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<AgentResolved>

Inherited from

AgentOperations.resolved

files()

files(input?, options?): Promise<AgentFile[]>;

List an agent's files.

Returns the files in the agent's workspace, newest first, at most 500. Files shared with it from other workspaces aren't listed.

Acts on the agent, never a conversation.

Parameters

Parameter	Type	Description
`input?`	{ `glob?`: `string`; }	-
`input.glob?`	`string`	Return only the paths this glob matches: * within a folder, ? one character, across folders. Defaults to .
`options?`	`CallOptions`	-

Returns

Promise<AgentFile[]>

Inherited from

AgentOperations.files

file()

file(input, options?): Promise<AgentFileContent>;

Read an agent's file.

Returns a file in the agent's workspace, with its content and version. Returns not_found if there's no file at the path.

Acts on the agent, never a conversation.

Parameters

Parameter	Type	Description
`input`	{ `path`: `string`; }	-
`input.path`	`string`	The file's path in the workspace, such as notes/today.md.
`options?`	`CallOptions`	-

Returns

Promise<AgentFileContent>

Inherited from

AgentOperations.file

filePut()

filePut(input, options?): Promise<AgentFile>;

Write an agent's file.

Writes a file in the agent's workspace. With version, writes only over that version and returns conflict if the file has changed. Without version, replaces any file at the path. The file carries no labels.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`input`	`AgentFilePut`
`options?`	`CallOptions`

Returns

Promise<AgentFile>

Inherited from

AgentOperations.filePut

fileDelete()

fileDelete(input, options?): Promise<void>;

Delete an agent's file.

Deletes a file in the agent's workspace. Returns not_found if there's no file at the path.

Acts on the agent, never a conversation.

Parameters

Parameter	Type	Description
`input`	{ `path`: `string`; }	-
`input.path`	`string`	The file's path in the workspace, such as notes/today.md.
`options?`	`CallOptions`	-

Returns

Promise<void>

Inherited from

AgentOperations.fileDelete

kill()

kill(call, options?): Promise<void>;

Stop a tool call.

Parameters

Parameter	Type
`call`	`string`
`options?`	`CallOptions`

Returns

Promise<void>

Inherited from

AgentOperations.kill

triggerSet()

triggerSet(
   trigger,
   input?,
   options?
): Promise<TriggerDefinition>;

Create or update an agent's trigger.

Creates or updates one trigger and saves it in the agent's definition. Returns not_found if the agent has no definition. If every and timezone don't change, the next run time is kept.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`trigger`	`string`
`input?`	`TriggerDefinition`
`options?`	`CallOptions`

Returns

Promise<TriggerDefinition>

Inherited from

AgentOperations.triggerSet

triggerRemove()

triggerRemove(trigger, options?): Promise<TriggerDefinition>;

Remove an agent's trigger.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`trigger`	`string`
`options?`	`CallOptions`

Returns

Promise<TriggerDefinition>

Inherited from

AgentOperations.triggerRemove

move()

move(input, options?): Promise<AgentSummary>;

Move an agent to another node.

Restarts the agent on the given node, with its state. A turn in progress is stopped, and pending approvals are dropped. Send the request again after the move.

Parameters

Parameter	Type
`input`	`Node`
`options?`	`CallOptions`

Returns

Promise<AgentSummary>

Inherited from

AgentOperations.move