Get Workflow Version Execution Results

GET /workflow-version-execution-results

Get Workflow Version Execution Results

cURL

curl --request GET \
  --url https://api.promptlayer.com/workflow-version-execution-results \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.promptlayer.com/workflow-version-execution-results"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.promptlayer.com/workflow-version-execution-results', 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://api.promptlayer.com/workflow-version-execution-results",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.promptlayer.com/workflow-version-execution-results"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.promptlayer.com/workflow-version-execution-results")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.promptlayer.com/workflow-version-execution-results")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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

200 (all)

{
  "Node 1": {
    "status": "SUCCESS",
    "value": "First node result",
    "error_message": null,
    "raw_error_message": null,
    "is_output_node": false
  },
  "Node 2": {
    "status": "SUCCESS",
    "value": "Final result",
    "error_message": null,
    "raw_error_message": null,
    "is_output_node": true
  }
}

"Final result"

{
  "Node 1": {
    "status": "SUCCESS",
    "value": "First node result",
    "error_message": null,
    "raw_error_message": null,
    "is_output_node": false
  },
  "Node 2": {
    "status": "RUNNING",
    "value": null,
    "error_message": null,
    "raw_error_message": null,
    "is_output_node": true
  }
}

Retrieve the execution results of a specific Workflow version. You can include all output nodes by setting the return_all_outputs query parameter to true.

Status	Meaning
200	Execution is complete. All nodes have reached a final status (SUCCESS, FAILED, or SKIPPED).
202	Execution is still running. At least one node is in a non-final status (QUEUED or RUNNING).

The response body schema is the same for both status codes. Poll until you receive a 200.

200 (all)

{
  "Node 1": {
    "status": "SUCCESS",
    "value": "First node result",
    "error_message": null,
    "raw_error_message": null,
    "is_output_node": false
  },
  "Node 2": {
    "status": "SUCCESS",
    "value": "Final result",
    "error_message": null,
    "raw_error_message": null,
    "is_output_node": true
  }
}

"Final result"

{
  "Node 1": {
    "status": "SUCCESS",
    "value": "First node result",
    "error_message": null,
    "raw_error_message": null,
    "is_output_node": false
  },
  "Node 2": {
    "status": "RUNNING",
    "value": null,
    "error_message": null,
    "raw_error_message": null,
    "is_output_node": true
  }
}

Authorizations

X-API-KEY · string · header · required

Query Parameters

workflow_version_execution_id · integer<int64> · required

The unique identifier of the workflow version execution whose results you want to retrieve.

return_all_outputs · boolean · default: false

When set to true, the response includes all output nodes' results. If omitted or set to false, only the main output is returned.

Response

200

application/json

Successful response with execution results.

{key} · object

Show child attributes