Agent status

Retrieve the current status and results of a cloud agent

get/v0/agents/{id}

Request

  • Base URL
    https://api.cursor.com
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:bc_abc123

Unique identifier for the cloud agent

Response

Agent details retrieved successfully

idstring required

Unique identifier for the cloud agent

namestring required

Name for the agent

status'RUNNING' | 'FINISHED' | 'ERROR' | 'CREATING' | 'EXPIRED' required

Current status of the cloud agent

summarystring

Summary of the agent's work

createdAtstring date-time required

When the agent was created

Example response

{
  "id": "bc_abc123",
  "name": "Add README Documentation",
  "status": "RUNNING",
  "source": {
    "repository": "https://github.com/your-org/your-repo",
    "ref": "main"
  },
  "target": {
    "branchName": "cursor/add-readme-1234",
    "url": "https://cursor.com/agents?id=bc_abc123",
    "prUrl": "https://github.com/your-org/your-repo/pull/1234"
  },
  "summary": "Added README.md with installation instructions and usage examples",
  "createdAt": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.