Create and start a flow execution - SuperAI Flows

Create and start a flow execution

cURL

curl --request POST \
  --url https://flows.super.ai/api/flow-executions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "flow_id": "550e8400-e29b-41d4-a716-446655440000",
  "input": {
    "file_key": "documents/report.pdf",
    "options": {
      "language": "en"
    }
  }
}
'

Python

import requests

url = "https://flows.super.ai/api/flow-executions"

payload = {
    "flow_id": "550e8400-e29b-41d4-a716-446655440000",
    "input": {
        "file_key": "documents/report.pdf",
        "options": { "language": "en" }
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'POST',
  headers: {
    'X-API-Key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    flow_id: '550e8400-e29b-41d4-a716-446655440000',
    input: {file_key: 'documents/report.pdf', options: {language: 'en'}}
  })
};

fetch('https://flows.super.ai/api/flow-executions', 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/flow-executions",
  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([
    'flow_id' => '550e8400-e29b-41d4-a716-446655440000',
    'input' => [
        'file_key' => 'documents/report.pdf',
        'options' => [
                'language' => 'en'
        ]
    ]
  ]),
  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/flow-executions"

payload := strings.NewReader("{\n  \"flow_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"input\": {\n    \"file_key\": \"documents/report.pdf\",\n    \"options\": {\n      \"language\": \"en\"\n    }\n  }\n}")

req, _ := http.NewRequest("POST", 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.post("https://flows.super.ai/api/flow-executions")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"flow_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"input\": {\n    \"file_key\": \"documents/report.pdf\",\n    \"options\": {\n      \"language\": \"en\"\n    }\n  }\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/flow-executions")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"flow_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"input\": {\n    \"file_key\": \"documents/report.pdf\",\n    \"options\": {\n      \"language\": \"en\"\n    }\n  }\n}"

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

Response Example

{
  "created_at": "2023-11-07T05:31:56Z",
  "flow_id": "550e8400-e29b-41d4-a716-446655440000",
  "flow_version": 3,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "input": {
    "file_key": "documents/abc123.pdf",
    "metadata": {
      "priority": "high"
    }
  },
  "modified_by": "<string>",
  "organization_id": "660e8400-e29b-41d4-a716-446655440001",
  "status": "running",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Body Structure