Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Projects

Create a Project from a Template

Creates a Project from a template.

post/v2.0/projects/createbytemplate

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

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.

Request body

namestring

The name of the Project

locale'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'

A supported BCP 47 language tag for NLU.

Example request

{
  "name": "New Project",
  "color": "none",
  "locale": "en-US"
}

Response

Task to create the Project successfully created.

_idstring
status'queued' | 'active' | 'done' | 'cancelling' | 'cancelled' | 'error'

The status of the task

typestring
parametersobject
lastChangedAtnumber
lastCreatedAtnumber
currentStepinteger
totalStepinteger

Example response

{
  "status": "queued",
  "type": "trainIntents",
  "lastChangedAt": 1594243850,
  "lastCreatedAt": 1594243850,
  "totalStep": 100
}