Start Workflow Run

Start workflow run

curl --request POST \
  --url https://app.enzo.health/api/v1/workflowRuns/{publicId}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prefilledVariables": {
    "Input File": "https://example.com/file.txt"
  },
  "workflowExecutionId": "<string>"
}
'

import requests

url = "https://app.enzo.health/api/v1/workflowRuns/{publicId}/start"

payload = {
    "prefilledVariables": { "Input File": "https://example.com/file.txt" },
    "workflowExecutionId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prefilledVariables: {'Input File': 'https://example.com/file.txt'},
    workflowExecutionId: '<string>'
  })
};

fetch('https://app.enzo.health/api/v1/workflowRuns/{publicId}/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.enzo.health/api/v1/workflowRuns/{publicId}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prefilledVariables' => [
        'Input File' => 'https://example.com/file.txt'
    ],
    'workflowExecutionId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.enzo.health/api/v1/workflowRuns/{publicId}/start"

	payload := strings.NewReader("{\n  \"prefilledVariables\": {\n    \"Input File\": \"https://example.com/file.txt\"\n  },\n  \"workflowExecutionId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.enzo.health/api/v1/workflowRuns/{publicId}/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prefilledVariables\": {\n    \"Input File\": \"https://example.com/file.txt\"\n  },\n  \"workflowExecutionId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.enzo.health/api/v1/workflowRuns/{publicId}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prefilledVariables\": {\n    \"Input File\": \"https://example.com/file.txt\"\n  },\n  \"workflowExecutionId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "sessionId": "<string>",
  "workflow": {
    "id": "<string>"
  },
  "workflowExecutionId": "<string>",
  "logs": [
    {
      "status": "<string>",
      "description": "<string>",
      "details": "<unknown>"
    }
  ],
  "progress": 123,
  "event": {
    "id": "<string>",
    "name": "<string>",
    "payload": "<unknown>"
  }
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

POST

workflowRuns

{publicId}

start

Start workflow run

curl --request POST \
  --url https://app.enzo.health/api/v1/workflowRuns/{publicId}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prefilledVariables": {
    "Input File": "https://example.com/file.txt"
  },
  "workflowExecutionId": "<string>"
}
'

import requests

url = "https://app.enzo.health/api/v1/workflowRuns/{publicId}/start"

payload = {
    "prefilledVariables": { "Input File": "https://example.com/file.txt" },
    "workflowExecutionId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prefilledVariables: {'Input File': 'https://example.com/file.txt'},
    workflowExecutionId: '<string>'
  })
};

fetch('https://app.enzo.health/api/v1/workflowRuns/{publicId}/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.enzo.health/api/v1/workflowRuns/{publicId}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prefilledVariables' => [
        'Input File' => 'https://example.com/file.txt'
    ],
    'workflowExecutionId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.enzo.health/api/v1/workflowRuns/{publicId}/start"

	payload := strings.NewReader("{\n  \"prefilledVariables\": {\n    \"Input File\": \"https://example.com/file.txt\"\n  },\n  \"workflowExecutionId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.enzo.health/api/v1/workflowRuns/{publicId}/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prefilledVariables\": {\n    \"Input File\": \"https://example.com/file.txt\"\n  },\n  \"workflowExecutionId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.enzo.health/api/v1/workflowRuns/{publicId}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prefilledVariables\": {\n    \"Input File\": \"https://example.com/file.txt\"\n  },\n  \"workflowExecutionId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "sessionId": "<string>",
  "workflow": {
    "id": "<string>"
  },
  "workflowExecutionId": "<string>",
  "logs": [
    {
      "status": "<string>",
      "description": "<string>",
      "details": "<unknown>"
    }
  ],
  "progress": 123,
  "event": {
    "id": "<string>",
    "name": "<string>",
    "payload": "<unknown>"
  }
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Authorizations

Authorization

string

header

required

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

Path Parameters

publicId

string

required

Where to find my workflow's public ID?

Body

application/json

prefilledVariables

object

Show child attributes

Example:

{
  "Input File": "https://example.com/file.txt"
}

workflowExecutionId

string

Provide it if you'd like to overwrite an existing result.

Response

Successful response

sessionId

string

required

To save and use for /continue requests.

workflow

object

required

Show child attributes

workflowExecutionId

string

logs

object[]

Logs that were saved during the last execution

Show child attributes

progress

number

If enabled, this field will return a number between 0 and 100 indicating the current progress based on the longest remaining path of the workflow run.

event

object

Show child attributes

Getting Started

Workflow Run

Workflow

Results

Webhook

Processors

Credentials

Organizations

Patients

Voice Notes

Transcripts

Survey

Folders

Visits

OASIS

Subscribers

User

esign

Authorizations

Path Parameters

Body

Response