Upload workflow bundle
curl --request POST \
--url https://api.trymaitai.ai/api/v1/workflows/upload \
--header 'Content-Type: application/json' \
--header 'X-Maitai-Api-Key: <api-key>' \
--data @- <<EOF
{
"workflow_ref_name": "hs_classification",
"script": "def execute(ctx):\n return {'ok': True}",
"application_name": "HS Classification Workflow",
"publish_version": true,
"version_bump": "patch",
"version_notes": "Initial release"
}
EOFimport requests
url = "https://api.trymaitai.ai/api/v1/workflows/upload"
payload = {
"workflow_ref_name": "hs_classification",
"script": "def execute(ctx):
return {'ok': True}",
"application_name": "HS Classification Workflow",
"publish_version": True,
"version_bump": "patch",
"version_notes": "Initial release"
}
headers = {
"X-Maitai-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Maitai-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflow_ref_name: 'hs_classification',
script: 'def execute(ctx):\n return {\'ok\': True}',
application_name: 'HS Classification Workflow',
publish_version: true,
version_bump: 'patch',
version_notes: 'Initial release'
})
};
fetch('https://api.trymaitai.ai/api/v1/workflows/upload', 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.trymaitai.ai/api/v1/workflows/upload",
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([
'workflow_ref_name' => 'hs_classification',
'script' => 'def execute(ctx):
return {\'ok\': True}',
'application_name' => 'HS Classification Workflow',
'publish_version' => true,
'version_bump' => 'patch',
'version_notes' => 'Initial release'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Maitai-Api-Key: <api-key>"
],
]);
$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.trymaitai.ai/api/v1/workflows/upload"
payload := strings.NewReader("{\n \"workflow_ref_name\": \"hs_classification\",\n \"script\": \"def execute(ctx):\\n return {'ok': True}\",\n \"application_name\": \"HS Classification Workflow\",\n \"publish_version\": true,\n \"version_bump\": \"patch\",\n \"version_notes\": \"Initial release\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Maitai-Api-Key", "<api-key>")
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.trymaitai.ai/api/v1/workflows/upload")
.header("X-Maitai-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_ref_name\": \"hs_classification\",\n \"script\": \"def execute(ctx):\\n return {'ok': True}\",\n \"application_name\": \"HS Classification Workflow\",\n \"publish_version\": true,\n \"version_bump\": \"patch\",\n \"version_notes\": \"Initial release\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trymaitai.ai/api/v1/workflows/upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Maitai-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_ref_name\": \"hs_classification\",\n \"script\": \"def execute(ctx):\\n return {'ok': True}\",\n \"application_name\": \"HS Classification Workflow\",\n \"publish_version\": true,\n \"version_bump\": \"patch\",\n \"version_notes\": \"Initial release\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 42,
"workflow_ref_name": "hs_classification",
"published_version": {
"version_number": "1.0.0"
},
"version_created": true
}
}Workflows
Upload workflow bundle
Upload or upsert a workflow bundle (script, accessories, optional version publish).
POST
/
workflows
/
upload
Upload workflow bundle
curl --request POST \
--url https://api.trymaitai.ai/api/v1/workflows/upload \
--header 'Content-Type: application/json' \
--header 'X-Maitai-Api-Key: <api-key>' \
--data @- <<EOF
{
"workflow_ref_name": "hs_classification",
"script": "def execute(ctx):\n return {'ok': True}",
"application_name": "HS Classification Workflow",
"publish_version": true,
"version_bump": "patch",
"version_notes": "Initial release"
}
EOFimport requests
url = "https://api.trymaitai.ai/api/v1/workflows/upload"
payload = {
"workflow_ref_name": "hs_classification",
"script": "def execute(ctx):
return {'ok': True}",
"application_name": "HS Classification Workflow",
"publish_version": True,
"version_bump": "patch",
"version_notes": "Initial release"
}
headers = {
"X-Maitai-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Maitai-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflow_ref_name: 'hs_classification',
script: 'def execute(ctx):\n return {\'ok\': True}',
application_name: 'HS Classification Workflow',
publish_version: true,
version_bump: 'patch',
version_notes: 'Initial release'
})
};
fetch('https://api.trymaitai.ai/api/v1/workflows/upload', 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.trymaitai.ai/api/v1/workflows/upload",
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([
'workflow_ref_name' => 'hs_classification',
'script' => 'def execute(ctx):
return {\'ok\': True}',
'application_name' => 'HS Classification Workflow',
'publish_version' => true,
'version_bump' => 'patch',
'version_notes' => 'Initial release'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Maitai-Api-Key: <api-key>"
],
]);
$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.trymaitai.ai/api/v1/workflows/upload"
payload := strings.NewReader("{\n \"workflow_ref_name\": \"hs_classification\",\n \"script\": \"def execute(ctx):\\n return {'ok': True}\",\n \"application_name\": \"HS Classification Workflow\",\n \"publish_version\": true,\n \"version_bump\": \"patch\",\n \"version_notes\": \"Initial release\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Maitai-Api-Key", "<api-key>")
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.trymaitai.ai/api/v1/workflows/upload")
.header("X-Maitai-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_ref_name\": \"hs_classification\",\n \"script\": \"def execute(ctx):\\n return {'ok': True}\",\n \"application_name\": \"HS Classification Workflow\",\n \"publish_version\": true,\n \"version_bump\": \"patch\",\n \"version_notes\": \"Initial release\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trymaitai.ai/api/v1/workflows/upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Maitai-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_ref_name\": \"hs_classification\",\n \"script\": \"def execute(ctx):\\n return {'ok': True}\",\n \"application_name\": \"HS Classification Workflow\",\n \"publish_version\": true,\n \"version_bump\": \"patch\",\n \"version_notes\": \"Initial release\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 42,
"workflow_ref_name": "hs_classification",
"published_version": {
"version_number": "1.0.0"
},
"version_created": true
}
}Authorizations
Your Maitai API key from the Portal.
Body
application/json
Workflow Python source. Or multipart script_file / workflow_file / file.
Display name. Defaults from workflow_ref_name when omitted.
Available options:
sync, async, stream Bind to application by name; creates if missing.
Publish an immutable workflow version after upload.
Notes for the published version.
Semver bump when publishing. Defaults to minor.
Available options:
major, minor, patch Inline accessories as base64 objects (multipart accessory_ also supported).
Show child attributes
Show child attributes
Response
200 - application/json
Upload workflow bundle.
Was this page helpful?
⌘I