Skip to main content
PUT
/
api
/
projects
/
{id}
/
assistants
/
{assistantId}
/
stores
cURL
curl --request PUT \
  --url http://localhost/api/projects/{id}/assistants/{assistantId}/stores \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "ref": "<string>",
    "template": true,
    "orgSlug": "<string>",
    "slug": "<string>",
    "type": "<string>",
    "name": "<string>",
    "description": "<string>",
    "version": "<string>",
    "get_id": "<string>",
    "publicAccess": true,
    "imageUrl": "<string>",
    "icon": "<string>",
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerUrl": "<string>",
    "providerImageUrl": "<string>",
    "deleteProtection": true,
    "checksum": "<string>",
    "deprecated": true,
    "extensionPackRef": "<string>",
    "metadata": {
      "type": "<string>"
    },
    "storeType": "DOCUMENT",
    "highQualityPreview": true,
    "allowDataEditing": true,
    "storePurpose": "OPERATIONAL",
    "viewOptions": {
      "showLastEvent": true,
      "showExtension": true,
      "showCreated": true,
      "showModified": true,
      "showPathCounts": true,
      "showClassifications": true,
      "showSize": true,
      "showAssignments": true,
      "showStatus": true,
      "additionalColumns": [
        {
          "label": "<string>",
          "path": "<string>"
        }
      ],
      "columnStates": {}
    },
    "viewPresets": [
      {
        "id": "<string>",
        "name": "<string>",
        "filterString": "<string>",
        "enabledTaxons": {}
      }
    ]
  }
]'
{
  "uuid": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "updatedOn": "2023-11-07T05:31:56Z",
  "changeSequence": 123,
  "subscription": "<string>",
  "slug": "<string>",
  "schedules": [
    {
      "type": "<string>",
      "cronExpression": "<string>",
      "lastEvent": "2023-11-07T05:31:56Z",
      "nextEvent": "2023-11-07T05:31:56Z",
      "id": "<string>"
    }
  ],
  "project": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "organization": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "name": "<string>",
      "slug": "<string>",
      "publicAccess": true,
      "description": "<string>",
      "organizationStatus": "ACTIVE",
      "hasImage": true,
      "defaultToPrivateTemplates": true,
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "stripeCustomerId": "<string>",
      "enterpriseOrganization": true,
      "id": "<string>"
    },
    "name": "<string>",
    "description": "<string>",
    "owner": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "bio": "<string>",
      "userStorage": {
        "favoriteLinks": [
          {
            "link": "<string>"
          }
        ]
      },
      "showDeveloperTools": true,
      "image": "<string>",
      "userHash": "<string>",
      "acceptedTerms": true,
      "userType": "HUMAN",
      "active": true,
      "fullName": "<string>",
      "externallyManaged": true,
      "hasAcceptedTerms": true,
      "id": "<string>",
      "security": {
        "roles": [
          "PLATFORM_ADMIN"
        ]
      },
      "preferences": {
        "showWelcomeMessage": true,
        "showOnboarding": true,
        "showScrollbars": true
      }
    },
    "status": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "organization": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "name": "<string>",
        "slug": "<string>",
        "publicAccess": true,
        "description": "<string>",
        "organizationStatus": "ACTIVE",
        "hasImage": true,
        "defaultToPrivateTemplates": true,
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "stripeCustomerId": "<string>",
        "enterpriseOrganization": true,
        "id": "<string>"
      },
      "color": "<string>",
      "icon": "<string>",
      "status": "<string>",
      "production": true,
      "id": "<string>"
    },
    "templateArticleId": "<string>",
    "projectTemplateRef": "<string>",
    "notes": "<string>",
    "color": "<string>",
    "tags": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "organization": {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "name": "<string>",
          "slug": "<string>",
          "publicAccess": true,
          "description": "<string>",
          "organizationStatus": "ACTIVE",
          "hasImage": true,
          "defaultToPrivateTemplates": true,
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "stripeCustomerId": "<string>",
          "enterpriseOrganization": true,
          "id": "<string>"
        },
        "name": "<string>",
        "color": "<string>",
        "id": "<string>"
      }
    ],
    "dataFlow": {
      "viewPort": {
        "x": 123,
        "y": 123,
        "zoom": 123
      },
      "nodes": [
        {
          "id": "<string>",
          "parentId": "<string>",
          "type": "<string>",
          "position": {
            "x": 123,
            "y": 123
          },
          "dimensions": {
            "width": 123,
            "height": 123
          },
          "properties": {}
        }
      ],
      "edges": [
        {
          "id": "<string>",
          "source": "<string>",
          "target": "<string>",
          "properties": {}
        }
      ]
    },
    "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": "<any>",
              "value": "<any>",
              "description": "<any>"
            }
          ]
        }
      ],
      "properties": {},
      "groupTaxonTypeFeatures": {},
      "taxonTypeFeatures": {},
      "taskOptions": {
        "showTakeNext": true,
        "showNewTask": true
      }
    },
    "documentStatuses": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "color": "<string>",
        "icon": "<string>",
        "status": "<string>",
        "slug": "<string>",
        "statusType": "UNRESOLVED",
        "id": "<string>"
      }
    ],
    "statusType": "ACTIVE",
    "taskStatuses": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "color": "<string>",
        "icon": "<string>",
        "label": "<string>",
        "slug": "<string>",
        "statusType": "TODO",
        "id": "<string>"
      }
    ],
    "id": "<string>"
  },
  "name": "<string>",
  "description": "<string>",
  "deleted": true,
  "assistantDefinitionRef": "<string>",
  "loggingEnabled": true,
  "deleteLoggingOnSuccess": true,
  "showInTraining": true,
  "chatEnabled": true,
  "assistantRole": "<string>",
  "active": true,
  "runOnExistingContent": true,
  "priorityHint": 123,
  "options": {},
  "color": "<string>",
  "testOptions": {},
  "validationErrors": {
    "instances": [
      {
        "message": "<string>",
        "option": "<string>",
        "description": "<string>"
      }
    ]
  },
  "id": "<string>",
  "definition": {
    "ref": "<string>",
    "template": true,
    "orgSlug": "<string>",
    "slug": "<string>",
    "type": "<string>",
    "name": "<string>",
    "description": "<string>",
    "version": "<string>",
    "get_id": "<string>",
    "publicAccess": true,
    "imageUrl": "<string>",
    "icon": "<string>",
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerUrl": "<string>",
    "providerImageUrl": "<string>",
    "deleteProtection": true,
    "checksum": "<string>",
    "deprecated": true,
    "extensionPackRef": "<string>",
    "schedulable": true,
    "reactive": true,
    "assistant": {
      "package": "<string>",
      "class": "<string>"
    },
    "services": [
      {
        "ref": "<string>",
        "template": true,
        "orgSlug": "<string>",
        "slug": "<string>",
        "type": "<string>",
        "name": "<string>",
        "description": "<string>",
        "version": "<string>",
        "get_id": "<string>",
        "publicAccess": true,
        "imageUrl": "<string>",
        "icon": "<string>",
        "overviewMarkdown": "<string>",
        "provider": "<string>",
        "providerUrl": "<string>",
        "providerImageUrl": "<string>",
        "deleteProtection": true,
        "checksum": "<string>",
        "deprecated": true
      }
    ],
    "processingTaxonomies": [
      {
        "ref": "<string>"
      }
    ],
    "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": "<any>",
            "value": "<any>",
            "description": "<any>"
          }
        ]
      }
    ],
    "optionTabs": [
      {
        "name": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "optionNames": [
          "<string>"
        ],
        "showInTraining": true,
        "showIf": "<string>"
      }
    ],
    "additionalTaxonOptions": [
      {
        "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": "<any>",
            "value": "<any>",
            "description": "<any>"
          }
        ]
      }
    ],
    "taxonFeatures": [
      {
        "taxonPath": "<string>",
        "groupOnly": true,
        "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": "<any>",
                "value": "<any>",
                "description": "<any>"
              }
            ]
          }
        ]
      }
    ],
    "eventTypes": [
      {
        "name": "<string>",
        "icon": "<string>",
        "label": "<string>",
        "description": "<string>",
        "contentObject": true,
        "entryPoints": [
          "<string>"
        ],
        "optionTabs": [
          {
            "name": "<string>",
            "description": "<string>",
            "icon": "<string>",
            "optionNames": [
              "<string>"
            ],
            "showInTraining": true,
            "showIf": "<string>"
          }
        ],
        "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": "<any>",
                "value": "<any>",
                "description": "<any>"
              }
            ]
          }
        ]
      }
    ],
    "defaultSchedules": [
      {
        "type": "<string>",
        "cronExpression": "<string>",
        "lastEvent": "2023-11-07T05:31:56Z",
        "nextEvent": "2023-11-07T05:31:56Z"
      }
    ],
    "subscription": "<string>"
  }
}

Path Parameters

​
id
string
required
​
assistantId
string
required

Body

application/json · object[]
​
orgSlug
string
required

The slug of the organization that owns this metadata object

​
slug
string
required

The slug used when referencing this metadata object

​
type
string
required

The type of metadata object

​
name
string
required

The name of the object

​
version
string
required

The version of the object

​
ref
string

The reference to the metadata object

​
template
boolean

Is this component a template that can be used to create new components

​
description
string

The description of the object

​
get_id
string

An internal identifier (not for public use)

​
publicAccess
boolean

Is the metadata object publicly accessible by other organizations

​
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

​
deleteProtection
boolean

Delete protection status Is the store set with delete protection

​
checksum
string

The checksum of the metadata, calculated by the platform and used to determine if the metadata has changed

​
deprecated
boolean

The resource is marked for deprecation

​
extensionPackRef
string

The reference to the extension pack (if the metadata object was created by an extension pack)

​
metadata
object
​
storeType
enum<string>

The type of object the store will contain

Available options:
DOCUMENT,
TABLE,
DICTIONARY,
MODEL
​
highQualityPreview
boolean

Should we use high-quality or low-quality previews for this store

​
allowDataEditing
boolean

Allowing editing of data in the store

​
storePurpose
enum<string>

The purpose of the store (used by UI and assistants to understand how to interact with the store events)

Available options:
OPERATIONAL,
TRAINING,
TESTING
​
viewOptions
object

Options for viewing this store

​
viewPresets
object[]

View presets that have been saved for this store

Response

OK

​
name
string
required
​
uuid
string

The UUID of the object

​
createdOn
string<date-time>
​
updatedOn
string<date-time>
​
changeSequence
integer

The change sequence of the object, which can be used to track modications

​
subscription
string
​
slug
string
​
schedules
object[]
​
project
object
​
description
string
​
deleted
boolean

Has the assistant been deleted

​
assistantDefinitionRef
string
​
loggingEnabled
boolean
​
deleteLoggingOnSuccess
boolean
​
showInTraining
boolean
​
chatEnabled
boolean
​
assistantRole
string
​
active
boolean
​
runOnExistingContent
boolean
​
priorityHint
integer
​
options
object
​
color
string
​
testOptions
object
​
validationErrors
object
​
id
string

The ID of the object

​
definition
object

The definition of an assistant

⌘I