GET
/
v0
/
agents
/
{id}
Agent status
curl --request GET \
  --url https://api.cursor.com/v0/agents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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",
    "autoCreatePr": false
  },
  "summary": "Added README.md with installation instructions and usage examples",
  "createdAt": "2024-01-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

API key from Cursor Dashboard

Path Parameters

​
id
string
required

Unique identifier for the background agent

Example:

"bc_abc123"

Response

Agent details retrieved successfully

​
id
string
required

Unique identifier for the background agent

Example:

"bc_abc123"

​
name
string
required

Name for the agent

Example:

"Add README Documentation"

​
status
enum<string>
required

Current status of the background agent

Available options:
RUNNING,
FINISHED,
ERROR,
CREATING,
EXPIRED
Example:

"RUNNING"

​
source
object
required
​
target
object
required
​
createdAt
string<date-time>
required

When the agent was created

Example:

"2024-01-15T10:30:00Z"

​
summary
string

Summary of the agent's work

Example:

"Added README.md with installation instructions and usage examples"