Skip to main content
POST
/
v2.0
/
projects
/
createbytemplate
Create a Project from a Template
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/projects/createbytemplate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "New Project",
  "color": "blue",
  "handoverConfiguration": {
    "setupLiveAgentInbox": true
  },
  "locale": "en-US",
  "templateConfiguration": {
    "endpoints": [
      {
        "channel": "<string>"
      }
    ],
    "skills": [
      "<string>"
    ],
    "template": "<string>"
  }
}
'
{
  "_id": "<string>",
  "status": "queued",
  "type": "trainIntents",
  "parameters": {},
  "lastChangedAt": 1594243850,
  "lastCreatedAt": 1594243850,
  "currentStep": 0,
  "totalStep": 100
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

​
Accept
enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Body

application/json
​
name
string

The name of the Project

Example:

"New Project"

​
color
Available options:
aliceBlue,
antiqueWhite,
aqua,
aquamarine,
azure,
beige,
bisque,
black,
blanchedAlmond,
blue,
blueViolet,
brown,
burlyWood,
cadetBlue,
chartreuse,
chocolate,
coral,
cornflowerBlue,
cornsilk,
crimson,
cyan,
darkBlue,
darkCyan,
darkGoldenRod,
darkGray,
darkGrey,
darkGreen,
darkKhaki,
darkMagenta,
darkOliveGreen,
darkOrange,
darkOrchid,
darkRed,
darkSalmon,
darkSeaGreen,
darkSlateBlue,
darkSlateGray,
darkSlateGrey,
darkTurquoise,
darkViolet,
deepPink,
deepSkyBlue,
dimGray,
dimGrey,
dodgerBlue,
fireBrick,
floralWhite,
forestGreen,
fuchsia,
gainsboro,
ghostWhite,
gold,
goldenRod,
gray,
grey,
green,
greenYellow,
honeyDew,
hotPink,
indianRed,
indigo,
ivory,
khaki,
lavender,
lavenderBlush,
lawnGreen,
lemonChiffon,
lightBlue,
lightCoral,
lightCyan,
lightGoldenRodYellow,
lightGray,
lightGrey,
lightGreen,
lightPink,
lightSalmon,
lightSeaGreen,
lightSkyBlue,
lightSlateGray,
lightSlateGrey,
lightSteelBlue,
lightYellow,
lime,
limeGreen,
linen,
magenta,
maroon,
mediumAquaMarine,
mediumBlue,
mediumOrchid,
mediumPurple,
mediumSeaGreen,
mediumSlateBlue,
mediumSpringGreen,
mediumTurquoise,
mediumVioletRed,
midnightBlue,
mintCream,
mistyRose,
moccasin,
navajoWhite,
navy,
oldLace,
olive,
oliveDrab,
orange,
orangeRed,
orchid,
paleGoldenRod,
paleGreen,
paleTurquoise,
paleVioletRed,
papayaWhip,
peachPuff,
peru,
pink,
plum,
powderBlue,
purple,
rebeccaPurple,
red,
rosyBrown,
royalBlue,
saddleBrown,
salmon,
sandyBrown,
seaGreen,
seaShell,
sienna,
silver,
skyBlue,
slateBlue,
slateGray,
slateGrey,
snow,
springGreen,
steelBlue,
tan,
teal,
thistle,
tomato,
turquoise,
violet,
wheat,
white,
whiteSmoke,
yellow,
yellowGreen,
none,
transparent
Example:

"blue"

​
handoverConfiguration
object
​
locale
enum<string>
Available options:
ge-GE,
da-DK,
en-AU,
en-CA,
en-IN,
en-GB,
en-US,
de-DE,
ja-JP,
ko-KR,
es-ES,
nl-NL,
ar-AE,
fi-FI,
fr-FR,
it-IT,
nn-NO,
pl-PL,
sv-SE,
th-TH,
zh-CN,
vi-VN,
pt-BR,
ru-RU,
pt-PT,
tr-TR,
hi-IN,
bn-IN,
ta-IN
Example:

"en-US"

​
templateConfiguration
object

Response

Successfully created Task to create Project by template

​
_id
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
status
enum<string>

The status of the task

Available options:
queued,
active,
done,
cancelling,
cancelled,
error
Example:

"queued"

​
type
string
Example:

"trainIntents"

​
parameters
object
​
lastChangedAt
number
Example:

1594243850

​
lastCreatedAt
number
Example:

1594243850

​
currentStep
integer
Example:

0

​
totalStep
integer
Example:

100

Last modified on June 12, 2026