Create a Project - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

POST

/ v2.0 /projects

Try it

Create a Project

cURL

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/projects \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "New Project",
  "color": "blue",
  "handoverConfiguration": {
    "setupLiveAgentInbox": true
  },
  "locale": "en-US"
}
'

import requests

url = "https://api-trial.cognigy.ai/new/v2.0/projects"

payload = {
    "name": "New Project",
    "color": "blue",
    "handoverConfiguration": { "setupLiveAgentInbox": True },
    "locale": "en-US"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'New Project',
    color: 'blue',
    handoverConfiguration: {setupLiveAgentInbox: true},
    locale: 'en-US'
  })
};

fetch('https://api-trial.cognigy.ai/new/v2.0/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://api-trial.cognigy.ai/new/v2.0/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([\
    'name' => 'New Project',\
    'color' => 'blue',\
    'handoverConfiguration' => [\
        'setupLiveAgentInbox' => true\
    ],\
    'locale' => 'en-US'\
  ]),\
  CURLOPT_HTTPHEADER => [\
    "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;
}

package main

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

func main() {

url := "https://api-trial.cognigy.ai/new/v2.0/projects"

payload := strings.NewReader("{\n  \"name\": \"New Project\",\n  \"color\": \"blue\",\n  \"handoverConfiguration\": {\n    \"setupLiveAgentInbox\": true\n  },\n  \"locale\": \"en-US\"\n}")

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

req.Header.Add("X-API-Key", "<api-key>")
    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://api-trial.cognigy.ai/new/v2.0/projects")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"New Project\",\n  \"color\": \"blue\",\n  \"handoverConfiguration\": {\n    \"setupLiveAgentInbox\": true\n  },\n  \"locale\": \"en-US\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/new/v2.0/projects")

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["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"New Project\",\n  \"color\": \"blue\",\n  \"handoverConfiguration\": {\n    \"setupLiveAgentInbox\": true\n  },\n  \"locale\": \"en-US\"\n}"

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

HTTP Status Codes

Example Request Body

{
    "name": "New Project",
    "color": "blue",
    "handoverConfiguration": {
        "setupLiveAgentInbox": true
    },
    "locale": "en-US"
}

Authorizations