Skip to main content
GET
/
api
/
projects
/
{id}
/
createProjectTemplateRequest
cURL
curl --request GET \
  --url http://localhost/api/projects/{id}/createProjectTemplateRequest
{
  "name": "<string>",
  "description": "<string>",
  "options": {
    "options": [
      {
        "groupOptions": [
          {}
        ],
        "properties": {},
        "tabName": "<string>",
        "name": "<string>",
        "aliases": [
          "<string>"
        ],
        "label": "<string>",
        "falseLabel": "<string>",
        "hint": "<string>",
        "required": true,
        "type": "<string>",
        "subType": "<string>",
        "listType": "<string>",
        "displayProperties": {},
        "listLabel": "<string>",
        "listDescription": "<string>",
        "featureFlag": "<string>",
        "default": {},
        "description": "<string>",
        "supportArticle": "<string>",
        "overviewMarkdown": "<string>",
        "showIf": "<string>",
        "developerOnly": true,
        "showOnPopup": true,
        "possibleValues": [
          {
            "label": "<string>",
            "value": {},
            "description": "<string>"
          }
        ]
      }
    ],
    "properties": {},
    "groupTaxonTypeFeatures": {},
    "taxonTypeFeatures": {},
    "taskOptions": {
      "showTakeNext": true,
      "showNewTask": true
    }
  },
  "memory": {
    "recentFilters": {},
    "recentQueries": {},
    "orderedDashboards": [
      "<string>"
    ],
    "changeSequence": 123
  },
  "imageUrl": "<string>",
  "icon": "<string>",
  "overviewMarkdown": "<string>",
  "provider": "<string>",
  "providerUrl": "<string>",
  "providerImageUrl": "<string>",
  "publicAccess": true,
  "resources": [
    {
      "uri": "<string>",
      "type": "<string>",
      "name": "<string>",
      "description": "<string>",
      "copy": true,
      "slug": "<string>",
      "originalUri": "<string>"
    }
  ],
  "workspaces": [
    {
      "name": "<string>",
      "slug": "<string>",
      "oldIdentifier": "<string>",
      "description": "<string>",
      "workspaceStorage": {
        "overview": "<string>",
        "currentViewId": "<string>",
        "defaultSidebar": "<string>",
        "properties": {},
        "availablePanels": {}
      }
    }
  ],
  "assistants": [
    {
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "assistantDefinitionRef": "<string>",
      "options": {},
      "stores": [
        "<string>"
      ],
      "schedules": [
        {
          "type": "<string>",
          "cronExpression": "<string>",
          "lastEvent": "2023-11-07T05:31:56Z",
          "nextEvent": "2023-11-07T05:31:56Z"
        }
      ],
      "connections": [
        {
          "sourceType": "STORE",
          "sourceRef": "<string>",
          "targetType": "STORE",
          "targetRef": "<string>",
          "subscription": "<string>",
          "active": true
        }
      ],
      "subscription": "<string>",
      "loggingEnabled": true,
      "showInTraining": true,
      "priorityHint": 123,
      "chatEnabled": true,
      "assistantRole": "<string>"
    }
  ],
  "documentStatuses": [
    {
      "color": "<string>",
      "icon": "<string>",
      "status": "<string>",
      "slug": "<string>",
      "oldIdentifier": "<string>",
      "statusType": "UNRESOLVED"
    }
  ],
  "taskStatuses": [
    {
      "color": "<string>",
      "icon": "<string>",
      "label": "<string>",
      "slug": "<string>",
      "oldIdentifier": "<string>",
      "statusType": "TODO"
    }
  ],
  "taskTemplates": [
    {
      "name": "<string>",
      "description": "<string>",
      "slug": "<string>",
      "oldIdentifier": "<string>",
      "metadata": {
        "options": [
          {
            "groupOptions": [
              {}
            ],
            "properties": {},
            "tabName": "<string>",
            "name": "<string>",
            "aliases": [
              "<string>"
            ],
            "label": "<string>",
            "falseLabel": "<string>",
            "hint": "<string>",
            "required": true,
            "type": "<string>",
            "subType": "<string>",
            "listType": "<string>",
            "displayProperties": {},
            "listLabel": "<string>",
            "listDescription": "<string>",
            "featureFlag": "<string>",
            "default": {},
            "description": "<string>",
            "supportArticle": "<string>",
            "overviewMarkdown": "<string>",
            "showIf": "<string>",
            "developerOnly": true,
            "showOnPopup": true,
            "possibleValues": [
              {
                "label": "<string>",
                "value": {},
                "description": "<string>"
              }
            ]
          }
        ],
        "forms": [
          {
            "dataFormRef": "<string>",
            "actions": [
              {
                "uuid": "<string>",
                "type": "<string>",
                "label": "<string>",
                "properties": {}
              }
            ],
            "availablePanels": {},
            "properties": {}
          }
        ],
        "actions": [
          {
            "uuid": "<string>",
            "type": "<string>",
            "label": "<string>",
            "properties": {}
          }
        ],
        "documentFamilyGroups": [
          {
            "name": "<string>",
            "notes": "<string>",
            "documentFamilyFilter": "<string>",
            "maxHits": 123,
            "sort": "<string>",
            "automaticallyAdd": true,
            "editable": true
          }
        ],
        "workspaceId": "<string>",
        "properties": {},
        "priority": 123
      }
    }
  ],
  "scheduledModels": [
    {
      "name": "<string>",
      "description": "<string>",
      "modelRef": "<string>",
      "properties": {},
      "schedules": [
        {
          "type": "<string>",
          "cronExpression": "<string>",
          "lastEvent": "2023-11-07T05:31:56Z",
          "nextEvent": "2023-11-07T05:31:56Z",
          "id": "<string>"
        }
      ],
      "active": true,
      "deleted": true,
      "oldIdentifier": "<string>"
    }
  ],
  "tags": [
    "<string>"
  ]
}

Path Parameters

id
string
required

Response

OK

name
string
description
string
options
object

Options for the project template

memory
object

A collection of useful memory for the project

imageUrl
string

URL of image when presenting this object in a UI

icon
string

Material Icon name to use in the UI

overviewMarkdown
string

Markdown that is used to present the overview of the object

provider
string

The details of the of provider

providerUrl
string

The link to the provider website

providerImageUrl
string

The link to the model image

publicAccess
boolean
resources
object[]
workspaces
object[]
assistants
object[]
documentStatuses
object[]
taskStatuses
object[]
taskTemplates
object[]
scheduledModels
object[]
tags
string[]
I