# Cursor (/integrations/cursor)





{/* MANUAL-CONTENT-START:intro */}

Use [Cursor](https://www.cursor.so) to launch Cloud Agents on GitHub repositories, send follow-up instructions, and inspect their status, conversations, and artifacts. The actions below also cover stopping and deleting agents and listing available models and repositories.

{/* MANUAL-CONTENT-END */}

## Use the block [#usage-instructions]

Interact with Cursor Cloud Agents API to launch AI agents that can work on your GitHub repositories. Supports launching agents, adding follow-up instructions, checking status, viewing conversations, and managing agent lifecycle.

## Actions [#actions]

### Cursor List Agents [#cursor-list-agents]

List all cloud agents for the authenticated user with optional pagination. Returns API-aligned fields only.

<ReferenceDetails>
  #### Input [#input]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |
  | `limit` | number | No | Number of agents to return (default: 20, max: 100) |
  | `cursor` | string | No | Pagination cursor from previous response |
  | `prUrl` | string | No | Filter agents by pull request URL |

  #### Output [#output]

  | Parameter | Type | Description |
  | - | - | - |
  | `agents` | array | Array of agent objects |
  | `nextCursor` | string | Pagination cursor for next page |
</ReferenceDetails>

### Cursor Get Agent [#cursor-get-agent]

Retrieve the current status and results of a cloud agent. Returns API-aligned fields only.

<ReferenceDetails>
  #### Input [#input-1]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |
  | `agentId` | string | Yes | Unique identifier for the cloud agent (e.g., bc\_abc123) |

  #### Output [#output-1]

  | Parameter | Type | Description |
  | - | - | - |
  | `id` | string | Agent ID |
  | `name` | string | Agent name |
  | `status` | string | Agent status |
  | `source` | json | Source repository info |
  | `target` | json | Target branch/PR info |
  | `summary` | string | Agent summary |
  | `createdAt` | string | Creation timestamp |
</ReferenceDetails>

### Cursor Get Conversation [#cursor-get-conversation]

Retrieve the conversation history of a cloud agent, including all user prompts and assistant responses. Returns API-aligned fields only.

<ReferenceDetails>
  #### Input [#input-2]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |
  | `agentId` | string | Yes | Unique identifier for the cloud agent (e.g., bc\_abc123) |

  #### Output [#output-2]

  | Parameter | Type | Description |
  | - | - | - |
  | `id` | string | Agent ID |
  | `messages` | array | Array of conversation messages |
</ReferenceDetails>

### Cursor Launch Agent [#cursor-launch-agent]

Start a new cloud agent to work on a GitHub repository with the given instructions. Returns API-aligned fields only.

<ReferenceDetails>
  #### Input [#input-3]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |
  | `repository` | string | Yes | GitHub repository URL (e.g., [https://github.com/your-org/your-repo](https://github.com/your-org/your-repo)) |
  | `ref` | string | No | Branch, tag, or commit to work from (defaults to default branch) |
  | `promptText` | string | Yes | The instruction text for the agent |
  | `promptImages` | string | No | JSON array of image objects with base64 data and dimensions |
  | `model` | string | No | Model to use (leave empty for auto-selection) |
  | `branchName` | string | No | Custom branch name for the agent to use |
  | `autoCreatePr` | boolean | No | Automatically create a PR when the agent finishes |
  | `openAsCursorGithubApp` | boolean | No | Open the PR as the Cursor GitHub App |
  | `skipReviewerRequest` | boolean | No | Skip requesting reviewers on the PR |

  #### Output [#output-3]

  | Parameter | Type | Description |
  | - | - | - |
  | `id` | string | Agent ID |
  | `url` | string | Agent URL |
</ReferenceDetails>

### Cursor Add Follow-up [#cursor-add-follow-up]

Add a follow-up instruction to an existing cloud agent. Returns API-aligned fields only.

<ReferenceDetails>
  #### Input [#input-4]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |
  | `agentId` | string | Yes | Unique identifier for the cloud agent (e.g., bc\_abc123) |
  | `followupPromptText` | string | Yes | The follow-up instruction text for the agent |
  | `promptImages` | string | No | JSON array of image objects with base64 data and dimensions (max 5) |

  #### Output [#output-4]

  | Parameter | Type | Description |
  | - | - | - |
  | `id` | string | Agent ID |
</ReferenceDetails>

### Cursor Stop Agent [#cursor-stop-agent]

Stop a running cloud agent. Returns API-aligned fields only.

<ReferenceDetails>
  #### Input [#input-5]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |
  | `agentId` | string | Yes | Unique identifier for the cloud agent (e.g., bc\_abc123) |

  #### Output [#output-5]

  | Parameter | Type | Description |
  | - | - | - |
  | `id` | string | Agent ID |
</ReferenceDetails>

### Cursor Delete Agent [#cursor-delete-agent]

Permanently delete a cloud agent. Returns API-aligned fields only.

<ReferenceDetails>
  #### Input [#input-6]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |
  | `agentId` | string | Yes | Unique identifier for the cloud agent (e.g., bc\_abc123) |

  #### Output [#output-6]

  | Parameter | Type | Description |
  | - | - | - |
  | `id` | string | Agent ID |
</ReferenceDetails>

### Cursor List Artifacts [#cursor-list-artifacts]

List generated artifact files for a cloud agent. Returns API-aligned fields only.

<ReferenceDetails>
  #### Input [#input-7]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |
  | `agentId` | string | Yes | Unique identifier for the cloud agent (e.g., bc\_abc123) |

  #### Output [#output-7]

  | Parameter | Type | Description |
  | - | - | - |
  | `artifacts` | array | List of artifact files |
  | ↳ `path` | string | Artifact file path |
  | ↳ `size` | number | File size in bytes |
</ReferenceDetails>

### Cursor Download Artifact [#cursor-download-artifact]

Download a generated artifact file from a cloud agent. Returns the file for execution storage.

<ReferenceDetails>
  #### Input [#input-8]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |
  | `agentId` | string | Yes | Unique identifier for the cloud agent (e.g., bc\_abc123) |
  | `path` | string | Yes | Absolute path of the artifact to download (e.g., /src/index.ts) |

  #### Output [#output-8]

  | Parameter | Type | Description |
  | - | - | - |
  | `file` | file | Downloaded artifact file stored in execution files |
</ReferenceDetails>

### Cursor List Models [#cursor-list-models]

List the models available for launching cloud agents. Returns API-aligned fields only.

<ReferenceDetails>
  #### Input [#input-9]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |

  #### Output [#output-9]

  | Parameter | Type | Description |
  | - | - | - |
  | `models` | array | Array of available model names |
</ReferenceDetails>

### Cursor List Repositories [#cursor-list-repositories]

List the GitHub repositories accessible to the authenticated user. Returns API-aligned fields only.

<ReferenceDetails>
  #### Input [#input-10]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |

  #### Output [#output-10]

  | Parameter | Type | Description |
  | - | - | - |
  | `repositories` | array | Array of accessible repositories |
  | ↳ `owner` | string | Repository owner |
  | ↳ `name` | string | Repository name |
  | ↳ `repository` | string | Repository URL |
</ReferenceDetails>

### Cursor Get API Key Info [#cursor-get-api-key-info]

Retrieve details about the API key currently in use. Returns API-aligned fields only.

<ReferenceDetails>
  #### Input [#input-11]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Cursor API key |

  #### Output [#output-11]

  | Parameter | Type | Description |
  | - | - | - |
  | `apiKeyName` | string | Name of the API key |
  | `createdAt` | string | API key creation timestamp |
  | `userEmail` | string | Email of the key owner |
</ReferenceDetails>