Skip to main content
POST
/
api
/
applied-knowledge-sets
Create AppliedKnowledgeSet
curl --request POST \
  --url https://platform.kodexa.ai/api/applied-knowledge-sets \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "appliedAt": "2023-11-07T05:31:56Z",
  "appliedBy": "<string>",
  "changeSequence": 123,
  "confidence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "documentFamilyId": "<string>",
  "id": "<string>",
  "knowledgeSetId": "<string>",
  "snapshot": {
    "changeReason": "<string>",
    "changeSequence": 123,
    "contentHash": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "data": {},
    "id": "<string>",
    "knowledgeSetId": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "version": 123
  },
  "snapshotId": "<string>",
  "sourceContentObjectId": "<string>",
  "status": "<string>",
  "supersededAt": "2023-11-07T05:31:56Z",
  "supersededById": "<string>",
  "trigger": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "appliedAt": "2023-11-07T05:31:56Z",
  "appliedBy": "<string>",
  "changeSequence": 123,
  "confidence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "documentFamilyId": "<string>",
  "id": "<string>",
  "knowledgeSetId": "<string>",
  "snapshot": {
    "changeReason": "<string>",
    "changeSequence": 123,
    "contentHash": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "data": {},
    "id": "<string>",
    "knowledgeSetId": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "version": 123
  },
  "snapshotId": "<string>",
  "sourceContentObjectId": "<string>",
  "status": "<string>",
  "supersededAt": "2023-11-07T05:31:56Z",
  "supersededById": "<string>",
  "trigger": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

​
x-api-key
string
header
required

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

Body

application/json

An applied knowledge set configuration determines which knowledge is available during processing.

​
appliedAt
string<date-time>
​
appliedBy
string | null
​
changeSequence
integer<int32>
​
confidence
number<double> | null
​
createdOn
string<date-time>
​
documentFamilyId
string | null
​
id
string
​
knowledgeSetId
string | null
​
snapshot
object

A knowledge set snapshot captures the state of a knowledge set at a point in time.

​
snapshotId
string | null
​
sourceContentObjectId
string | null
​
status
string
​
supersededAt
string<date-time> | null
​
supersededById
string | null
​
trigger
string | null
​
updatedOn
string<date-time>
​
uuid
string

Response

Created AppliedKnowledgeSet

An applied knowledge set configuration determines which knowledge is available during processing.

​
appliedAt
string<date-time>
​
appliedBy
string | null
​
changeSequence
integer<int32>
​
confidence
number<double> | null
​
createdOn
string<date-time>
​
documentFamilyId
string | null
​
id
string
​
knowledgeSetId
string | null
​
snapshot
object

A knowledge set snapshot captures the state of a knowledge set at a point in time.

​
snapshotId
string | null
​
sourceContentObjectId
string | null
​
status
string
​
supersededAt
string<date-time> | null
​
supersededById
string | null
​
trigger
string | null
​
updatedOn
string<date-time>
​
uuid
string