Update workflow
curl --request PUT \
--url https://api.trymaitai.ai/api/v1/workflows/{workflow_id} \
--header 'Content-Type: application/json' \
--header 'X-Maitai-Api-Key: <api-key>' \
--data '
{
"description": "Refined workflow with reviewer step.",
"script": "def execute(ctx):\n ..."
}
'import requests
url = "https://api.trymaitai.ai/api/v1/workflows/{workflow_id}"
payload = {
"description": "Refined workflow with reviewer step.",
"script": "def execute(ctx):
..."
}
headers = {
"X-Maitai-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Maitai-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Refined workflow with reviewer step.',
script: 'def execute(ctx):\n ...'
})
};
fetch('https://api.trymaitai.ai/api/v1/workflows/{workflow_id}', 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/{workflow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'Refined workflow with reviewer step.',
'script' => 'def execute(ctx):
...'
]),
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/{workflow_id}"
payload := strings.NewReader("{\n \"description\": \"Refined workflow with reviewer step.\",\n \"script\": \"def execute(ctx):\\n ...\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.trymaitai.ai/api/v1/workflows/{workflow_id}")
.header("X-Maitai-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Refined workflow with reviewer step.\",\n \"script\": \"def execute(ctx):\\n ...\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trymaitai.ai/api/v1/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Maitai-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Refined workflow with reviewer step.\",\n \"script\": \"def execute(ctx):\\n ...\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 42,
"workflow_name": "HS Classification",
"description": "Refined workflow with reviewer step."
}
}Workflows
Update workflow
Update workflow metadata, script, schemas, or transform code.
PUT
/
workflows
/
{workflow_id}
Update workflow
curl --request PUT \
--url https://api.trymaitai.ai/api/v1/workflows/{workflow_id} \
--header 'Content-Type: application/json' \
--header 'X-Maitai-Api-Key: <api-key>' \
--data '
{
"description": "Refined workflow with reviewer step.",
"script": "def execute(ctx):\n ..."
}
'import requests
url = "https://api.trymaitai.ai/api/v1/workflows/{workflow_id}"
payload = {
"description": "Refined workflow with reviewer step.",
"script": "def execute(ctx):
..."
}
headers = {
"X-Maitai-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Maitai-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Refined workflow with reviewer step.',
script: 'def execute(ctx):\n ...'
})
};
fetch('https://api.trymaitai.ai/api/v1/workflows/{workflow_id}', 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/{workflow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'Refined workflow with reviewer step.',
'script' => 'def execute(ctx):
...'
]),
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/{workflow_id}"
payload := strings.NewReader("{\n \"description\": \"Refined workflow with reviewer step.\",\n \"script\": \"def execute(ctx):\\n ...\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.trymaitai.ai/api/v1/workflows/{workflow_id}")
.header("X-Maitai-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Refined workflow with reviewer step.\",\n \"script\": \"def execute(ctx):\\n ...\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trymaitai.ai/api/v1/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Maitai-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Refined workflow with reviewer step.\",\n \"script\": \"def execute(ctx):\\n ...\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 42,
"workflow_name": "HS Classification",
"description": "Refined workflow with reviewer step."
}
}Authorizations
Your Maitai API key from the Portal.
Path Parameters
Body
application/json
Full execute() workflow script. Re-uploads to S3 when provided.
Workflow execution mode.
Available options:
sync, async, stream Bind to application by name; creates if missing.
transform_session(session) Python script. Pass an empty string to clear.
Workflow input JSON Schema. Pass a JSON object.
Workflow output JSON Schema. Pass a JSON object.
Allow in-pod nested workflow invocations.
Child workflow refs allowed for in-pod routing.
Response
200 - application/json
Update workflow.
Was this page helpful?
⌘I