Skip to main content
POST
/
api
/
projects
/
{id}
/
assistants
/
{assistantId}
/
events
cURL
curl --request POST \
  --url http://localhost/api/projects/{id}/assistants/{assistantId}/events \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "uuid": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "updatedOn": "2023-11-07T05:31:56Z",
  "changeSequence": 123,
  "assistantId": "<string>",
  "description": "<string>",
  "priority": 123,
  "targets": {
    "instances": [
      {
        "type": "DOCUMENT_STORE",
        "ref": "<string>",
        "documentFamilyId": "<string>",
        "contentObjectId": "<string>",
        "actor": {
          "actorId": "<string>",
          "actorType": "USER"
        },
        "taxonomyRefs": [
          "<string>"
        ],
        "labelsToApply": [
          "<string>"
        ]
      }
    ]
  },
  "session": {
    "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>"
    },
    "state": "OPEN",
    "token": "<string>",
    "id": "<string>"
  },
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "processingTime": 123,
  "loggingEnabled": true,
  "deleteLoggingOnSuccess": true,
  "status": "PENDING",
  "exceptionDetails": {
    "message": "<string>",
    "statusCode": 123,
    "errorMessage": "<string>",
    "errorType": "<string>",
    "executedVersion": "<string>",
    "advice": "<string>",
    "description": "<string>",
    "cause": {},
    "documentationUrl": "<string>",
    "stackTrace": [
      {}
    ],
    "help": "<string>",
    "optionErrors": {},
    "validationErrors": [
      {
        "message": "<string>",
        "option": "<string>",
        "description": "<string>"
      }
    ]
  },
  "statusDetails": {
    "message": "<string>",
    "detail": "<string>",
    "progressMax": 123,
    "progress": 123,
    "stepStatus": {
      "stepId": "<string>",
      "status": "PENDING",
      "statusMessage": "<string>",
      "progressMax": 123,
      "progress": 123
    }
  },
  "pipeline": {
    "valid": true,
    "ref": "<string>",
    "id": "<string>",
    "exceptions": [
      {
        "message": "<string>",
        "statusCode": 123,
        "errorMessage": "<string>",
        "errorType": "<string>",
        "executedVersion": "<string>",
        "advice": "<string>",
        "description": "<string>",
        "cause": {},
        "documentationUrl": "<string>",
        "stackTrace": [
          {}
        ],
        "help": "<string>",
        "optionErrors": {},
        "validationErrors": [
          {
            "message": "<string>",
            "option": "<string>",
            "description": "<string>"
          }
        ]
      }
    ],
    "steps": [
      {
        "id": "<string>",
        "status": "PENDING",
        "exceptionDetails": {
          "message": "<string>",
          "statusCode": 123,
          "errorMessage": "<string>",
          "errorType": "<string>",
          "executedVersion": "<string>",
          "advice": "<string>",
          "description": "<string>",
          "cause": {},
          "documentationUrl": "<string>",
          "stackTrace": [
            {}
          ],
          "help": "<string>",
          "optionErrors": {},
          "validationErrors": [
            {
              "message": "<string>",
              "option": "<string>",
              "description": "<string>"
            }
          ]
        },
        "name": "<string>",
        "statusMessage": "<string>",
        "progressMax": 123,
        "progress": 123,
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z",
        "processingTime": 123,
        "options": {},
        "optionTypes": {},
        "context": {},
        "conditional": "<string>",
        "contentObjects": [
          {
            "uuid": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "changeSequence": 123,
            "contentType": "DOCUMENT",
            "documentVersion": "<string>",
            "index": 123,
            "metadata": {},
            "mixins": [
              "<string>"
            ],
            "created": "2023-11-07T05:31:56Z",
            "modified": "2023-11-07T05:31:56Z",
            "size": 123,
            "storeRef": "<string>",
            "documentTaxonValidations": [
              {
                "taxonomyRef": "<string>",
                "taxonPath": "<string>",
                "validation": {
                  "name": "<string>",
                  "disabled": true,
                  "description": "<string>",
                  "conditional": true,
                  "conditionalFormula": "<string>",
                  "ruleFormula": "<string>",
                  "messageFormula": "<string>",
                  "detailFormula": "<string>",
                  "exceptionId": "<string>",
                  "supportArticleId": "<string>",
                  "overridable": true
                }
              }
            ],
            "documentFamilyId": "<string>",
            "id": "<string>"
          }
        ],
        "inputId": "<string>",
        "outputId": "<string>",
        "outputIds": "<string>",
        "ref": "<string>",
        "extensionPackRef": "<string>",
        "stepType": "ACTION"
      }
    ]
  },
  "parameters": {},
  "customOptions": {},
  "context": {},
  "childExecutions": [
    {}
  ],
  "contentObjects": [
    {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "contentType": "DOCUMENT",
      "documentVersion": "<string>",
      "index": 123,
      "metadata": {},
      "mixins": [
        "<string>"
      ],
      "created": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z",
      "size": 123,
      "storeRef": "<string>",
      "documentTaxonValidations": [
        {
          "taxonomyRef": "<string>",
          "taxonPath": "<string>",
          "validation": {
            "name": "<string>",
            "disabled": true,
            "description": "<string>",
            "conditional": true,
            "conditionalFormula": "<string>",
            "ruleFormula": "<string>",
            "messageFormula": "<string>",
            "detailFormula": "<string>",
            "exceptionId": "<string>",
            "supportArticleId": "<string>",
            "overridable": true
          }
        }
      ],
      "documentFamilyId": "<string>",
      "id": "<string>"
    }
  ],
  "documentFamily": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "documentStatus": {
      "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>"
    },
    "deleted": true,
    "assignment": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "user": {
        "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": {},
        "showDeveloperTools": true,
        "image": "<string>",
        "userHash": "<string>",
        "acceptedTerms": true,
        "userType": "HUMAN",
        "active": true,
        "fullName": "<string>",
        "externallyManaged": true,
        "hasAcceptedTerms": true,
        "id": "<string>",
        "security": {},
        "preferences": {}
      },
      "assignedAt": "2023-11-07T05:31:56Z",
      "releaseAt": "2023-11-07T05:31:56Z",
      "id": "<string>"
    },
    "storeRef": "<string>",
    "path": "<string>",
    "locked": true,
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "size": 123,
    "numberOfNotes": 123,
    "numberOfInsights": 123,
    "numberOfContentExceptions": 123,
    "contentObjects": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "contentType": "DOCUMENT",
        "documentVersion": "<string>",
        "index": 123,
        "metadata": {},
        "mixins": [
          "<string>"
        ],
        "created": "2023-11-07T05:31:56Z",
        "modified": "2023-11-07T05:31:56Z",
        "size": 123,
        "storeRef": "<string>",
        "documentTaxonValidations": [
          {
            "taxonomyRef": "<string>",
            "taxonPath": "<string>",
            "validation": {
              "name": "<string>",
              "disabled": true,
              "description": "<string>",
              "conditional": true,
              "conditionalFormula": "<string>",
              "ruleFormula": "<string>",
              "messageFormula": "<string>",
              "detailFormula": "<string>",
              "exceptionId": "<string>",
              "supportArticleId": "<string>",
              "overridable": true
            }
          }
        ],
        "documentFamilyId": "<string>",
        "id": "<string>"
      }
    ],
    "contentExceptions": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "tag": "<string>",
        "message": "<string>",
        "exceptionType": "<string>",
        "severity": "<string>",
        "exceptionDetails": "<string>",
        "groupUuid": "<string>",
        "tagUuid": "<string>",
        "id": "<string>"
      }
    ],
    "transitions": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "transitionType": "DERIVED",
        "index": 123,
        "dateTime": "2023-11-07T05:31:56Z",
        "actor": {
          "actorId": "<string>",
          "actorType": "USER"
        },
        "label": "<string>",
        "sourceContentObjectId": "<string>",
        "destinationContentObjectId": "<string>",
        "ignoredValues": {},
        "id": "<string>"
      }
    ],
    "taxonomies": [
      {
        "template": true,
        "deprecated": true,
        "ref": "<string>",
        "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>"
        },
        "slug": "<string>",
        "extensionPackRef": "<string>",
        "id": "<string>",
        "uuid": "<string>",
        "version": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "publicAccess": true,
        "projects": [
          {
            "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": {},
              "showDeveloperTools": true,
              "image": "<string>",
              "userHash": "<string>",
              "acceptedTerms": true,
              "userType": "HUMAN",
              "active": true,
              "fullName": "<string>",
              "externallyManaged": true,
              "hasAcceptedTerms": true,
              "id": "<string>",
              "security": {},
              "preferences": {}
            },
            "status": {
              "uuid": "<string>",
              "createdOn": "2023-11-07T05:31:56Z",
              "updatedOn": "2023-11-07T05:31:56Z",
              "changeSequence": 123,
              "organization": {},
              "color": "<string>",
              "icon": "<string>",
              "status": "<string>",
              "production": true,
              "id": "<string>"
            },
            "templateArticleId": "<string>",
            "projectTemplateRef": "<string>",
            "notes": "<string>",
            "color": "<string>",
            "tags": [
              {}
            ],
            "dataFlow": {
              "viewPort": {},
              "nodes": [
                "<any>"
              ],
              "edges": [
                "<any>"
              ]
            },
            "options": {
              "options": [
                "<any>"
              ],
              "properties": {},
              "groupTaxonTypeFeatures": {},
              "taxonTypeFeatures": {},
              "taskOptions": {}
            },
            "documentStatuses": [
              {}
            ],
            "statusType": "ACTIVE",
            "taskStatuses": [
              {}
            ],
            "id": "<string>"
          }
        ],
        "metadata": {
          "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>",
          "taxonomyType": "CONTENT",
          "enabled": true,
          "externalDataTaxonomyRefs": [
            "<string>"
          ],
          "taxons": [
            {
              "id": "<string>",
              "label": "<string>",
              "order": 123,
              "generateName": true,
              "group": true,
              "name": "<string>",
              "selectWeight": 123,
              "externalName": "<string>",
              "valuePath": "VALUE_OR_ALL_CONTENT",
              "metadataValue": "FILENAME",
              "dataPath": "<string>",
              "expression": "<string>",
              "enableFallbackExpression": true,
              "fallbackExpression": "<string>",
              "enableSerializationExpression": true,
              "serializationExpression": "<string>",
              "nullable": true,
              "nullValue": "<string>",
              "denormalizeToChildren": true,
              "notUserLabelled": true,
              "description": "<string>",
              "overviewMarkdown": "<string>",
              "semanticDefinition": "<string>",
              "synonyms": [
                "<string>"
              ],
              "lexicalRelations": [
                {
                  "type": "SYNONYM",
                  "value": "<string>",
                  "weight": 123
                }
              ],
              "additionContexts": [
                {
                  "type": "RECORD_DEFINITION",
                  "context": "<string>",
                  "weight": 123,
                  "negative": true
                }
              ],
              "guideProperties": {
                "guidanceKey": true,
                "guidanceKeyExpression": "<string>",
                "useGuidanceForClassification": true,
                "ifPresentRequired": true
              },
              "enabled": true,
              "color": "<string>",
              "children": [
                {}
              ],
              "options": [
                {
                  "groupOptions": [
                    "<any>"
                  ],
                  "properties": {},
                  "tabName": "<string>",
                  "name": "<string>",
                  "aliases": [
                    "<any>"
                  ],
                  "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": [
                    "<any>"
                  ]
                }
              ],
              "nodeTypes": [
                "<string>"
              ],
              "taxonType": "STRING",
              "selectionOptions": [
                {
                  "label": "<string>",
                  "id": "<string>",
                  "description": "<string>",
                  "isConditional": true,
                  "conditionalFormula": "<string>",
                  "lexicalRelations": [
                    {}
                  ]
                }
              ],
              "typeFeatures": {},
              "properties": {},
              "conditionalFormats": [
                {
                  "type": "<string>",
                  "condition": "<string>",
                  "properties": {}
                }
              ],
              "validationRules": [
                {
                  "name": "<string>",
                  "disabled": true,
                  "description": "<string>",
                  "conditional": true,
                  "conditionalFormula": "<string>",
                  "ruleFormula": "<string>",
                  "messageFormula": "<string>",
                  "detailFormula": "<string>",
                  "exceptionId": "<string>",
                  "supportArticleId": "<string>",
                  "overridable": true
                }
              ],
              "cardinality": "ONCE_PER_DOCUMENT",
              "path": "<string>",
              "multiValue": true,
              "userEditable": true,
              "usePostExpression": true,
              "postExpression": "<string>"
            }
          ],
          "totalTaxons": 123
        }
      }
    ],
    "labels": [
      {
        "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>",
        "label": "<string>",
        "id": "<string>"
      }
    ],
    "activeAssistant": {
      "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": {},
          "showDeveloperTools": true,
          "image": "<string>",
          "userHash": "<string>",
          "acceptedTerms": true,
          "userType": "HUMAN",
          "active": true,
          "fullName": "<string>",
          "externallyManaged": true,
          "hasAcceptedTerms": true,
          "id": "<string>",
          "security": {},
          "preferences": {}
        },
        "status": {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "organization": {},
          "color": "<string>",
          "icon": "<string>",
          "status": "<string>",
          "production": true,
          "id": "<string>"
        },
        "templateArticleId": "<string>",
        "projectTemplateRef": "<string>",
        "notes": "<string>",
        "color": "<string>",
        "tags": [
          {}
        ],
        "dataFlow": {
          "viewPort": {},
          "nodes": [
            "<any>"
          ],
          "edges": [
            "<any>"
          ]
        },
        "options": {
          "options": [
            "<any>"
          ],
          "properties": {},
          "groupTaxonTypeFeatures": {},
          "taxonTypeFeatures": {},
          "taskOptions": {}
        },
        "documentStatuses": [
          {}
        ],
        "statusType": "ACTIVE",
        "taskStatuses": [
          {}
        ],
        "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": [
          {}
        ]
      },
      "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": [
          {}
        ],
        "processingTaxonomies": [
          {}
        ],
        "options": [
          {}
        ],
        "optionTabs": [
          {}
        ],
        "additionalTaxonOptions": [
          {}
        ],
        "taxonFeatures": [
          {}
        ],
        "eventTypes": [
          {}
        ],
        "defaultSchedules": [
          {}
        ],
        "subscription": "<string>"
      }
    },
    "mixins": [
      "<string>"
    ],
    "metadata": {},
    "guidance": true,
    "labelStatistics": {
      "labelCounts": {},
      "averageLabelConfidence": {},
      "maxLabelConfidence": {},
      "minLabelConfidence": {}
    },
    "metadataSource": {},
    "statistics": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "pathCounts": [
        {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "taxonomyId": "<string>",
          "path": "<string>",
          "label": "<string>",
          "count": 123,
          "exceptionCount": 123,
          "id": "<string>"
        }
      ],
      "recentExecutions": [
        {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "assistant": {
            "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": {},
                "showDeveloperTools": true,
                "image": "<string>",
                "userHash": "<string>",
                "acceptedTerms": true,
                "userType": "HUMAN",
                "active": true,
                "fullName": "<string>",
                "externallyManaged": true,
                "hasAcceptedTerms": true,
                "id": "<string>",
                "security": {},
                "preferences": {}
              },
              "status": {
                "uuid": "<string>",
                "createdOn": "2023-11-07T05:31:56Z",
                "updatedOn": "2023-11-07T05:31:56Z",
                "changeSequence": 123,
                "organization": {},
                "color": "<string>",
                "icon": "<string>",
                "status": "<string>",
                "production": true,
                "id": "<string>"
              },
              "templateArticleId": "<string>",
              "projectTemplateRef": "<string>",
              "notes": "<string>",
              "color": "<string>",
              "tags": [
                {}
              ],
              "dataFlow": {
                "viewPort": {},
                "nodes": [
                  "<any>"
                ],
                "edges": [
                  "<any>"
                ]
              },
              "options": {
                "options": [
                  "<any>"
                ],
                "properties": {},
                "groupTaxonTypeFeatures": {},
                "taxonTypeFeatures": {},
                "taskOptions": {}
              },
              "documentStatuses": [
                {}
              ],
              "statusType": "ACTIVE",
              "taskStatuses": [
                {}
              ],
              "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": [
                {}
              ]
            },
            "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": [
                {}
              ],
              "processingTaxonomies": [
                {}
              ],
              "options": [
                {}
              ],
              "optionTabs": [
                {}
              ],
              "additionalTaxonOptions": [
                {}
              ],
              "taxonFeatures": [
                {}
              ],
              "eventTypes": [
                {}
              ],
              "defaultSchedules": [
                {}
              ],
              "subscription": "<string>"
            }
          },
          "execution": {},
          "id": "<string>"
        }
      ],
      "id": "<string>"
    },
    "executionTargets": {
      "instances": [
        {
          "type": "DOCUMENT_STORE",
          "ref": "<string>",
          "documentFamilyId": "<string>",
          "contentObjectId": "<string>",
          "actor": {
            "actorId": "<string>",
            "actorType": "USER"
          },
          "taxonomyRefs": [
            "<string>"
          ],
          "labelsToApply": [
            "<string>"
          ]
        }
      ]
    },
    "summary": "<string>",
    "documentTaxonValidations": [
      {
        "taxonomyRef": "<string>",
        "taxonPath": "<string>",
        "validation": {
          "name": "<string>",
          "disabled": true,
          "description": "<string>",
          "conditional": true,
          "conditionalFormula": "<string>",
          "ruleFormula": "<string>",
          "messageFormula": "<string>",
          "detailFormula": "<string>",
          "exceptionId": "<string>",
          "supportArticleId": "<string>",
          "overridable": true
        }
      }
    ],
    "features": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "featureType": {
          "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>",
          "slug": "<string>",
          "description": "<string>",
          "color": "<string>",
          "icon": "<string>",
          "active": true,
          "labelJsonPath": "<string>",
          "options": [
            {
              "groupOptions": [
                "<any>"
              ],
              "properties": {},
              "tabName": "<string>",
              "name": "<string>",
              "aliases": [
                "<any>"
              ],
              "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": [
                "<any>"
              ]
            }
          ],
          "id": "<string>"
        },
        "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>"
        },
        "properties": {},
        "active": true,
        "id": "<string>"
      }
    ],
    "id": "<string>"
  },
  "id": "<string>"
}

Path Parameters

​
id
string
required
​
assistantId
string
required

Query Parameters

​
eventType
string
​
options
string
​
contentObjectId
string
​
documentFamilyRef
string

Body

application/json
​
document
file

Response

OK

​
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

​
assistantId
string
​
description
string
​
priority
integer
​
targets
object

This is a list of the targets from executions for the document family, this is used when we want to understand where data from this document can go

​
session
object
​
startDate
string<date-time>
​
endDate
string<date-time>
​
processingTime
integer
​
loggingEnabled
boolean
​
deleteLoggingOnSuccess
boolean
​
status
enum<string>
Available options:
PENDING,
RUNNING,
SUCCEEDED,
FAILED,
REQUESTED,
SKIPPED,
CANCELLING,
CANCELLED,
PENDING_REPROCESSING,
REPROCESSED
​
exceptionDetails
object
​
statusDetails
object
​
pipeline
object
​
parameters
object
deprecated
​
customOptions
object
deprecated
​
context
object
​
childExecutions
object[]
​
contentObjects
object[]
​
documentFamily
object

A document family is the representation of a single piece of external content (ie. a PDF) and all the related document representations of that file

​
id
string

The ID of the object

⌘I