Execute a workflow. | Scout

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

workflow_idstringRequired

Query parameters

environmentstring or nullOptionalDefaults to production

Specifies the execution environment for the workflow. The available environments include:

production: The production environment, where workflows are executed under live conditions.
staging: A staging environment used for testing prior to production deployment.
development: A development environment used for testing new changes.
console: The console environment, runs latest changes on a workflow.

Specifies the execution environment for the workflow. The available environments include: - `production`: The production environment, where workflows are executed under live conditions. - `staging`: A staging environment used for testing prior to production deployment. - `development`: A development environment used for testing new changes. - `console`: The console environment, runs latest changes on a workflow.

revision_idstring or nullOptional

session_idstring or nullOptional

Request

This endpoint expects an object.

streamingtrueRequired

inputsmap from strings to booleans or maps from strings to any or doubles or integers or lists of any or stringsOptional

Response

WorkflowRunStartedobject

WorkflowRunCompletedobject

WorkflowRunFailedobject

BlockRunStartedobject

BlockRunCompletedobject

BlockRunFailedobject

BlockStateUpdatedobject

1	from scoutos import Scout
2
3	client = Scout(
4	api_key="YOUR_API_KEY",
5	)
6	response = client.workflows.run_stream(
7	workflow_id="workflow_id",
8	environment="environment",
9	revision_id="revision_id",
10	session_id="session_id",
11	)
12	for chunk in response.data:
13	yield chunk