Get workflow
curl --request GET \
--url https://api.getcargo.io/v1/orchestration/workflows/{uuid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getcargo.io/v1/orchestration/workflows/{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/workflows/{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/workflows/{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/workflows/{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/workflows/{uuid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/orchestration/workflows/{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{
"workflow": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"nodes": [
{
"uuid": "<string>",
"slug": "<string>",
"nodes": "<array>",
"isArchived": true,
"kind": "native",
"actionSlug": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"playUuid": "<string>",
"toolUuid": "<string>",
"folderUuid": "<string>",
"template": {
"slug": "<string>",
"isAvailable": true,
"scope": "public"
},
"lastBatch": {
"uuid": "<string>",
"status": "pending",
"runsStatus": "healthy",
"errorMessage": "<string>",
"createdAt": "<string>",
"finishedAt": "<string>"
},
"deployedRelease": {
"uuid": "<string>",
"userUuid": "<string>",
"description": "<string>",
"version": "<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>"
}
],
"formFields": [
{
"slug": "<string>",
"name": "<string>",
"kind": "string",
"description": "<string>",
"placeholder": "<string>",
"isRequired": true
}
],
"templateSlug": "<string>",
"deployedAt": "<string>",
"createdAt": "<string>"
}
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Orchestration - Workflows
Get workflow
Get a workflow by UUID (GET /orchestration/workflows/).
GET
/
orchestration
/
workflows
/
{uuid}
Get workflow
curl --request GET \
--url https://api.getcargo.io/v1/orchestration/workflows/{uuid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getcargo.io/v1/orchestration/workflows/{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/workflows/{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/workflows/{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/workflows/{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/workflows/{uuid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/orchestration/workflows/{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{
"workflow": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"nodes": [
{
"uuid": "<string>",
"slug": "<string>",
"nodes": "<array>",
"isArchived": true,
"kind": "native",
"actionSlug": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"playUuid": "<string>",
"toolUuid": "<string>",
"folderUuid": "<string>",
"template": {
"slug": "<string>",
"isAvailable": true,
"scope": "public"
},
"lastBatch": {
"uuid": "<string>",
"status": "pending",
"runsStatus": "healthy",
"errorMessage": "<string>",
"createdAt": "<string>",
"finishedAt": "<string>"
},
"deployedRelease": {
"uuid": "<string>",
"userUuid": "<string>",
"description": "<string>",
"version": "<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>"
}
],
"formFields": [
{
"slug": "<string>",
"name": "<string>",
"kind": "string",
"description": "<string>",
"placeholder": "<string>",
"isRequired": true
}
],
"templateSlug": "<string>",
"deployedAt": "<string>",
"createdAt": "<string>"
}
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Authorizations
bearerAuthoauth2
API token from cargo-ai login. Send as Authorization: Bearer <token>.
Path Parameters
Workflow identifier.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Response
Get workflow
Workflow details.
Show child attributes
Show child attributes
Was this page helpful?