AI Agents
Neo

GetTask

Retrieves metadata for a specific agent task, including its ID, name, status, creation timestamp, and associated entities. Returns 404 if the task does not exist.

get/api/preview/agents/{orgName}/tasks/{taskID}

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/preview/agents/{orgName}/tasks/{taskID}
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

taskIDstring required

The agent task identifier

Response

OK

agentDefinitionIdstring

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.

approvalMode'manual' | 'auto' | 'balanced' required

Approval mode for this task. Valid values: 'manual', 'auto', 'balanced'.

asyncTriggerType'scheduled' | 'external_signal'

The async trigger source for this task. Null for sync tasks.

contextCompactionThresholdPercentinteger

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.

contextUsedTokensinteger

Total input tokens consumed across all model invocations for this task. Approximate context window usage.

contextWindowTokensinteger

Maximum context window size in tokens for the primary model used by this task.

createdAtstring date-time required

When the task was created, in ISO 8601 format.

idstring required

Unique identifier for the task.

isSharedboolean required

Whether this task is shared with other org members.

lastHeartbeatstring date-time

When the task runtime last reported a heartbeat. Null if the runtime has never checked in.

namestring required

Display name for the task, typically auto-generated from the initial user message.

pendingInputCountinteger

The number of pending inputs waiting behind this task. Present for tasks that can receive asynchronous inputs.

permissionMode'default' | 'read-only'

The permission scope for the task.

planModeboolean required

Whether the task is in plan mode. Set based on the first user message.

rolestring

The id of the RBAC role this task assumes. Null when the task runs with the creating user's own permissions (no assumed role).

roleNamestring

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'booting' | 'ready' | 'running'

The current runtime phase for this task. Null until the runtime checks in.

sharedAtstring date-time

When the task was first shared. Null if never shared.

source'api' | 'console' | 'cli' | 'slack' | 'schedule' | 'github' | 'code-review'

The origin that triggered this task. Valid values: 'console', 'cli', 'slack', 'schedule', 'api', 'github', 'code-review'.

sourceAutomationIDstring

The automation that spawned this task, if the task was created by an automation run.

status'running' | 'idle' required

Current execution status of the task.

taskType'sync' | 'async' required

Whether the task was started synchronously by a user or asynchronously by background automation.

tokensUsedinteger 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'cloud' | 'cli' | 'worker'

Where tools are executed for this task. Valid values: 'cloud', 'cli'.

vcsProvider'github' | 'gitlab' | 'bitbucket' | 'azure_devops' | 'custom' | 'github_enterprise'

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.

Changes

No recorded changes to this operation across all 1 revision of this API.