Launch Agent with Cursor API

Pipedream makes it easy to connect APIs for Cursor and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Launch Agent with the Cursor API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Launch Agent with the Cursor API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Launch Agent action
1. Connect your Cursor account
2. Configure Prompt
3. Select a Source Repository
4. Optional- Configure Source Ref
5. Optional- Select a Model
6. Optional- Configure Auto Create PR
7. Optional- Configure Open as Cursor Github App
8. Optional- Configure Skip Reviewer Request
9. Optional- Configure Target Branch
10. Optional- Configure Webhook URL
11. Optional- Configure Images
12. Optional- Configure syncDir
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Launch Agent on Cursor

Description:Launch a Cursor agent. [See the documentation](https://cursor.com/docs/cloud-agent/api/endpoints#launch-an-agent)

Version:0.0.1

Key:cursor-launch-agent

View on GitHub

Code#

import cursor from "../../cursor.app.mjs";
import { formatImages } from "../../common/utils.mjs";

export default {
  key: "cursor-launch-agent",
  name: "Launch Agent",
  description: "Launch a Cursor agent. [See the documentation](https://cursor.com/docs/cloud-agent/api/endpoints#launch-an-agent)",
  version: "0.0.1",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    cursor,
    prompt: {
      type: "string",
      label: "Prompt",
      description: "The instruction text for the agent",
    },
    sourceRepository: {
      propDefinition: [
        cursor,
        "sourceRepository",
      ],
    },
    sourceRef: {
      type: "string",
      label: "Source Ref",
      description: "Git ref (branch name, tag, or commit hash) to use as the base branch",
      optional: true,
    },
    model: {
      propDefinition: [
        cursor,
        "model",
      ],
      optional: true,
    },
    autoCreatePr: {
      type: "boolean",
      label: "Auto Create PR",
      description: "Whether to automatically create a pull request when the agent completes",
      default: false,
      optional: true,
    },
    openAsCursorGithubApp: {
      type: "boolean",
      label: "Open as Cursor Github App",
      description: "Whether to open the pull request as the Cursor GitHub App instead of as the user. Only applies if autoCreatePr is true.",
      optional: true,
    },
    skipReviewerRequest: {
      type: "boolean",
      label: "Skip Reviewer Request",
      description: "Whether to skip adding the user as a reviewer to the pull request. Only applies if autoCreatePr is true and the PR is opened as the Cursor GitHub App.",
      optional: true,
    },
    targetBranch: {
      type: "string",
      label: "Target Branch",
      description: "Custom branch name for the agent to create",
      optional: true,
    },
    webhookUrl: {
      type: "string",
      label: "Webhook URL",
      description: "URL to receive webhook notifications about agent status changes",
      optional: true,
    },
    images: {
      propDefinition: [
        cursor,
        "images",
      ],
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.cursor.launchAgent({
      $,
      data: {
        prompt: {
          text: this.prompt,
          images: await formatImages(this.images),
        },
        model: this.model,
        source: {
          repository: this.sourceRepository,
          ref: this.sourceRef,
        },
        target: {
          autoCreatePr: this.autoCreatePr,
          openAsCursorGithubApp: this.openAsCursorGithubApp,
          skipReviewerRequest: this.skipReviewerRequest,
          branchName: this.targetBranch,
        },
        webhook: this.webhookUrl
          ? {
            url: this.webhookUrl,
          }
          : undefined,
      },
    });
    $.export("$summary", `Successfully launched agent with ID ${response.id}`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Cursor	`cursor`	`app`	This component uses the Cursor app.
Prompt	`prompt`	`string`	The instruction text for the agent
Source Repository	`sourceRepository`	`string`	Select a value from the drop down menu.
Source Ref	`sourceRef`	`string`	Git ref (branch name, tag, or commit hash) to use as the base branch
Model	`model`	`string`	Select a value from the drop down menu.
Auto Create PR	`autoCreatePr`	`boolean`	Whether to automatically create a pull request when the agent completes
Open as Cursor Github App	`openAsCursorGithubApp`	`boolean`	Whether to open the pull request as the Cursor GitHub App instead of as the user. Only applies if autoCreatePr is true.
Skip Reviewer Request	`skipReviewerRequest`	`boolean`	Whether to skip adding the user as a reviewer to the pull request. Only applies if autoCreatePr is true and the PR is opened as the Cursor GitHub App.
Target Branch	`targetBranch`	`string`	Custom branch name for the agent to create
Webhook URL	`webhookUrl`	`string`	URL to receive webhook notifications about agent status changes
Images	`images`	`string[]`	Images to use for the request (max 5). This can be a file URL or path to a file in the `/tmp` directory (for example, `/tmp/example.jpg`)
N/A	`syncDir`	`dir`	This component uses `dir` to share files between component executions.