Skip to main content
GET
/
v1
/
flows
/
{id}
cURL
curl --request GET \
  --url https://cloud.nrai.io/api/v1/flows/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://cloud.nrai.io/api/v1/flows/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://cloud.nrai.io/api/v1/flows/{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://cloud.nrai.io/api/v1/flows/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://cloud.nrai.io/api/v1/flows/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://cloud.nrai.io/api/v1/flows/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.nrai.io/api/v1/flows/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "projectId": "<string>",
  "externalId": "<string>",
  "status": "ENABLED",
  "version": {
    "id": "<string>",
    "created": "<string>",
    "updated": "<string>",
    "flowId": "<string>",
    "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>"
    ],
    "state": "LOCKED",
    "connectionIds": [
      "<string>"
    ],
    "updatedBy": "<string>",
    "schemaVersion": "<string>",
    "backupFiles": {}
  },
  "folderId": "<string>",
  "publishedVersionId": "<string>",
  "metadata": {},
  "triggerSource": {
    "schedule": {
      "type": "CRON_EXPRESSION",
      "cronExpression": "<string>",
      "timezone": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

Use your api key generated from the admin console

Path Parameters

id
string
required
Pattern: ^[0-9a-zA-Z]{21}$

Query Parameters

versionId
string

Response

200 - application/json

Default Response

id
string
required
created
string
required
updated
string
required
projectId
string
required
externalId
string
required
status
required
Available options:
ENABLED
version
object
required
folderId
string | null
publishedVersionId
string | null
metadata
object | null
triggerSource
object