---
title: "Create a Project from a Template"
method: POST
path: "/v2.0/projects/createbytemplate"
tags: ["Projects"]
---

# Create a Project from a Template

`POST /v2.0/projects/createbytemplate`

Creates a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#projects) from a template.

## Headers

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

## Request body

- object
  - `name` string — The name of the Project
  - `color` union
    - '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'
    - 'amber' | 'blueGrey' | 'cognigyBlue' | 'cognigyGrey' | 'deepOrange' | 'deepPurple' | 'lightBlue' | 'lightGreen'
  - `handoverConfiguration` object
    - `setupLiveAgentInbox` boolean
    - `whisperAssistConfiguration` 'none' | 'basic' | 'template'
  - `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.
  - `templateConfiguration` object
    - `endpoints` object[]
      - `channel` string
    - `skills` string[]
    - `template` string

## Response `202`

Task to create the Project successfully created.

- object
  - `_id` string
  - `status` 'queued' | 'active' | 'done' | 'cancelling' | 'cancelled' | 'error' — The status of the task
  - `type` string
  - `parameters` object
  - `lastChangedAt` number
  - `lastCreatedAt` number
  - `currentStep` integer
  - `totalStep` integer

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)
- `401` — The request has not been applied because it lacks valid authentication credentials for the target resource.
- `402` — Upgrade your Plan to increase your Quota.
- `403` — The server understood the request but refuses to authorize it.
- `404` — The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
- `405` — The method received in the request-line is known by the origin server but not supported by the target resource.
- `409` — The request conflicts with current state of the server.
- `413` — The request entity is larger than limits defined by server.
- `500` — The server encountered an unexpected condition that prevented it from fulfilling the request.
- `501` — The server does not support the functionality required to fulfill the request.
- `502` — The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
- `503` — The server is not ready to handle the request.
- `504` — The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.

---

[API](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference.md) · [All operations](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cognigy/simulator-openapi-rest-ful-api-reference/versions/85b2872bdfb7/schema)