Skip to main content
POST
/
start_pipeline
Start flow run
curl --request POST \
  --url https://api.gumloop.com/api/v1/start_pipeline \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": "<string>",
  "project_id": "<string>",
  "saved_item_id": "<string>",
  "pipeline_inputs": [
    {
      "input_name": "<string>",
      "value": "<string>"
    }
  ]
}'
{
  "run_id": "<string>",
  "saved_item_id": "<string>",
  "workbook_id": "<string>",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
user_id
string
required

The id for the user initiating the flow.

​
saved_item_id
string
required

The id for the saved flow.

​
project_id
string

(Optional) The id of the project within which the flow is executed.

​
pipeline_inputs
object[]

A list of inputs for the flow, each containing key-value pairs representing the Input nodes and values that should go into them. The following argument names are reserved for internal use and should not be used as pipeline input names: api_key, saved_item_id, user_id, project_id, openai_token, action_id, reuse_action, trigger_id, pipeline_inputs.

Response

Flow started successfully

​
run_id
string
​
saved_item_id
string
​
workbook_id
string
​
url
string