cursor-agent-sdk

Python client for the Cursor Cloud Agents API — start cloud coding agents on GitHub repos or PRs, send follow-ups, and poll status. Sync and async httpx clients are both supported.

Install from PyPI: pip install cursor-agent-sdk (project page).

Guide

• Overview
  • What this SDK does
  • Clients and agents
  • Errors
  • Further reading
• Concepts
  • The API vs this library
  • Authentication
  • Client = one front door to the HTTP API
  • Agent = local bookmark for one remote run
  • Lifecycle in three beats
  • Sync vs async
  • Helpers vs raw client methods
  • When things fail
• Quickstart
  • Install
  • Authentication
  • Minimal sync example
  • Minimal async example
  • For contributors: build these docs locally

Reference

• API reference
  • Agent
  • AsyncAgent
  • AsyncClient
  • CursorAPIError
  • CursorClient
  • SyncClient
• HTTP routes

Indices and tables

• Index

• Module Index

• Search Page