Get action output schema
curl --request POST \
--url https://api.getcargo.io/v1/orchestration/actions/get-output-schema \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": {
"kind": "native",
"actionSlug": "<string>",
"retry": {
"maximumAttempts": 123,
"initialInterval": 123,
"backoffCoefficient": 123
}
},
"data": {}
}
'import requests
url = "https://api.getcargo.io/v1/orchestration/actions/get-output-schema"
payload = {
"action": {
"kind": "native",
"actionSlug": "<string>",
"retry": {
"maximumAttempts": 123,
"initialInterval": 123,
"backoffCoefficient": 123
}
},
"data": {}
}
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: {
kind: 'native',
actionSlug: '<string>',
retry: {maximumAttempts: 123, initialInterval: 123, backoffCoefficient: 123}
},
data: {}
})
};
fetch('https://api.getcargo.io/v1/orchestration/actions/get-output-schema', 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/get-output-schema",
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' => [
'kind' => 'native',
'actionSlug' => '<string>',
'retry' => [
'maximumAttempts' => 123,
'initialInterval' => 123,
'backoffCoefficient' => 123
]
],
'data' => [
]
]),
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/get-output-schema"
payload := strings.NewReader("{\n \"action\": {\n \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\n }\n },\n \"data\": {}\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/get-output-schema")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": {\n \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\n }\n },\n \"data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/orchestration/actions/get-output-schema")
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 \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\n }\n },\n \"data\": {}\n}"
response = http.request(request)
puts response.read_body{
"schema": {}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Orchestration - Actions
Get action output schema
Get the output schema of an orchestration action (POST /orchestration/actions/get-output-schema).
POST
/
orchestration
/
actions
/
get-output-schema
Get action output schema
curl --request POST \
--url https://api.getcargo.io/v1/orchestration/actions/get-output-schema \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": {
"kind": "native",
"actionSlug": "<string>",
"retry": {
"maximumAttempts": 123,
"initialInterval": 123,
"backoffCoefficient": 123
}
},
"data": {}
}
'import requests
url = "https://api.getcargo.io/v1/orchestration/actions/get-output-schema"
payload = {
"action": {
"kind": "native",
"actionSlug": "<string>",
"retry": {
"maximumAttempts": 123,
"initialInterval": 123,
"backoffCoefficient": 123
}
},
"data": {}
}
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: {
kind: 'native',
actionSlug: '<string>',
retry: {maximumAttempts: 123, initialInterval: 123, backoffCoefficient: 123}
},
data: {}
})
};
fetch('https://api.getcargo.io/v1/orchestration/actions/get-output-schema', 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/get-output-schema",
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' => [
'kind' => 'native',
'actionSlug' => '<string>',
'retry' => [
'maximumAttempts' => 123,
'initialInterval' => 123,
'backoffCoefficient' => 123
]
],
'data' => [
]
]),
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/get-output-schema"
payload := strings.NewReader("{\n \"action\": {\n \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\n }\n },\n \"data\": {}\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/get-output-schema")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": {\n \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\n }\n },\n \"data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/orchestration/actions/get-output-schema")
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 \"kind\": \"native\",\n \"actionSlug\": \"<string>\",\n \"retry\": {\n \"maximumAttempts\": 123,\n \"initialInterval\": 123,\n \"backoffCoefficient\": 123\n }\n },\n \"data\": {}\n}"
response = http.request(request)
puts response.read_body{
"schema": {}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<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>.
Headers
Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.
Maximum string length:
255Example:
"8e03978e-40d5-43e8-bc93-6894a57f9324"
Body
application/json
Response
Get action output schema
JSON schema of the action's data output.
Show child attributes
Show child attributes
Was this page helpful?

