Use Cursor 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.
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.
List all cloud agents for the authenticated user with optional pagination. Returns API-aligned fields only.
| 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 |
| Parameter | Type | Description |
|---|
agents | array | Array of agent objects |
nextCursor | string | Pagination cursor for next page |
Retrieve the current status and results of a cloud agent. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Cursor API key |
agentId | string | Yes | Unique identifier for the cloud agent (e.g., bc_abc123) |
| 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 |
Retrieve the conversation history of a cloud agent, including all user prompts and assistant responses. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Cursor API key |
agentId | string | Yes | Unique identifier for the cloud agent (e.g., bc_abc123) |
| Parameter | Type | Description |
|---|
id | string | Agent ID |
messages | array | Array of conversation messages |
Start a new cloud agent to work on a GitHub repository with the given instructions. Returns API-aligned fields only.
| 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) |
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 |
| Parameter | Type | Description |
|---|
id | string | Agent ID |
url | string | Agent URL |
Add a follow-up instruction to an existing cloud agent. Returns API-aligned fields only.
| 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) |
| Parameter | Type | Description |
|---|
id | string | Agent ID |
Stop a running cloud agent. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Cursor API key |
agentId | string | Yes | Unique identifier for the cloud agent (e.g., bc_abc123) |
| Parameter | Type | Description |
|---|
id | string | Agent ID |
Permanently delete a cloud agent. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Cursor API key |
agentId | string | Yes | Unique identifier for the cloud agent (e.g., bc_abc123) |
| Parameter | Type | Description |
|---|
id | string | Agent ID |
List generated artifact files for a cloud agent. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Cursor API key |
agentId | string | Yes | Unique identifier for the cloud agent (e.g., bc_abc123) |
| Parameter | Type | Description |
|---|
artifacts | array | List of artifact files |
↳ path | string | Artifact file path |
↳ size | number | File size in bytes |
Download a generated artifact file from a cloud agent. Returns the file for execution storage.
| 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) |
| Parameter | Type | Description |
|---|
file | file | Downloaded artifact file stored in execution files |
List the models available for launching cloud agents. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Cursor API key |
| Parameter | Type | Description |
|---|
models | array | Array of available model names |
List the GitHub repositories accessible to the authenticated user. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Cursor API key |
| Parameter | Type | Description |
|---|
repositories | array | Array of accessible repositories |
↳ owner | string | Repository owner |
↳ name | string | Repository name |
↳ repository | string | Repository URL |
Retrieve details about the API key currently in use. Returns API-aligned fields only.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Cursor API key |
| Parameter | Type | Description |
|---|
apiKeyName | string | Name of the API key |
createdAt | string | API key creation timestamp |
userEmail | string | Email of the key owner |