curl --request GET \
--url https://platform.kodexa.ai/api/assistants \
--header 'x-api-key: <api-key>'{
"content": [
{
"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>"
}
]
}
}
],
"first": true,
"last": true,
"number": 123,
"numberOfElements": 123,
"pageable": {
"offset": 123,
"pageNumber": 123,
"pageSize": 123,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 123,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 123,
"totalPages": 123
}Returns a paginated list of Assistants. Assistants are AI-powered processors that analyze and extract data from documents.
curl --request GET \
--url https://platform.kodexa.ai/api/assistants \
--header 'x-api-key: <api-key>'{
"content": [
{
"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>"
}
]
}
}
],
"first": true,
"last": true,
"number": 123,
"numberOfElements": 123,
"pageable": {
"offset": 123,
"pageNumber": 123,
"pageSize": 123,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 123,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 123,
"totalPages": 123
}API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Page number (1-indexed). Defaults to 1.
Number of items per page (1-1000). Defaults to 20, maximum 1000.
Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.
RSQL/FIQL filter expression. Supported operators: == (equals), != (not equals), =like= (contains), =in= (in list), > / >= / < / <= (comparison), =isnull=true (is null), =isnull=false (is not null). Combine with ; (AND) or , (OR). Example: name=='Acme Corp';status==active
Full-text search query matching against the entity's searchable fields.
Page of Assistant
Paginated response containing Assistant items.
Array of Assistant items on this page.
Show child attributes
Whether this is the first page.
Whether this is the last page.
Current page number (0-indexed).
Number of items on the current page.
Pagination metadata.
Show child attributes
Page size (number of items per page).
Sort metadata.
Show child attributes
Total number of items across all pages.
Total number of pages.