API

Every cursor.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Account

getMe

account.getMe Retrieve API key information including name, creation date, and owner email Risk: read

await corsair.cursor.api.account.getMe({});

Input: empty object Output

Name	Type	Required	Description
`apiKeyName`	`string`	Yes	—
`createdAt`	`string`	Yes	—
`userEmail`	`string`	No	—

Agents

getConversation

agents.getConversation Retrieve the conversation history for a specific cloud agent Risk: read

await corsair.cursor.api.agents.getConversation({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`messages`	`object[]`	Yes	—

messages full type

{
  id?: string,
  text?: string,
  type?: user_message | assistant_message
}[]

list

agents.list Retrieve a paginated list of Cursor Cloud agents Risk: read

await corsair.cursor.api.agents.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`agents`	`object[]`	Yes	—
`nextCursor`	`string`	No	—

agents full type

{
  id?: string,
  name?: string,
  source?: {
    ref?: string,
    repository?: string
  },
  status?: RUNNING | FINISHED | ERROR | CREATING | EXPIRED,
  target?: {
    url?: string,
    prUrl?: string,
    branchName?: string,
    autoCreatePr?: boolean,
    skipReviewerRequest?: boolean,
    openAsCursorGithubApp?: boolean
  },
  summary?: string,
  createdAt?: string
}[]

Models

list

models.list Retrieve the list of available AI models in Cursor Risk: read

await corsair.cursor.api.models.list({});

Input: empty object Output

Name	Type	Required	Description
`models`	`string[]`	Yes	—

Repositories

list

repositories.list List GitHub repositories accessible to the authenticated user Risk: read

await corsair.cursor.api.repositories.list({});

Input: empty object Output

Name	Type	Required	Description
`repositories`	`object[]`	Yes	—

repositories full type

{
  name?: string,
  owner?: string,
  repository?: string
}[]

Overview

Plugins

Account

getMe

Agents

getConversation

list

Models

list

Repositories

list

​Account

​getMe

​Agents

​getConversation

​list

​Models

​list

​Repositories

​list

Account

getMe

Agents

getConversation

list

Models

list

Repositories

list