Skip to main content
PUT
/
api
/
assistants
/
{id}
Update Assistant
curl --request PUT \
  --url https://platform.kodexa.ai/api/assistants/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "active": true,
  "assistantDefinitionId": "<string>",
  "assistantRole": "<string>",
  "changeSequence": 123,
  "chatEnabled": true,
  "color": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteLoggingOnSuccess": true,
  "deleted": true,
  "description": "<string>",
  "id": "e4567890-12ab-cdef-3456-789012abcdef",
  "loggingEnabled": true,
  "name": "Invoice Extractor",
  "options": {},
  "priorityHint": 123,
  "project": {
    "changeSequence": 123,
    "color": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "dataFlow": {
      "edges": [
        {
          "id": "e4567890-12ab-cdef-3456-789012abcdef",
          "properties": {},
          "source": "<string>",
          "target": "<string>"
        }
      ],
      "nodes": [
        {
          "dimensions": {
            "height": 123,
            "width": 123
          },
          "id": "e4567890-12ab-cdef-3456-789012abcdef",
          "parentId": "<string>",
          "position": {
            "x": 123,
            "y": 123
          },
          "properties": {},
          "type": "<string>"
        }
      ],
      "viewPort": {
        "x": 123,
        "y": 123,
        "zoom": 123
      }
    },
    "description": "<string>",
    "id": "e4567890-12ab-cdef-3456-789012abcdef",
    "memory": {
      "changeSequence": 123,
      "orderedDashboards": [
        "<string>"
      ],
      "recentFilters": {},
      "recentQueries": {}
    },
    "name": "Invoice Extractor",
    "notes": "<string>",
    "options": {
      "dataOptions": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "groupOptions": [
            {}
          ],
          "hint": "<string>",
          "label": "<string>",
          "listDescription": "<string>",
          "listLabel": "<string>",
          "listType": "<string>",
          "name": "Invoice Extractor",
          "overviewMarkdown": "<string>",
          "possibleValues": [
            {
              "description": "<string>",
              "label": "<string>",
              "value": {}
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "dataProperties": {},
      "groupTaxonTypeFeatures": {},
      "options": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "groupOptions": [
            {}
          ],
          "hint": "<string>",
          "label": "<string>",
          "listDescription": "<string>",
          "listLabel": "<string>",
          "listType": "<string>",
          "name": "Invoice Extractor",
          "overviewMarkdown": "<string>",
          "possibleValues": [
            {
              "description": "<string>",
              "label": "<string>",
              "value": {}
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "properties": {},
      "taskOptions": {
        "showNewTask": true,
        "showTakeNext": true
      },
      "taxonTypeFeatures": {}
    },
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "<string>",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "e4567890-12ab-cdef-3456-789012abcdef",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "Invoice Extractor",
      "organizationStatus": "<string>",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "invoice-extractor",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "organizationId": "<string>",
    "owner": {
      "active": true,
      "bio": "<string>",
      "businessGroup": "<string>",
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "firstName": "<string>",
      "groupsJson": "<string>",
      "id": "e4567890-12ab-cdef-3456-789012abcdef",
      "image": "<string>",
      "isExternallyManaged": true,
      "lastName": "<string>",
      "preferences": {
        "showOnboarding": true,
        "showScrollbars": true,
        "showWelcomeMessage": true
      },
      "roles": {
        "roles": [
          "<string>"
        ]
      },
      "rolesJson": "<string>",
      "searchText": "<string>",
      "showDeveloperTools": true,
      "title": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "userStorage": {
        "favoriteLinks": [
          {
            "link": "<string>"
          }
        ]
      },
      "userType": "<string>",
      "uuid": "<string>"
    },
    "ownerId": "<string>",
    "projectTemplateRef": "<string>",
    "searchText": "<string>",
    "slug": "invoice-extractor",
    "status": {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "icon": "<string>",
      "id": "e4567890-12ab-cdef-3456-789012abcdef",
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "<string>",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "e4567890-12ab-cdef-3456-789012abcdef",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "Invoice Extractor",
        "organizationStatus": "<string>",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "invoice-extractor",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "organizationId": "<string>",
      "production": true,
      "status": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "statusId": "<string>",
    "statusType": "<string>",
    "templateArticleId": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "projectId": "<string>",
  "runOnExistingContent": true,
  "showInTraining": true,
  "slug": "invoice-extractor",
  "subscription": "<string>",
  "testOptions": {},
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "validationErrors": {
    "instances": [
      {
        "description": "<string>",
        "message": "<string>",
        "option": "<string>"
      }
    ]
  }
}
'
{
  "active": true,
  "assistantDefinitionId": "<string>",
  "assistantRole": "<string>",
  "changeSequence": 123,
  "chatEnabled": true,
  "color": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteLoggingOnSuccess": true,
  "deleted": true,
  "description": "<string>",
  "id": "e4567890-12ab-cdef-3456-789012abcdef",
  "loggingEnabled": true,
  "name": "Invoice Extractor",
  "options": {},
  "priorityHint": 123,
  "project": {
    "changeSequence": 123,
    "color": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "dataFlow": {
      "edges": [
        {
          "id": "e4567890-12ab-cdef-3456-789012abcdef",
          "properties": {},
          "source": "<string>",
          "target": "<string>"
        }
      ],
      "nodes": [
        {
          "dimensions": {
            "height": 123,
            "width": 123
          },
          "id": "e4567890-12ab-cdef-3456-789012abcdef",
          "parentId": "<string>",
          "position": {
            "x": 123,
            "y": 123
          },
          "properties": {},
          "type": "<string>"
        }
      ],
      "viewPort": {
        "x": 123,
        "y": 123,
        "zoom": 123
      }
    },
    "description": "<string>",
    "id": "e4567890-12ab-cdef-3456-789012abcdef",
    "memory": {
      "changeSequence": 123,
      "orderedDashboards": [
        "<string>"
      ],
      "recentFilters": {},
      "recentQueries": {}
    },
    "name": "Invoice Extractor",
    "notes": "<string>",
    "options": {
      "dataOptions": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "groupOptions": [
            {}
          ],
          "hint": "<string>",
          "label": "<string>",
          "listDescription": "<string>",
          "listLabel": "<string>",
          "listType": "<string>",
          "name": "Invoice Extractor",
          "overviewMarkdown": "<string>",
          "possibleValues": [
            {
              "description": "<string>",
              "label": "<string>",
              "value": {}
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "dataProperties": {},
      "groupTaxonTypeFeatures": {},
      "options": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "groupOptions": [
            {}
          ],
          "hint": "<string>",
          "label": "<string>",
          "listDescription": "<string>",
          "listLabel": "<string>",
          "listType": "<string>",
          "name": "Invoice Extractor",
          "overviewMarkdown": "<string>",
          "possibleValues": [
            {
              "description": "<string>",
              "label": "<string>",
              "value": {}
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "properties": {},
      "taskOptions": {
        "showNewTask": true,
        "showTakeNext": true
      },
      "taxonTypeFeatures": {}
    },
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "<string>",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "e4567890-12ab-cdef-3456-789012abcdef",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "Invoice Extractor",
      "organizationStatus": "<string>",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "invoice-extractor",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "organizationId": "<string>",
    "owner": {
      "active": true,
      "bio": "<string>",
      "businessGroup": "<string>",
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "firstName": "<string>",
      "groupsJson": "<string>",
      "id": "e4567890-12ab-cdef-3456-789012abcdef",
      "image": "<string>",
      "isExternallyManaged": true,
      "lastName": "<string>",
      "preferences": {
        "showOnboarding": true,
        "showScrollbars": true,
        "showWelcomeMessage": true
      },
      "roles": {
        "roles": [
          "<string>"
        ]
      },
      "rolesJson": "<string>",
      "searchText": "<string>",
      "showDeveloperTools": true,
      "title": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "userStorage": {
        "favoriteLinks": [
          {
            "link": "<string>"
          }
        ]
      },
      "userType": "<string>",
      "uuid": "<string>"
    },
    "ownerId": "<string>",
    "projectTemplateRef": "<string>",
    "searchText": "<string>",
    "slug": "invoice-extractor",
    "status": {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "icon": "<string>",
      "id": "e4567890-12ab-cdef-3456-789012abcdef",
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "<string>",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "e4567890-12ab-cdef-3456-789012abcdef",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "Invoice Extractor",
        "organizationStatus": "<string>",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "invoice-extractor",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "organizationId": "<string>",
      "production": true,
      "status": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "statusId": "<string>",
    "statusType": "<string>",
    "templateArticleId": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "projectId": "<string>",
  "runOnExistingContent": true,
  "showInTraining": true,
  "slug": "invoice-extractor",
  "subscription": "<string>",
  "testOptions": {},
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "validationErrors": {
    "instances": [
      {
        "description": "<string>",
        "message": "<string>",
        "option": "<string>"
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json

An assistant is an AI-powered processor that analyzes and extracts data from documents within a project.

​
active
boolean
​
assistantDefinitionId
string | null
​
assistantRole
string
​
changeSequence
integer<int32>

Optimistic locking version number.

​
chatEnabled
boolean
​
color
string
​
createdOn
string<date-time>

Timestamp when the assistant was created.

​
deleteLoggingOnSuccess
boolean
​
deleted
boolean
​
description
string
​
id
string

Unique identifier (UUID) for the assistant.

Example:

"e4567890-12ab-cdef-3456-789012abcdef"

​
loggingEnabled
boolean
​
name
string

Display name of the assistant.

Example:

"Invoice Extractor"

​
options
object
​
priorityHint
integer<int32> | null
​
project
object
​
projectId
string | null
​
runOnExistingContent
boolean
​
showInTraining
boolean
​
slug
string

URL-friendly identifier for the assistant.

Example:

"invoice-extractor"

​
subscription
string
​
testOptions
object
​
updatedOn
string<date-time>

Timestamp when the assistant was last updated.

​
uuid
string

Secondary UUID identifier.

​
validationErrors
object

Response

Updated Assistant

An assistant is an AI-powered processor that analyzes and extracts data from documents within a project.

​
active
boolean
​
assistantDefinitionId
string | null
​
assistantRole
string
​
changeSequence
integer<int32>

Optimistic locking version number.

​
chatEnabled
boolean
​
color
string
​
createdOn
string<date-time>

Timestamp when the assistant was created.

​
deleteLoggingOnSuccess
boolean
​
deleted
boolean
​
description
string
​
id
string

Unique identifier (UUID) for the assistant.

Example:

"e4567890-12ab-cdef-3456-789012abcdef"

​
loggingEnabled
boolean
​
name
string

Display name of the assistant.

Example:

"Invoice Extractor"

​
options
object
​
priorityHint
integer<int32> | null
​
project
object
​
projectId
string | null
​
runOnExistingContent
boolean
​
showInTraining
boolean
​
slug
string

URL-friendly identifier for the assistant.

Example:

"invoice-extractor"

​
subscription
string
​
testOptions
object
​
updatedOn
string<date-time>

Timestamp when the assistant was last updated.

​
uuid
string

Secondary UUID identifier.

​
validationErrors
object