Skip to main content
POST
/
v1
/
projects
cURL
curl --request POST \
  --url https://cloud.nrai.io/api/v1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "externalId": "<string>",
  "metadata": {}
}
'
import requests

url = "https://cloud.nrai.io/api/v1/projects"

payload = {
"displayName": "<string>",
"externalId": "<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({displayName: '<string>', externalId: '<string>', metadata: {}})
};

fetch('https://cloud.nrai.io/api/v1/projects', 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/projects",
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([
'displayName' => '<string>',
'externalId' => '<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/projects"

payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"externalId\": \"<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/projects")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.nrai.io/api/v1/projects")

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 \"displayName\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "ownerId": "<string>",
  "displayName": "<string>",
  "notifyStatus": "NEVER",
  "platformId": "<string>",
  "releasesEnabled": true,
  "usage": {
    "tasks": 123,
    "aiCredits": 123,
    "nextLimitResetDate": 123
  },
  "plan": {
    "id": "<string>",
    "created": "<string>",
    "updated": "<string>",
    "projectId": "<string>",
    "locked": false,
    "name": "<string>",
    "piecesFilterType": "NONE",
    "pieces": [
      "<string>"
    ],
    "tasks": 123,
    "aiCredits": 123
  },
  "analytics": {
    "totalUsers": 123,
    "activeUsers": 123,
    "totalFlows": 123,
    "activeFlows": 123
  },
  "externalId": "<string>",
  "metadata": {}
}

Authorizations

Authorization
string
header
required

Use your api key generated from the admin console

Body

application/json
displayName
string
required
Pattern: ^[^./]+$
externalId
string | null
metadata
object | null

Response

201 - application/json

Default Response

id
string
required
created
string
required
updated
string
required
ownerId
string
required
displayName
string
required
notifyStatus
required
Available options:
NEVER
platformId
string
required
Pattern: ^[0-9a-zA-Z]{21}$
releasesEnabled
boolean
required
usage
object
required
plan
object
required
analytics
object
required
externalId
string
metadata
object | null