Skip to main content
POST
/
v1
/
flow-templates
cURL
curl --request POST \
  --url https://cloud.nrai.io/api/v1/flow-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template": {
    "displayName": "<string>",
    "trigger": {
      "name": "<string>",
      "valid": true,
      "displayName": "<string>",
      "type": "PIECE_TRIGGER",
      "settings": {
        "propertySettings": {},
        "pieceName": "<string>",
        "pieceVersion": "<string>",
        "input": {},
        "sampleData": {
          "sampleDataFileId": "<string>",
          "sampleDataInputFileId": "<string>",
          "lastTestDate": "<string>"
        },
        "customLogoUrl": "<string>",
        "triggerName": "<string>"
      },
      "nextAction": "<unknown>"
    },
    "valid": true,
    "agentIds": [
      "<string>"
    ],
    "connectionIds": [
      "<string>"
    ],
    "schemaVersion": "<string>",
    "backupFiles": {}
  },
  "type": "PLATFORM",
  "description": "<string>",
  "blogUrl": "<string>",
  "tags": [
    "<string>"
  ],
  "id": "<string>",
  "metadata": {}
}
'
import requests

url = "https://cloud.nrai.io/api/v1/flow-templates"

payload = {
"template": {
"displayName": "<string>",
"trigger": {
"name": "<string>",
"valid": True,
"displayName": "<string>",
"type": "PIECE_TRIGGER",
"settings": {
"propertySettings": {},
"pieceName": "<string>",
"pieceVersion": "<string>",
"input": {},
"sampleData": {
"sampleDataFileId": "<string>",
"sampleDataInputFileId": "<string>",
"lastTestDate": "<string>"
},
"customLogoUrl": "<string>",
"triggerName": "<string>"
},
"nextAction": "<unknown>"
},
"valid": True,
"agentIds": ["<string>"],
"connectionIds": ["<string>"],
"schemaVersion": "<string>",
"backupFiles": {}
},
"type": "PLATFORM",
"description": "<string>",
"blogUrl": "<string>",
"tags": ["<string>"],
"id": "<string>",
"metadata": {}
}
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({
template: {
displayName: '<string>',
trigger: {
name: '<string>',
valid: true,
displayName: '<string>',
type: 'PIECE_TRIGGER',
settings: {
propertySettings: {},
pieceName: '<string>',
pieceVersion: '<string>',
input: {},
sampleData: {
sampleDataFileId: '<string>',
sampleDataInputFileId: '<string>',
lastTestDate: '<string>'
},
customLogoUrl: '<string>',
triggerName: '<string>'
},
nextAction: '<unknown>'
},
valid: true,
agentIds: ['<string>'],
connectionIds: ['<string>'],
schemaVersion: '<string>',
backupFiles: {}
},
type: 'PLATFORM',
description: '<string>',
blogUrl: '<string>',
tags: ['<string>'],
id: '<string>',
metadata: {}
})
};

fetch('https://cloud.nrai.io/api/v1/flow-templates', 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://cloud.nrai.io/api/v1/flow-templates",
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([
'template' => [
'displayName' => '<string>',
'trigger' => [
'name' => '<string>',
'valid' => true,
'displayName' => '<string>',
'type' => 'PIECE_TRIGGER',
'settings' => [
'propertySettings' => [

],
'pieceName' => '<string>',
'pieceVersion' => '<string>',
'input' => [

],
'sampleData' => [
'sampleDataFileId' => '<string>',
'sampleDataInputFileId' => '<string>',
'lastTestDate' => '<string>'
],
'customLogoUrl' => '<string>',
'triggerName' => '<string>'
],
'nextAction' => '<unknown>'
],
'valid' => true,
'agentIds' => [
'<string>'
],
'connectionIds' => [
'<string>'
],
'schemaVersion' => '<string>',
'backupFiles' => [

]
],
'type' => 'PLATFORM',
'description' => '<string>',
'blogUrl' => '<string>',
'tags' => [
'<string>'
],
'id' => '<string>',
'metadata' => [

]
]),
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://cloud.nrai.io/api/v1/flow-templates"

payload := strings.NewReader("{\n \"template\": {\n \"displayName\": \"<string>\",\n \"trigger\": {\n \"name\": \"<string>\",\n \"valid\": true,\n \"displayName\": \"<string>\",\n \"type\": \"PIECE_TRIGGER\",\n \"settings\": {\n \"propertySettings\": {},\n \"pieceName\": \"<string>\",\n \"pieceVersion\": \"<string>\",\n \"input\": {},\n \"sampleData\": {\n \"sampleDataFileId\": \"<string>\",\n \"sampleDataInputFileId\": \"<string>\",\n \"lastTestDate\": \"<string>\"\n },\n \"customLogoUrl\": \"<string>\",\n \"triggerName\": \"<string>\"\n },\n \"nextAction\": \"<unknown>\"\n },\n \"valid\": true,\n \"agentIds\": [\n \"<string>\"\n ],\n \"connectionIds\": [\n \"<string>\"\n ],\n \"schemaVersion\": \"<string>\",\n \"backupFiles\": {}\n },\n \"type\": \"PLATFORM\",\n \"description\": \"<string>\",\n \"blogUrl\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"metadata\": {}\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://cloud.nrai.io/api/v1/flow-templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"template\": {\n \"displayName\": \"<string>\",\n \"trigger\": {\n \"name\": \"<string>\",\n \"valid\": true,\n \"displayName\": \"<string>\",\n \"type\": \"PIECE_TRIGGER\",\n \"settings\": {\n \"propertySettings\": {},\n \"pieceName\": \"<string>\",\n \"pieceVersion\": \"<string>\",\n \"input\": {},\n \"sampleData\": {\n \"sampleDataFileId\": \"<string>\",\n \"sampleDataInputFileId\": \"<string>\",\n \"lastTestDate\": \"<string>\"\n },\n \"customLogoUrl\": \"<string>\",\n \"triggerName\": \"<string>\"\n },\n \"nextAction\": \"<unknown>\"\n },\n \"valid\": true,\n \"agentIds\": [\n \"<string>\"\n ],\n \"connectionIds\": [\n \"<string>\"\n ],\n \"schemaVersion\": \"<string>\",\n \"backupFiles\": {}\n },\n \"type\": \"PLATFORM\",\n \"description\": \"<string>\",\n \"blogUrl\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.nrai.io/api/v1/flow-templates")

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 \"template\": {\n \"displayName\": \"<string>\",\n \"trigger\": {\n \"name\": \"<string>\",\n \"valid\": true,\n \"displayName\": \"<string>\",\n \"type\": \"PIECE_TRIGGER\",\n \"settings\": {\n \"propertySettings\": {},\n \"pieceName\": \"<string>\",\n \"pieceVersion\": \"<string>\",\n \"input\": {},\n \"sampleData\": {\n \"sampleDataFileId\": \"<string>\",\n \"sampleDataInputFileId\": \"<string>\",\n \"lastTestDate\": \"<string>\"\n },\n \"customLogoUrl\": \"<string>\",\n \"triggerName\": \"<string>\"\n },\n \"nextAction\": \"<unknown>\"\n },\n \"valid\": true,\n \"agentIds\": [\n \"<string>\"\n ],\n \"connectionIds\": [\n \"<string>\"\n ],\n \"schemaVersion\": \"<string>\",\n \"backupFiles\": {}\n },\n \"type\": \"PLATFORM\",\n \"description\": \"<string>\",\n \"blogUrl\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"metadata\": {}\n}"

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

Authorizations

Authorization
string
header
required

Use your api key generated from the admin console

Body

application/json
template
object
required
type
required
Available options:
PLATFORM
description
string
blogUrl
string
tags
string[]
id
string
metadata
object | null

Response

200

Default Response