For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • POSTCreate a new workflow revision
      • GETList all workflows
      • POSTCreate a new workflow
      • GETGet a workflow by ID
      • PUTUpdate a workflow
      • DELDelete a workflow
      • STREAMExecute a workflow.
      • POSTExecute a workflow with provided config.
LogoLogo
Scout DocsAccess Scout
EndpointsWorkflows

Execute a workflow with provided config.

Beta
POST
https://api.scoutos.com/v2/workflows/execute
POST
/v2/workflows/execute
$curl -X POST https://api.scoutos.com/v2/workflows/execute \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "workflow_config": {}
>}'
1{
2  "organization_id": "org_9f8b7c6d5e4a3b2c1d0e",
3  "id": "evt_1234567890abcdef",
4  "correlation_id": "corr_abcdef1234567890",
5  "name": "workflow_run_started",
6  "environment": "development",
7  "timestamp": "2024-06-15T12:34:56Z",
8  "data": {
9    "actor": {
10      "id": "user_9876543210fedcba",
11      "type": "external"
12    },
13    "workflow_id": "wf_0011223344556677",
14    "workflow_run_id": "run_8899aabbccddeeff",
15    "inputs": {},
16    "session_id": "sess_1122334455667788",
17    "state": {},
18    "workflow_config": {},
19    "price": 1.1
20  },
21  "price": "1.10",
22  "event_type": "workflow_event",
23  "version": "1.0"
24}
Was this page helpful?
Previous

Update a workflow revision

Next
Built with

Authentication

AuthorizationBearer

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

Query parameters

environmentstring or nullOptional
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.
workflow_configobjectRequired
workflow_keystring or nullOptional
inputsmap from strings to booleans or maps from strings to any or doubles or integers or lists of any or stringsOptional
streamingbooleanOptionalDefaults to false

Response

Successful Response
WorkflowsRunWithConfigResponse2000object
OR
WorkflowRunResponseobject

Errors

422
Unprocessable Entity Error

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.