Execute action
curl --request POST \
--url https://api.getcargo.io/v1/orchestration/actions/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": {
"config": {},
"kind": "native",
"actionSlug": "<string>",
"retry": {
"maximumAttempts": 123,
"initialInterval": 123,
"backoffCoefficient": 123
}
},
"data": "<unknown>"
}
'import requests
url = "https://api.getcargo.io/v1/orchestration/actions/execute"
payload = {
"action": {
"config": {},
"kind": "native",
"actionSlug": "<string>",
"retry": {
"maximumAttempts": 123,
"initialInterval": 123,
"backoffCoefficient": 123
}
},
"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({
action: {
config: {},
kind: 'native',
actionSlug: '<string>',
retry: {maximumAttempts: 123, initialInterval: 123, backoffCoefficient: 123}
},
data: '<unknown>'
})
};
fetch('https://api.getcargo.io/v1/orchestration/actions/execute', 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/actions/execute",
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([
'action' => [
'config' => [
],
'kind' => 'native',
'actionSlug' => '<string>',
'retry' => [
'maximumAttempts' => 123,
'initialInterval' => 123,
'backoffCoefficient' => 123
]
],
'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/actions/execute"
payload := strings.NewReader("{\n \"action\": {\n \"config\": {},\n \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\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/actions/execute")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": {\n \"config\": {},\n \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\n }\n },\n \"data\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/orchestration/actions/execute")
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 \"action\": {\n \"config\": {},\n \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\n }\n },\n \"data\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}Orchestration - Actions
Execute action
Execute an orchestration action
POST
/
orchestration
/
actions
/
execute
Execute action
curl --request POST \
--url https://api.getcargo.io/v1/orchestration/actions/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": {
"config": {},
"kind": "native",
"actionSlug": "<string>",
"retry": {
"maximumAttempts": 123,
"initialInterval": 123,
"backoffCoefficient": 123
}
},
"data": "<unknown>"
}
'import requests
url = "https://api.getcargo.io/v1/orchestration/actions/execute"
payload = {
"action": {
"config": {},
"kind": "native",
"actionSlug": "<string>",
"retry": {
"maximumAttempts": 123,
"initialInterval": 123,
"backoffCoefficient": 123
}
},
"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({
action: {
config: {},
kind: 'native',
actionSlug: '<string>',
retry: {maximumAttempts: 123, initialInterval: 123, backoffCoefficient: 123}
},
data: '<unknown>'
})
};
fetch('https://api.getcargo.io/v1/orchestration/actions/execute', 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/actions/execute",
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([
'action' => [
'config' => [
],
'kind' => 'native',
'actionSlug' => '<string>',
'retry' => [
'maximumAttempts' => 123,
'initialInterval' => 123,
'backoffCoefficient' => 123
]
],
'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/actions/execute"
payload := strings.NewReader("{\n \"action\": {\n \"config\": {},\n \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\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/actions/execute")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": {\n \"config\": {},\n \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\n }\n },\n \"data\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/orchestration/actions/execute")
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 \"action\": {\n \"config\": {},\n \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\n }\n },\n \"data\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Successful response
Created run details.
Show child attributes
Show child attributes
Was this page helpful?
⌘I

