Create run

Create a new orchestration run

POST /orchestration/runs

Create run

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "releaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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>"
    }
  ],
  "data": "<unknown>"
}
'

import requests

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

payload = {
    "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "releaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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>"
        }
    ],
    "data": "<unknown>"
}
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({
    workflowUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    releaseUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    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>'
      }
    ],
    data: '<unknown>'
  })
};

fetch('https://api.getcargo.io/v1/orchestration/runs', 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",
  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([
    'workflowUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'releaseUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    '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>'
        ]
    ],
    'data' => '<unknown>'
  ]),
  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://api.getcargo.io/v1/orchestration/runs"

	payload := strings.NewReader("{\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodes\": [\n    {\n      \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"slug\": \"<string>\",\n      \"config\": {},\n      \"childrenUuids\": [\n        \"<string>\"\n      ],\n      \"fallbackOnFailure\": true,\n      \"position\": {\n        \"x\": 123,\n        \"y\": 123\n      },\n      \"kind\": \"native\",\n      \"actionSlug\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"retry\": {\n        \"maximumAttempts\": 123,\n        \"initialInterval\": 123,\n        \"backoffCoefficient\": 123\n      },\n      \"fallbackChildUuid\": \"<string>\"\n    }\n  ],\n  \"data\": \"<unknown>\"\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://api.getcargo.io/v1/orchestration/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodes\": [\n    {\n      \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"slug\": \"<string>\",\n      \"config\": {},\n      \"childrenUuids\": [\n        \"<string>\"\n      ],\n      \"fallbackOnFailure\": true,\n      \"position\": {\n        \"x\": 123,\n        \"y\": 123\n      },\n      \"kind\": \"native\",\n      \"actionSlug\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"retry\": {\n        \"maximumAttempts\": 123,\n        \"initialInterval\": 123,\n        \"backoffCoefficient\": 123\n      },\n      \"fallbackChildUuid\": \"<string>\"\n    }\n  ],\n  \"data\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodes\": [\n    {\n      \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"slug\": \"<string>\",\n      \"config\": {},\n      \"childrenUuids\": [\n        \"<string>\"\n      ],\n      \"fallbackOnFailure\": true,\n      \"position\": {\n        \"x\": 123,\n        \"y\": 123\n      },\n      \"kind\": \"native\",\n      \"actionSlug\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"retry\": {\n        \"maximumAttempts\": 123,\n        \"initialInterval\": 123,\n        \"backoffCoefficient\": 123\n      },\n      \"fallbackChildUuid\": \"<string>\"\n    }\n  ],\n  \"data\": \"<unknown>\"\n}"

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>"
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Request body schema.

workflowUuid · string<uuid>

Workflow 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})$

releaseUuid · string<uuid>

Release identifier to run.

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})$

nodes · Nodes · object[]

Custom nodes to use for the run.

Option 1

Option 2

Option 3

Option 4

Show child attributes

data · any

Input data for the run.

Response

200

application/json

Successful response

run · Run · object · required

Created run details.

Show child attributes