Overview
What this SDK does
cursor-agent-sdk is published on PyPI as the
package name cursor-agent-sdk. It wraps the HTTP API at https://api.cursor.com/v0 (the
Cursor Cloud Agents API) so you can script
the same workflows you might otherwise drive from the Cursor Dashboard (Cloud Agents).
This package is not maintained by Cursor; it is a community wrapper.
For terminology and lifecycle in more detail, see Concepts.
Clients and agents
SyncClient / AsyncClient — One client per process (or logical app). Holds your API key (HTTP Basic: key as username, empty password) and issues raw requests.
Agent / AsyncAgent — Returned by
SyncClient.new_agent()(orAsyncClient.new_agent()). Remembers the GitHub repo (or pr_url) and, afterAgent.create(), the remote agent id. UseAgent.follow_up()for more prompts on the same cloud agent.CursorClient — Alias for
SyncClient(backward compatibility).
Errors
HTTP failures raise cursor_agent.CursorAPIError with status_code and response set when
available.