curl --request GET \
--url https://platform.kodexa.ai/api/modules \
--header 'x-api-key: <api-key>'{
"content": [
{
"changeSequence": 123,
"createdBy": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"description": "<string>",
"entryPoint": "<string>",
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"additionalTaxonOptions": {},
"baseDir": "<string>",
"contents": [
"<string>"
],
"eventAware": true,
"ignoredContents": [
"<string>"
],
"inferable": true,
"inferenceOptions": {},
"messageTemplates": {},
"modelRuntimeParameters": {},
"modelRuntimeRef": "<string>",
"moduleSidecars": [
"<string>"
],
"optionTabs": {},
"script": "<string>",
"scriptLanguage": "<string>",
"state": "<string>",
"stateHash": "<string>",
"supportsScheduling": true,
"taxonFeatures": {},
"taxonomy": {},
"type": "<string>"
},
"moduleStatus": "<string>",
"moduleType": "<string>",
"name": "<string>",
"organization": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<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 Modules. Modules are processing modules that can be executed on documents.
curl --request GET \
--url https://platform.kodexa.ai/api/modules \
--header 'x-api-key: <api-key>'{
"content": [
{
"changeSequence": 123,
"createdBy": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"description": "<string>",
"entryPoint": "<string>",
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"additionalTaxonOptions": {},
"baseDir": "<string>",
"contents": [
"<string>"
],
"eventAware": true,
"ignoredContents": [
"<string>"
],
"inferable": true,
"inferenceOptions": {},
"messageTemplates": {},
"modelRuntimeParameters": {},
"modelRuntimeRef": "<string>",
"moduleSidecars": [
"<string>"
],
"optionTabs": {},
"script": "<string>",
"scriptLanguage": "<string>",
"state": "<string>",
"stateHash": "<string>",
"supportsScheduling": true,
"taxonFeatures": {},
"taxonomy": {},
"type": "<string>"
},
"moduleStatus": "<string>",
"moduleType": "<string>",
"name": "<string>",
"organization": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<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. Separate multiple sort fields with ;. Direction defaults to asc; use desc for descending order.
SpringFilter expression. Supported operators: == (equals), != (not equals), =like= (wildcard match with *), =in= (in list), > / >= / < / <= (comparison), is null, is not null. Combine with and or ; (AND), or or , (OR). Example: name=='Acme Corp' and status=='ACTIVE'
Full-text search query matching against the entity's searchable fields.
Page of Modules
Paginated response containing ModuleMetadata items.
Array of ModuleMetadata 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.