Skip to content

Reset Research Workflow

POST
/research-reports/workflow/reset

Reset the workflow to start fresh. NOT REVERSIBLE.

It discards the workflow’s progress. Nothing is spent by resetting - but everything that was generated has to be generated again, so the real cost of this call is the run that follows it.

Spends nothing.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Address the whole six-report workflow for one website.

object
website_url
required
string

Responses

200

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string