Assistant

Preview — pending review

This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.

Cancel an assistant proposal

POST
/scopes/{scopeId}/assistant/proposals/{proposalId}/actions/cancel

Discards the caller's own pending proposal (nothing is created). Validation: READ on compute -> 403; unreachable scope or a proposal that is not the caller's / not in this scope -> 404; not pending -> 409 PROPOSAL_NOT_PENDING. Feature flag: 404 while the assistant service is disabled. Async & state: Synchronous; the proposal becomes cancelled. Errors: 401; 403; 404; 409; 500. Idempotency/Concurrency: A second cancel is 409.

Authorization

bearerToken
headerAuthorizationBearer <token>

An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.

Path Parameters

scopeId*string

Opaque ownership+authorization scope resolving to tenant + subscription + project.

proposalId*string
Lengthlength <= 64

Response Body

The proposal was cancelled.

application/json
  1. response
id*string
status*AssistantProposalStatusName
Value in"pending""confirming""confirmed""expired""cancelled"
curl -X POST "https://example.com/scopes/string/assistant/proposals/string/actions/cancel"
{  "id": "string",  "status": "pending"}