CursorAPI
Defined in: packages/agentic-control/src/fleet/cursor-api.ts:156
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CursorAPI(
options?):CursorAPI
Defined in: packages/agentic-control/src/fleet/cursor-api.ts:163
Parameters
Section titled “Parameters”options?
Section titled “options?”CursorAPIOptions = {}
Returns
Section titled “Returns”CursorAPI
Methods
Section titled “Methods”addFollowup()
Section titled “addFollowup()”addFollowup(
agentId,prompt):Promise<Result<void>>
Defined in: packages/agentic-control/src/fleet/cursor-api.ts:361
Send a follow-up message to an agent
Parameters
Section titled “Parameters”agentId
Section titled “agentId”string
prompt
Section titled “prompt”string
Returns
Section titled “Returns”Promise<Result<void>>
getAgentConversation()
Section titled “getAgentConversation()”getAgentConversation(
agentId):Promise<Result<Conversation>>
Defined in: packages/agentic-control/src/fleet/cursor-api.ts:310
Get conversation history for an agent
Parameters
Section titled “Parameters”agentId
Section titled “agentId”string
Returns
Section titled “Returns”Promise<Result<Conversation>>
getAgentStatus()
Section titled “getAgentStatus()”Defined in: packages/agentic-control/src/fleet/cursor-api.ts:301
Get status of a specific agent
Parameters
Section titled “Parameters”agentId
Section titled “agentId”string
Returns
Section titled “Returns”launchAgent()
Section titled “launchAgent()”Defined in: packages/agentic-control/src/fleet/cursor-api.ts:321
Launch a new agent
API Spec: https://cursor.com/docs/cloud-agent/api/endpoints
Parameters
Section titled “Parameters”options
Section titled “options”prompt
Section titled “prompt”{ images?: object[]; text: string; }
prompt.images?
Section titled “prompt.images?”object[]
prompt.text
Section titled “prompt.text”string
source
Section titled “source”{ ref?: string; repository: string; }
source.ref?
Section titled “source.ref?”string
source.repository
Section titled “source.repository”string
target?
Section titled “target?”{ autoCreatePr?: boolean; branchName?: string; openAsCursorGithubApp?: boolean; skipReviewerRequest?: boolean; }
target.autoCreatePr?
Section titled “target.autoCreatePr?”boolean
target.branchName?
Section titled “target.branchName?”string
target.openAsCursorGithubApp?
Section titled “target.openAsCursorGithubApp?”boolean
target.skipReviewerRequest?
Section titled “target.skipReviewerRequest?”boolean
webhook?
Section titled “webhook?”{ secret?: string; url: string; }
webhook.secret?
Section titled “webhook.secret?”string
webhook.url
Section titled “webhook.url”string
Returns
Section titled “Returns”listAgents()
Section titled “listAgents()”Defined in: packages/agentic-control/src/fleet/cursor-api.ts:292
List all agents
Returns
Section titled “Returns”listModels()
Section titled “listModels()”listModels():
Promise<Result<string[]>>
Defined in: packages/agentic-control/src/fleet/cursor-api.ts:382
List available models
API Spec: https://cursor.com/docs/cloud-agent/api/endpoints#list-models
Returns
Section titled “Returns”Promise<Result<string[]>>
listRepositories()
Section titled “listRepositories()”listRepositories():
Promise<Result<Repository[]>>
Defined in: packages/agentic-control/src/fleet/cursor-api.ts:371
List available repositories
Returns
Section titled “Returns”Promise<Result<Repository[]>>
isAvailable()
Section titled “isAvailable()”
staticisAvailable():boolean
Defined in: packages/agentic-control/src/fleet/cursor-api.ts:181
Check if API key is available
Returns
Section titled “Returns”boolean