Prompts

Cancel a pending or running prompt

Tells the project's agent to stop the prompt and marks it failed with error Cancelled by user. A prompt that already finished keeps its outcome and the call returns cancelled: false with its current status. Requires a CLI token (oclt_) or an org API key with prompts:write; agent tokens are rejected.

post/api/v1/prompts/{id}/cancel

Request

  • Base URL: https://getorquesta.com
  • URL: https://getorquesta.com/api/v1/prompts/{id}/cancel
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring uuid required

Response

Cancellation result.

cancelledboolean required
statusstring required

Changes

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