Skip to main content
POST
/
api
/
knowledge-set-sources
Create KnowledgeSetSource
curl --request POST \
  --url https://platform.kodexa.ai/api/knowledge-set-sources \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "contentObject": {
    "changeSequence": 123,
    "contentMetadata": {},
    "contentType": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "createdOn": "2023-11-07T05:31:56Z",
    "documentFamilyId": "<string>",
    "documentTaxonValidations": [
      {
        "taxonPath": "<string>",
        "taxonomyRef": "<string>",
        "validation": {
          "conditional": true,
          "conditionalFormula": "<string>",
          "description": "<string>",
          "detailFormula": "<string>",
          "disabled": true,
          "exceptionId": "<string>",
          "messageFormula": "<string>",
          "name": "<string>",
          "overridable": true,
          "ruleFormula": "<string>",
          "supportArticleId": "<string>"
        }
      }
    ],
    "documentVersion": "<string>",
    "id": "<string>",
    "index": 123,
    "metadata": {},
    "mixins": {},
    "modified": "2023-11-07T05:31:56Z",
    "size": 123,
    "source": {
      "checksum": "<string>",
      "cid": "<string>",
      "connector": "<string>",
      "created": "<string>",
      "document_family_id": "<string>",
      "headers": {},
      "last_modified": "<string>",
      "lineage_document_uuid": "<string>",
      "mime_type": "<string>",
      "original_filename": "<string>",
      "original_path": "<string>",
      "source_document_uuid": "<string>"
    },
    "storeRef": "<string>",
    "summary": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "contentObjectId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdOn": "2023-11-07T05:31:56Z",
  "executionId": "<string>",
  "id": "<string>",
  "knowledgeSet": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "currentSnapshotId": "<string>",
    "description": "<string>",
    "featureExpression": {
      "children": "<array>",
      "expression": "<string>",
      "slug": "<string>",
      "type": "<string>"
    },
    "id": "<string>",
    "name": "<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>",
    "priority": 123,
    "project": {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "dataFlow": {
        "edges": [
          {
            "id": "<string>",
            "properties": {},
            "source": "<string>",
            "target": "<string>"
          }
        ],
        "nodes": [
          {
            "dimensions": {
              "height": 123,
              "width": 123
            },
            "id": "<string>",
            "parentId": "<string>",
            "position": {
              "x": 123,
              "y": 123
            },
            "properties": {},
            "type": "<string>"
          }
        ],
        "viewPort": {
          "x": 123,
          "y": 123,
          "zoom": 123
        }
      },
      "description": "<string>",
      "id": "<string>",
      "memory": {
        "changeSequence": 123,
        "orderedDashboards": [
          "<string>"
        ],
        "recentFilters": {},
        "recentQueries": {}
      },
      "name": "<string>",
      "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": "<string>",
            "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": "<string>",
            "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": "<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>",
      "owner": {
        "active": true,
        "bio": "<string>",
        "businessGroup": "<string>",
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "firstName": "<string>",
        "groupsJson": "<string>",
        "id": "<string>",
        "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": "<string>",
      "status": {
        "changeSequence": 123,
        "color": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "icon": "<string>",
        "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>",
        "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>",
    "projectSlug": "<string>",
    "searchText": "<string>",
    "setType": "<string>",
    "slug": "<string>",
    "status": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "knowledgeSetId": "<string>",
  "metadata": {},
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "changeSequence": 123,
  "contentObject": {
    "changeSequence": 123,
    "contentMetadata": {},
    "contentType": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "createdOn": "2023-11-07T05:31:56Z",
    "documentFamilyId": "<string>",
    "documentTaxonValidations": [
      {
        "taxonPath": "<string>",
        "taxonomyRef": "<string>",
        "validation": {
          "conditional": true,
          "conditionalFormula": "<string>",
          "description": "<string>",
          "detailFormula": "<string>",
          "disabled": true,
          "exceptionId": "<string>",
          "messageFormula": "<string>",
          "name": "<string>",
          "overridable": true,
          "ruleFormula": "<string>",
          "supportArticleId": "<string>"
        }
      }
    ],
    "documentVersion": "<string>",
    "id": "<string>",
    "index": 123,
    "metadata": {},
    "mixins": {},
    "modified": "2023-11-07T05:31:56Z",
    "size": 123,
    "source": {
      "checksum": "<string>",
      "cid": "<string>",
      "connector": "<string>",
      "created": "<string>",
      "document_family_id": "<string>",
      "headers": {},
      "last_modified": "<string>",
      "lineage_document_uuid": "<string>",
      "mime_type": "<string>",
      "original_filename": "<string>",
      "original_path": "<string>",
      "source_document_uuid": "<string>"
    },
    "storeRef": "<string>",
    "summary": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "contentObjectId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdOn": "2023-11-07T05:31:56Z",
  "executionId": "<string>",
  "id": "<string>",
  "knowledgeSet": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "currentSnapshotId": "<string>",
    "description": "<string>",
    "featureExpression": {
      "children": "<array>",
      "expression": "<string>",
      "slug": "<string>",
      "type": "<string>"
    },
    "id": "<string>",
    "name": "<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>",
    "priority": 123,
    "project": {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "dataFlow": {
        "edges": [
          {
            "id": "<string>",
            "properties": {},
            "source": "<string>",
            "target": "<string>"
          }
        ],
        "nodes": [
          {
            "dimensions": {
              "height": 123,
              "width": 123
            },
            "id": "<string>",
            "parentId": "<string>",
            "position": {
              "x": 123,
              "y": 123
            },
            "properties": {},
            "type": "<string>"
          }
        ],
        "viewPort": {
          "x": 123,
          "y": 123,
          "zoom": 123
        }
      },
      "description": "<string>",
      "id": "<string>",
      "memory": {
        "changeSequence": 123,
        "orderedDashboards": [
          "<string>"
        ],
        "recentFilters": {},
        "recentQueries": {}
      },
      "name": "<string>",
      "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": "<string>",
            "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": "<string>",
            "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": "<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>",
      "owner": {
        "active": true,
        "bio": "<string>",
        "businessGroup": "<string>",
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "firstName": "<string>",
        "groupsJson": "<string>",
        "id": "<string>",
        "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": "<string>",
      "status": {
        "changeSequence": 123,
        "color": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "icon": "<string>",
        "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>",
        "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>",
    "projectSlug": "<string>",
    "searchText": "<string>",
    "setType": "<string>",
    "slug": "<string>",
    "status": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "knowledgeSetId": "<string>",
  "metadata": {},
  "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

A knowledge set source references the origin of knowledge set data.

changeSequence
integer<int32>
contentObject
object
contentObjectId
string | null
createdAt
string<date-time>
createdOn
string<date-time>
executionId
string | null
id
string
knowledgeSet
object
knowledgeSetId
string | null
metadata
object
updatedOn
string<date-time>
uuid
string

Response

Created KnowledgeSetSource

A knowledge set source references the origin of knowledge set data.

changeSequence
integer<int32>
contentObject
object
contentObjectId
string | null
createdAt
string<date-time>
createdOn
string<date-time>
executionId
string | null
id
string
knowledgeSet
object
knowledgeSetId
string | null
metadata
object
updatedOn
string<date-time>
uuid
string