Operations

Stop an operation

Scope projects.write. Asks the operation to stop and answers its state. Work a provider has already accepted may still finish and use credits (pendingProvider). Asking twice is safe.

post/operations/{requestId}/stop

Request

  • Base URL: https://app.vulk.dev/api/v1
  • URL: https://app.vulk.dev/api/v1/operations/{requestId}/stop
  • Auth: HTTP bearer

Response

The operation, with stopStatus advanced.

requestIdstring uuid required
projectIdstring nullable
operationStatus'running' | 'waiting' | 'done' | 'failed' | 'orphan' | 'null' nullable required

running while VULK works · waiting when a question needs your answer · done · failed · orphan when the process ended without a result · null before the operation was registered.

stopStatus'running' | 'stopping' | 'stopped' | 'already-delivered' required

stopping after a stop request, stopped once honoured, already-delivered when the work finished first.

pendingProviderboolean required

True while an already accepted provider call may still finish and use credits.

decision'GENERATE' | 'RESPOND' | 'CLARIFY' | 'ERROR' | 'null' nullable

How VULK answered: GENERATE built, RESPOND answered in words, CLARIFY asked questions, ERROR failed; null while undecided.

startedAtstring date-time nullable
finishedAtstring date-time nullable
editorUrlstring uri nullable
currentProjectPreviewUrlstring uri nullable
currentProjectLiveUrlstring uri nullable
responsesTruncatedboolean required

True when replies were left out or cut.

Changes

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