Update flow definition - SuperAI Flows

Update flow definition

cURL

curl --request PUT \
  --url https://flows.super.ai/api/flows/{flow_id}/definition \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "definition": {}
}
'

Python

import requests

url = "https://flows.super.ai/api/flows/{flow_id}/definition"

payload = { "definition": {} }
headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'PUT',
  headers: {
    'X-API-Key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({definition: {}})
};

fetch('https://flows.super.ai/api/flows/{flow_id}/definition', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://flows.super.ai/api/flows/{flow_id}/definition",\
  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([\
    'definition' => [\
\
    ]\
  ]),\
  CURLOPT_HTTPHEADER => [\
    "Authorization: Bearer <token>",\
    "Content-Type: application/json",\
    "X-API-Key: <api-key>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://flows.super.ai/api/flows/{flow_id}/definition"

payload := strings.NewReader("{\n  \"definition\": {}\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
    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))

}

Java (Unirest)

HttpResponse<String> response = Unirest.put("https://flows.super.ai/api/flows/{flow_id}/definition")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"definition\": {}\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/flows/{flow_id}/definition")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"definition\": {}\n}"

response = http.request(request)
puts response.read_body

Response Example

{
  "created_at": "2023-11-07T05:31:56Z",
  "definition": {},
  "display_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_latest": true,
  "modified_by": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "version": 2,
  "description": "<string>",
  "flow_executions_count": 0,
  "settings": {
    "reexecute_on_update": false,
    "ttl": {}
  },
  "task_names": [
    "<string>"
  ],
  "validation_errors": [
    {
      "input": "<unknown>",
      "loc": [
        123
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "url": "<string>"
    }
  ]
}

Authorizations

X-API-Key: API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Authorization: JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Path Parameters

Query Parameters

Response