1. Docs
2. Reference
3. REST API Docs
4. Schema
5. AgentTask

A Pulumi Copilot agent task representing a conversation and its associated context.

Properties

• id string required
  Unique identifier for the task.
• name string required
  Display name for the task, typically auto-generated from the initial user message.
• taskType enum required
  Whether the task was started synchronously by a user or asynchronously by background automation.
  Values: sync, async
• asyncTriggerType enum optional
  The async trigger source for this task. Null for sync tasks.
  Values:

  scheduled — Scheduled

  The task was started by a cron-driven scheduled signal.

  external_signal — ExternalSignal

  The task was started in reaction to an external signal payload.

• status enum required
  Current execution status of the task.
  Values: running, idle
• createdAt string required
  When the task was created, in ISO 8601 format.
• approvalMode enum required
  Approval mode for this task. Valid values: ‘manual’, ‘auto’, ‘balanced’.
  Values: manual, auto, balanced
• entities array[AgentEntity] required
  Pulumi entities (stacks, projects, etc.) that provide context for the agent.
• ↳ type string required
• planMode boolean required
  Whether the task is in plan mode. Set based on the first user message.
• isShared boolean required
  Whether this task is shared with other org members.
• sharedAt string optional
  When the task was first shared. Null if never shared.
• createdBy UserInfo required
  Information about the user who created this task.
• ↳ name string required
  The user’s display name.
• ↳ githubLogin string required
  The user’s login name.
• ↳ avatarUrl string required
  The URL of the user’s avatar image.
• ↳ email string optional
  The user’s email address. It is only populated on selected endpoints and is omitted from most responses. Treat it as sensitive information.
• permissionMode enum optional
  The permission scope for the task.
  Values:

  default — Default

  read-only — ReadOnly

• role string optional
  The id of the RBAC role this task assumes. Null when the task runs with the creating user’s own permissions (no assumed role).
• roleName string optional
  The display name of the RBAC role this task assumes. Null when the task has no assumed role or the role no longer exists.
• runtimePhase enum optional
  The current runtime phase for this task. Null until the runtime checks in.
  Values: booting, ready, running
• lastHeartbeat string optional
  When the task runtime last reported a heartbeat. Null if the runtime has never checked in.
• contextUsedTokens integer optional
  Total input tokens consumed across all model invocations for this task. Approximate context window usage.
• contextWindowTokens integer optional
  Maximum context window size in tokens for the primary model used by this task.
• contextCompactionThresholdPercent integer optional
  Percentage of the context window (1-100) at which the agent triggers conversation compaction. Populated alongside contextWindowTokens when token usage data is available; omitted otherwise.
• tokensUsed integer required
  Total Neo tokens consumed across all model invocations for this task. Neo tokens are the priced unit used for billing — distinct from the raw model input tokens surfaced in contextUsedTokens / contextWindowTokens.
• toolExecutionMode enum optional
  Where tools are executed for this task. Valid values: ‘cloud’, ‘cli’.
  Values: cloud, cli, worker
• sourceAutomationID string optional
  The automation that spawned this task, if the task was created by an automation run.
• agentDefinitionId string optional
  The Custom Agent definition this task was run as, if any. Null for tasks run by a user directly rather than as a saved agent.
• source enum optional
  The origin that triggered this task. Valid values: ‘console’, ‘cli’, ‘slack’, ‘schedule’, ‘api’, ‘github’, ‘code-review’.
  Values:

  api — Api

  Task created via the REST API without a more specific origin.

  console — Console

  Task created from the Pulumi Cloud web console.

  cli — Cli

  Task created from the Pulumi CLI.

  slack — Slack

  Task created from the Slack integration.

  schedule — Schedule

  Task created by a scheduled automation.

  github — Github

  Task triggered from a GitHub integration.

  code-review — CodeReview

  Task created by the code review feature. The platform hosting the reviewed change is identified by the task’s vcsProvider field.

• vcsProvider enum optional
  The version control system this task operates against. Set for tasks that target a specific VCS platform (e.g. code reviews). Null for tasks with no VCS context.
  Values:

  github — GitHub

  GitHub version control system

  gitlab — GitLab

  GitLab version control system

  bitbucket — Bitbucket

  Bitbucket version control system

  azure_devops — AzureDevOps

  Azure DevOps version control system

  custom — Custom

  Custom version control system

  github_enterprise — GitHubEnterprise

  GitHub Enterprise Server version control system