runs

Stop a run

It goes no further than the step it is on, and what it wrote is kept. Stopping one that has ended changes nothing.

post/workspaces/{id}/runs/{runId}/stop

Request

  • Base URL: https://api.swingfactor.ai/v1
  • URL: https://api.swingfactor.ai/v1/workspaces/{id}/runs/{runId}/stop
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The workspace's id (a UUID).

runIdstring uuid required

The run's id (a UUID).

Response

The run, stopped or as it ended.

idstring uuid required
kind'draft' required
subjectIdstring uuid required

What the run is about.

status'queued' | 'running' | 'done' | 'failed' | 'stopped' required

A run left unfinished for half an hour is failed, whatever stopped it saying so.

stepstring nullable required

The step it is on.

errorstring nullable required

Why it failed, in words.

inputobject required

What it was started with.

outcomeobject nullable required

What it came to, once it ended.

startedBystring uuid nullable required
startedByNamestring nullable required

Who started it — or the product, where it followed from something else.

createdAtstring required
finishedAtstring nullable required

Changes

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