Skip to content
Try for free
On this page

Integrations

Cursor

Launch and manage Cursor cloud agents to work on GitHub repositories

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.

Use the block

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

Cursor List Agents

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key
limitnumberNoNumber of agents to return (default: 20, max: 100)
cursorstringNoPagination cursor from previous response
prUrlstringNoFilter agents by pull request URL

Output

ParameterTypeDescription
agentsarrayArray of agent objects
nextCursorstringPagination cursor for next page

Cursor Get Agent

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key
agentIdstringYesUnique identifier for the cloud agent (e.g., bc_abc123)

Output

ParameterTypeDescription
idstringAgent ID
namestringAgent name
statusstringAgent status
sourcejsonSource repository info
targetjsonTarget branch/PR info
summarystringAgent summary
createdAtstringCreation timestamp

Cursor Get Conversation

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key
agentIdstringYesUnique identifier for the cloud agent (e.g., bc_abc123)

Output

ParameterTypeDescription
idstringAgent ID
messagesarrayArray of conversation messages

Cursor Launch Agent

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key
repositorystringYesGitHub repository URL (e.g., https://github.com/your-org/your-repo)
refstringNoBranch, tag, or commit to work from (defaults to default branch)
promptTextstringYesThe instruction text for the agent
promptImagesstringNoJSON array of image objects with base64 data and dimensions
modelstringNoModel to use (leave empty for auto-selection)
branchNamestringNoCustom branch name for the agent to use
autoCreatePrbooleanNoAutomatically create a PR when the agent finishes
openAsCursorGithubAppbooleanNoOpen the PR as the Cursor GitHub App
skipReviewerRequestbooleanNoSkip requesting reviewers on the PR

Output

ParameterTypeDescription
idstringAgent ID
urlstringAgent URL

Cursor Add Follow-up

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key
agentIdstringYesUnique identifier for the cloud agent (e.g., bc_abc123)
followupPromptTextstringYesThe follow-up instruction text for the agent
promptImagesstringNoJSON array of image objects with base64 data and dimensions (max 5)

Output

ParameterTypeDescription
idstringAgent ID

Cursor Stop Agent

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key
agentIdstringYesUnique identifier for the cloud agent (e.g., bc_abc123)

Output

ParameterTypeDescription
idstringAgent ID

Cursor Delete Agent

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key
agentIdstringYesUnique identifier for the cloud agent (e.g., bc_abc123)

Output

ParameterTypeDescription
idstringAgent ID

Cursor List Artifacts

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key
agentIdstringYesUnique identifier for the cloud agent (e.g., bc_abc123)

Output

ParameterTypeDescription
artifactsarrayList of artifact files
↳ pathstringArtifact file path
↳ sizenumberFile size in bytes

Cursor Download Artifact

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key
agentIdstringYesUnique identifier for the cloud agent (e.g., bc_abc123)
pathstringYesAbsolute path of the artifact to download (e.g., /src/index.ts)

Output

ParameterTypeDescription
filefileDownloaded artifact file stored in execution files

Cursor List Models

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key

Output

ParameterTypeDescription
modelsarrayArray of available model names

Cursor List Repositories

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key

Output

ParameterTypeDescription
repositoriesarrayArray of accessible repositories
↳ ownerstringRepository owner
↳ namestringRepository name
↳ repositorystringRepository URL

Cursor Get API Key Info

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

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesCursor API key

Output

ParameterTypeDescription
apiKeyNamestringName of the API key
createdAtstringAPI key creation timestamp
userEmailstringEmail of the key owner
Was this helpful?
Suggest an edit