Stop Workbook
POST
/api/workbooks/{workbook_id}/stop
const url = 'http://localhost:8000/api/workbooks/example/stop';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:8000/api/workbooks/example/stop \ --header 'Authorization: Bearer <token>'Stop a running workbook.
Sets the workbook to paused (the run handler polls this and halts within a
couple seconds, before its next cell) and cancels the in-flight job so the
sequential worker is freed immediately instead of waiting out the run.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workbook_id
required
Workbook Id
string
Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”Successful Response
Media typeapplication/json
Examplegenerated
exampleValidation Error
Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{ "detail": [ { "ctx": {}, "input": "example", "loc": [ "example" ], "msg": "example", "type": "example" } ]}