rovo (Preview)

The Forge bridge rovo API is now available as a Preview capability. Preview capabilities are deemed stable; however, they remain under active development and may be subject to shorter deprecation windows. Preview capabilities are suitable for early adopters in production environments.

We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA). For more details, see Forge EAP, Preview, and GA.

The Forge bridge rovo API enables your app to programmatically open the Rovo chat sidebar and initiate conversations with specific agents. Use this to provide contextual AI assistance by launching Rovo agents with pre-filled prompts based on user actions or data within your Forge app.

open

The open method allows you to open the Rovo chat side bar and create a new conversation with the default or a specified Rovo agent.

This method is currently supported in:

All Jira modules
All Confluence modules
The following Jira Service Management modules: jiraServiceManagement:organizationPanel and jiraServiceManagement:queuePage

Function signature

1
2
function open(
  openRovoPayload?:
    | ForgeAgentPayload
    | AtlassianAgentPayload
    | DefaultAgentPayload
): Promise<void>;

type ForgeAgentPayload = {
  type: "forge";
  agentName: string;
  agentKey: string;
  prompt?: string;
};

type AtlassianAgentPayload = {
  type: "atlassian";
  agentName: string;
  prompt?: string;
};

type DefaultAgentPayload = {
  type: "default";
  prompt?: string;
};

Arguments

OpenRovoPayload

type: The type of the Rovo agent.
agentName: The name of the Rovo agent.
agentKey: The key of the Forge Rovo agent module.
prompt: An optional prompt to send to the new conversation.

Non-Forge custom agents are currently not supported for this method. You can only open Forge agents that are created in the same app from where the method is called.

Examples

Forge agent

1
2
import { rovo } from "@forge/bridge";
...
await rovo.open({
  type: "forge",
  agentName:"My agent",
  agentKey: "my-agent-key",
  prompt:"Optional prompt"
});

Non-Forge agent

1
2
import { rovo } from "@forge/bridge";
...
await rovo.open({
  type: "atlassian",
  agentName:"My agent",
  prompt:"Optional prompt"
});

Default agent

1
2
import { rovo } from "@forge/bridge";
...
await rovo.open({
  type: "default",
  prompt:"Optional prompt"
});