Skip to main content
GET
/
api
/
projects
/
{id}
/
assistants
cURL
curl --request GET \
  --url http://localhost/api/projects/{id}/assistants
[
  {
    "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": [
              {}
            ]
          }
        ],
        "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": [
            {}
          ]
        }
      ],
      "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": [
            {}
          ]
        }
      ],
      "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": [
                {}
              ]
            }
          ]
        }
      ],
      "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": [
                {}
              ]
            }
          ]
        }
      ],
      "defaultSchedules": [
        {
          "type": "<string>",
          "cronExpression": "<string>",
          "lastEvent": "2023-11-07T05:31:56Z",
          "nextEvent": "2023-11-07T05:31:56Z"
        }
      ],
      "subscription": "<string>"
    }
  }
]

Path Parameters

id
string
required

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