Skip to content

SpawnOptions

Defined in: packages/agentic-control/src/core/types.ts:293

Options for spawning a new agent

API Spec: https://cursor.com/docs/cloud-agent/api/endpoints

optional context: Record<string, unknown>

Defined in: packages/agentic-control/src/core/types.ts:301

Coordination context (for multi-agent orchestration)


optional ref: string

Defined in: packages/agentic-control/src/core/types.ts:299

Git ref (branch, tag, commit) - defaults to “main”


repository: string

Defined in: packages/agentic-control/src/core/types.ts:295

GitHub repository URL (e.g., https://github.com/org/repo)


optional target: object

Defined in: packages/agentic-control/src/core/types.ts:303

Target configuration

optional autoCreatePr: boolean

Auto-create PR when agent completes

optional branchName: string

Custom branch name

optional openAsCursorGithubApp: boolean

Open PR as Cursor GitHub App instead of user

optional skipReviewerRequest: boolean

Skip adding user as reviewer


task: string

Defined in: packages/agentic-control/src/core/types.ts:297

Task description for the agent


optional webhook: object

Defined in: packages/agentic-control/src/core/types.ts:314

Webhook for status notifications

optional secret: string

Secret for payload verification (min 32 chars)

url: string

URL to receive notifications