curl --request POST \
--url https://platform.kodexa.ai/api/sessions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"organization": {
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "<string>",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "<string>",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "<string>",
"organizationStatus": "<string>",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "<string>",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"state": "<string>",
"token": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"organization": {
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "<string>",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "<string>",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "<string>",
"organizationStatus": "<string>",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "<string>",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"state": "<string>",
"token": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Creates a new Session. Sessions represent processing sessions for document operations.
curl --request POST \
--url https://platform.kodexa.ai/api/sessions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"organization": {
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "<string>",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "<string>",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "<string>",
"organizationStatus": "<string>",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "<string>",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"state": "<string>",
"token": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"organization": {
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "<string>",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "<string>",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "<string>",
"organizationStatus": "<string>",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "<string>",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"state": "<string>",
"token": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
A session represents a processing session for document operations.
Optimistic locking version number.
Timestamp when the session was created.
Unique identifier (UUID) for the session.
Show child attributes
Timestamp when the session was last updated.
Secondary UUID identifier.
Created Session
A session represents a processing session for document operations.
Optimistic locking version number.
Timestamp when the session was created.
Unique identifier (UUID) for the session.
Show child attributes
Timestamp when the session was last updated.
Secondary UUID identifier.