Get run

Get an orchestration run by UUID

GET /orchestration/runs/{uuid}

Get run

cURL

curl --request GET \
  --url https://api.getcargo.io/v1/orchestration/runs/{uuid} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.getcargo.io/v1/orchestration/runs/{uuid}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getcargo.io/v1/orchestration/runs/{uuid}', 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.getcargo.io/v1/orchestration/runs/{uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.getcargo.io/v1/orchestration/runs/{uuid}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.getcargo.io/v1/orchestration/runs/{uuid}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/orchestration/runs/{uuid}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "run": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "workflowUuid": "<string>",
    "userUuid": "<string>",
    "releaseUuid": "<string>",
    "nodes": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "config": {},
        "childrenUuids": [
          "<string>"
        ],
        "fallbackOnFailure": true,
        "position": {
          "x": 123,
          "y": 123
        },
        "kind": "native",
        "actionSlug": "<string>",
        "name": "<string>",
        "description": "<string>",
        "retry": {
          "maximumAttempts": 123,
          "initialInterval": 123,
          "backoffCoefficient": 123
        },
        "fallbackChildUuid": "<string>"
      }
    ],
    "batchUuid": "<string>",
    "traceUuid": "<string>",
    "temporalWorkflowId": "<string>",
    "recordId": "<string>",
    "recordTitle": "<string>",
    "contextS3Filename": "<string>",
    "computedConfigsS3Filename": "<string>",
    "parentUuid": "<string>",
    "parentNodeUuid": "<string>",
    "parentBatchUuid": "<string>",
    "parentAgentUuid": "<string>",
    "parentChatUuid": "<string>",
    "parentMessageUuid": "<string>",
    "isGroupParent": true,
    "errorMessage": "<string>",
    "executions": [
      {
        "nodeUuid": "<string>",
        "nodeSlug": "<string>",
        "nodeBatchUuid": "<string>",
        "nodeRunUuid": "<string>",
        "nodeMessageUuid": "<string>",
        "nodeChildIndex": 123,
        "nextNodeUuid": "<string>",
        "errorMessage": "<string>",
        "title": "<string>",
        "iconUrl": "<string>",
        "creditsUsedCount": 123,
        "nodeWaitUntilFinished": true,
        "nodeKind": "<string>",
        "nodeActionSlug": "<string>"
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "finishedAt": "<string>",
    "deletedAt": "<string>"
  },
  "runComputedConfigs": {},
  "runContext": {}
}

Authorizations

Authorization · string · header · required

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

Path Parameters

uuid · string<uuid> · required

Run identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

200

application/json

Successful response

run · Run · object · required

Run details.

Show child attributes

runComputedConfigs · Run computed configs · object · required

Computed configuration values for the run.

Show child attributes

runContext · Run context · object · required

Context values captured for the run.

Show child attributes