agent reference - RevoEngine

Generated from the same public contract that feeds the Monaco editor. Declaration-marked deprecated compatibility methods are intentionally excluded. Do not edit this page manually.

This page contains 46 methods. Search the docs for an exact method name, or use this index:

agent.list()
agent.get()
agent.create()
agent.update()
agent.listInbox()
agent.getInboxItem()
agent.pushInbox()
agent.updateInboxItem()
agent.removeInboxItem()
agent.listPlugins()
agent.getPlugin()
agent.listRuns()
agent.getRun()
agent.listRunEvents()
agent.listRunThreads()
agent.startRun()
agent.resumeRun()
agent.retryRun()
agent.tickRun()
agent.cancelRun()
agent.reconcileRuns()
agent.listThreads()
agent.getThread()
agent.getThreadState()
agent.getThreadShare()
agent.enableThreadShare()
agent.disableThreadShare()
agent.getSharedThread()
agent.listSharedThreadMessages()
agent.getSharedThreadMessageExecutionDetails()
agent.getSharedThreadMessageArtifact()
agent.forkSharedThreadMessage()
agent.createThread()
agent.deleteThread()
agent.restoreThread()
agent.listThreadMessages()
agent.sendMessage()
agent.retryMessage()
agent.cancelThread()
agent.forkMessage()
agent.renameThread()
agent.resolveAction()
agent.approveAction()
agent.rejectAction()
agent.submitAction()
agent.compactThread()

`agent.list()`

Lists agents visible to the current execution context.

Signature

static list(): Promise<Agent[]>;

Example

const agents = await agent.list();

`agent.get()`

Returns one agent by id.

Signature

static get(agentId: string): Promise<Agent>;

Example

const one = await agent.get(agentId);

`agent.create()`

Creates a new agent. The server creates agentId, status, managed workspace, timestamps, and version; supply an existing service-account user id only. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static create(data: AgentCreateInput): Promise<Agent>;

Example

const created = await agent.create({
  name: 'Ops copilot',
  serviceAccountUserId: userId,
});

`agent.update()`

Updates mutable agent fields such as config, policy, or profile. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static update(agentId: string, data: AgentUpdateInput): Promise<Agent>;

Example

const updated = await agent.update(agentId, {
  desc: 'Handles operational runbooks.',
});

`agent.listInbox()`

Lists queued and historical inbox items for an agent.

Signature

static listInbox(agentId: string): Promise<AgentInboxItem[]>;

Example

const inbox = await agent.listInbox(agentId);

`agent.getInboxItem()`

Returns one inbox item for an agent.

Signature

static getInboxItem(
      agentId: string,
      agentInboxItemId: string,
    ): Promise<AgentInboxItem>;

Example

const item = await agent.getInboxItem(agentId, agentInboxItemId);

`agent.pushInbox()`

Enqueues a new inbox item for an agent. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static pushInbox(
      agentId: string,
      data: AgentInboxItemCreateInput,
    ): Promise<AgentInboxItem>;

Example

const item = await agent.pushInbox(agentId, {
  instruction: 'Review failed deploy logs.',
});

`agent.updateInboxItem()`

Updates an existing inbox item. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static updateInboxItem(
      agentId: string,
      agentInboxItemId: string,
      data: AgentInboxItemUpdateInput,
    ): Promise<AgentInboxItem>;

Example

const item = await agent.updateInboxItem(agentId, agentInboxItemId, {
  instruction: 'Review the updated deployment evidence.',
});

`agent.removeInboxItem()`

Removes an inbox item. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static removeInboxItem(
      agentId: string,
      agentInboxItemId: string,
    ): Promise<AgentInboxItem>;

Example

await agent.removeInboxItem(agentId, agentInboxItemId);

`agent.listPlugins()`

Lists agent plugins configured for an agent.

Signature

static listPlugins(agentId: string): Promise<AgentPlugin[]>;

Example

const tools = await agent.listPlugins(agentId);

`agent.getPlugin()`

Returns one agent plugin definition for an agent.

Signature

static getPlugin(
      agentId: string,
      toolId: string,
    ): Promise<AgentPlugin>;

Example

const tool = await agent.getPlugin(agentId, toolId);

`agent.listRuns()`

Lists runs for an agent.

Signature

static listRuns(agentId: string): Promise<AgentRun[]>;

Example

const runs = await agent.listRuns(agentId);

`agent.getRun()`

Returns one agent run.

Signature

static getRun(agentRunId: string): Promise<AgentRun>;

Example

const run = await agent.getRun(agentRunId);

`agent.listRunEvents()`

Lists persisted events for a run.

Signature

static listRunEvents(agentRunId: string): Promise<AgentRunEvent[]>;

Example

const events = await agent.listRunEvents(agentRunId);

`agent.listRunThreads()`

Lists assistant threads associated with a run.

Signature

static listRunThreads(agentRunId: string): Promise<AgentRunThread[]>;

Example

const threads = await agent.listRunThreads(agentRunId);

`agent.startRun()`

Starts a new agent run. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static startRun(agentId: string, data: AgentRunInput): Promise<AgentRun>;

Example

const run = await agent.startRun(agentId, {
  instruction: 'Summarize today\\'s alerts.',
});

`agent.resumeRun()`

Resumes a paused run. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static resumeRun(agentRunId: string): Promise<AgentRun>;

Example

const run = await agent.resumeRun(agentRunId);

`agent.retryRun()`

Retries a failed or completed run from its retry policy. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static retryRun(agentRunId: string): Promise<AgentRun>;

Example

const run = await agent.retryRun(agentRunId);

`agent.tickRun()`

Forces one autonomous tick for a run. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static tickRun(agentRunId: string): Promise<AgentRun>;

Example

const run = await agent.tickRun(agentRunId);

`agent.cancelRun()`

Cancels a run, optionally recording a reason. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static cancelRun(
      agentRunId: string,
      data?: AgentRunCancelInput,
    ): Promise<AgentRun>;

Example

const run = await agent.cancelRun(agentRunId, { reason: 'Operator stop' });

`agent.reconcileRuns()`

Reconciles stalled runs with the loop scheduler. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static reconcileRuns(): Promise<any>;

Example

await agent.reconcileRuns();

`agent.listThreads()`

Lists assistant threads visible through the agent helper.

Signature

static listThreads(
      query?: Record<string, any>,
    ): Promise<CollectionResult<AssistantThread>>;

Example

const threads = await agent.listThreads({ take: 20 });

`agent.getThread()`

Returns one assistant thread.

Signature

static getThread(
      assistantThreadId: string,
      options?: { hideDeleted?: boolean },
    ): Promise<AssistantThread>;

Example

const thread = await agent.getThread(assistantThreadId);

`agent.getThreadState()`

Returns the hidden runtime planning state for a thread.

Signature

static getThreadState(
      assistantThreadId: string,
    ): Promise<AssistantThreadState>;

Example

const state = await agent.getThreadState(assistantThreadId);

`agent.getThreadShare()`

Returns the current share state for a thread owned by the current user.

Signature

static getThreadShare(
      assistantThreadId: string,
    ): Promise<AssistantThreadShare | null>;

Example

const share = await agent.getThreadShare(assistantThreadId);

`agent.enableThreadShare()`

Creates or re-enables a stable share link for a thread owned by the current user. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static enableThreadShare(
      assistantThreadId: string,
    ): Promise<AssistantThreadShare>;

Example

const share = await agent.enableThreadShare(assistantThreadId);

`agent.disableThreadShare()`

Disables the stable share link for a thread owned by the current user. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static disableThreadShare(
      assistantThreadId: string,
    ): Promise<AssistantThreadShare>;

Example

await agent.disableThreadShare(assistantThreadId);

`agent.getSharedThread()`

Returns a read-only shared thread by share ID.

Signature

static getSharedThread(
      shareId: string,
    ): Promise<AssistantSharedThreadResponse>;

Example

const shared = await agent.getSharedThread(shareId);

`agent.listSharedThreadMessages()`

Lists visible messages for a shared thread.

Signature

static listSharedThreadMessages(
      shareId: string,
      query?: Record<string, any>,
    ): Promise<CollectionResult<AssistantMessage>>;

Example

const messages = await agent.listSharedThreadMessages(shareId, { take: 50 });

`agent.getSharedThreadMessageExecutionDetails()`

Returns sanitized execution details for a visible shared-thread message.

Signature

static getSharedThreadMessageExecutionDetails(
      shareId: string,
      assistantMessageId: string,
    ): Promise<Record<string, any>>;

Example

const details = await agent.getSharedThreadMessageExecutionDetails(shareId, assistantMessageId);

`agent.getSharedThreadMessageArtifact()`

Returns one sanitized artifact for a visible shared-thread message.

Signature

static getSharedThreadMessageArtifact(
      shareId: string,
      assistantMessageId: string,
      artifactId: string,
    ): Promise<Record<string, any>>;

Example

const artifact = await agent.getSharedThreadMessageArtifact(shareId, assistantMessageId, artifactId);

`agent.forkSharedThreadMessage()`

Forks a shared thread from a selected visible message. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static forkSharedThreadMessage(
      shareId: string,
      assistantMessageId: string,
      data?: AssistantForkMessageInput,
    ): Promise<AssistantThreadResponse>;

Example

const fork = await agent.forkSharedThreadMessage(shareId, assistantMessageId);

`agent.createThread()`

Creates a new assistant thread and first message. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static createThread(
      data: AssistantMessageInput,
    ): Promise<AssistantThreadResponse>;

Example

const response = await agent.createThread({ content: 'Draft a release note.' });

`agent.deleteThread()`

Soft-deletes a thread. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static deleteThread(assistantThreadId: string): Promise<void>;

Example

await agent.deleteThread(assistantThreadId);

`agent.restoreThread()`

Restores a deleted thread. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static restoreThread(assistantThreadId: string): Promise<void>;

Example

await agent.restoreThread(assistantThreadId);

`agent.listThreadMessages()`

Lists visible messages for a thread.

Signature

static listThreadMessages(
      assistantThreadId: string,
      query?: Record<string, any>,
    ): Promise<CollectionResult<AssistantMessage>>;

Example

const messages = await agent.listThreadMessages(assistantThreadId, { take: 50 });

`agent.sendMessage()`

Sends a new message into an existing thread. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static sendMessage(
      assistantThreadId: string,
      data: AssistantMessageInput,
    ): Promise<AssistantThreadResponse>;

Example

const response = await agent.sendMessage(assistantThreadId, {
  content: 'Continue with the rollout checklist.',
});

`agent.retryMessage()`

Retries one assistant message. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static retryMessage(
      assistantThreadId: string,
      assistantMessageId: string,
    ): Promise<AssistantThreadResponse>;

Example

const response = await agent.retryMessage(assistantThreadId, assistantMessageId);

`agent.cancelThread()`

Cancels in-flight work on a thread. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static cancelThread(assistantThreadId: string, expectedVersion: number): Promise<void>;

Example

await agent.cancelThread(assistantThreadId, thread.version);

`agent.forkMessage()`

Forks a thread from a selected message. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static forkMessage(
      assistantThreadId: string,
      assistantMessageId: string,
      data?: AssistantForkMessageInput,
    ): Promise<AssistantThreadResponse>;

Example

const fork = await agent.forkMessage(assistantThreadId, assistantMessageId);

`agent.renameThread()`

Renames a thread. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static renameThread(
      assistantThreadId: string,
      data: AssistantThreadTitleInput,
    ): Promise<AssistantThread>;

Example

const thread = await agent.renameThread(assistantThreadId, {
  title: 'Postmortem draft',
});

`agent.resolveAction()`

Resolves an action-required checkpoint with an explicit payload. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static resolveAction(
      assistantThreadId: string,
      assistantActionRequiredId: string,
      data: AssistantActionResolutionInput,
    ): Promise<AssistantThreadResponse>;

Example

const response = await agent.resolveAction(assistantThreadId, actionId, {
  decision: 'approve',
});

`agent.approveAction()`

Approves an action-required checkpoint. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static approveAction(
      assistantThreadId: string,
      assistantActionRequiredId: string,
      options?: Omit<AssistantActionResolutionInput, 'decision'>,
    ): Promise<AssistantThreadResponse>;

Example

const response = await agent.approveAction(assistantThreadId, actionId);

`agent.rejectAction()`

Rejects an action-required checkpoint. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static rejectAction(
      assistantThreadId: string,
      assistantActionRequiredId: string,
      options?: Omit<AssistantActionResolutionInput, 'decision'>,
    ): Promise<AssistantThreadResponse>;

Example

const response = await agent.rejectAction(assistantThreadId, actionId, {
  responseText: 'Need a narrower scope.',
});

`agent.submitAction()`

Submits operator input for an action-required checkpoint. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static submitAction(
      assistantThreadId: string,
      assistantActionRequiredId: string,
      options?: Omit<AssistantActionResolutionInput, 'decision'>,
    ): Promise<AssistantThreadResponse>;

Example

const response = await agent.submitAction(assistantThreadId, actionId, {
  responsePayload: { selectedPlanId: 'plan-1' },
});

`agent.compactThread()`

Triggers thread compaction. Notes:

Unavailable with readOnly: true (throws an error).

Signature

static compactThread(
      assistantThreadId: string,
      options?: AssistantThreadCompactionRequest,
    ): Promise<AssistantThread>;

Example

const thread = await agent.compactThread(assistantThreadId, {
  force: true,
});

Last modified on October 5, 2026

​agent.list()

​Signature

​Example

​agent.get()

​Signature

​Example

​agent.create()

​Signature

​Example

​agent.update()

​Signature

​Example

​agent.listInbox()

​Signature

​Example

​agent.getInboxItem()

​Signature

​Example

​agent.pushInbox()

​Signature

​Example

​agent.updateInboxItem()

​Signature

​Example

​agent.removeInboxItem()

​Signature

​Example

​agent.listPlugins()

​Signature

​Example

​agent.getPlugin()

​Signature

​Example

​agent.listRuns()

​Signature

​Example

​agent.getRun()

​Signature

​Example

​agent.listRunEvents()

​Signature

​Example

​agent.listRunThreads()

​Signature

​Example

​agent.startRun()

​Signature

​Example

​agent.resumeRun()

​Signature

​Example

​agent.retryRun()

​Signature

​Example

​agent.tickRun()

​Signature

​Example

​agent.cancelRun()

​Signature

​Example

​agent.reconcileRuns()

​Signature

​Example

​agent.listThreads()

​Signature

​Example

​agent.getThread()

​Signature

​Example

​agent.getThreadState()

​Signature

​Example

​agent.getThreadShare()

​Signature

​Example

​agent.enableThreadShare()

​Signature

​Example

​agent.disableThreadShare()

​Signature

`agent.list()`

Signature

Example

`agent.get()`

Signature

Example

`agent.create()`

Signature

Example

`agent.update()`

Signature

Example

`agent.listInbox()`

Signature

Example

`agent.getInboxItem()`

Signature

Example

`agent.pushInbox()`

Signature

Example

`agent.updateInboxItem()`

Signature

Example

`agent.removeInboxItem()`

Signature

Example

`agent.listPlugins()`

Signature

Example

`agent.getPlugin()`

Signature

Example

`agent.listRuns()`

Signature

Example

`agent.getRun()`

Signature

Example

`agent.listRunEvents()`

Signature

Example

`agent.listRunThreads()`

Signature

Example

`agent.startRun()`

Signature

Example

`agent.resumeRun()`

Signature

Example

`agent.retryRun()`

Signature

Example

`agent.tickRun()`

Signature

Example

`agent.cancelRun()`

Signature

Example

`agent.reconcileRuns()`

Signature

Example

`agent.listThreads()`

Signature

Example

`agent.getThread()`

Signature

Example

`agent.getThreadState()`

Signature

Example

`agent.getThreadShare()`

Signature

Example

`agent.enableThreadShare()`

Signature

Example

`agent.disableThreadShare()`

Signature