Create KnowledgeItem

Creates a new KnowledgeItem. Knowledge items are individual pieces of knowledge within knowledge sets.

POST /api/knowledge-items

Create KnowledgeItem

cURL

curl --request POST \
  --url https://platform.kodexa.ai/api/knowledge-items \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "active": true,
  "attachmentContentHash": "<string>",
  "attachmentContentType": "<string>",
  "attachmentFileName": "<string>",
  "attachmentId": "<string>",
  "attachmentSize": 123,
  "attachmentUploadedAt": "2023-11-07T05:31:56Z",
  "attachmentUploadedBy": "<string>",
  "description": "<string>",
  "knowledgeItemType": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": "<string>",
    "name": "<string>",
    "options": null,
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "Document processing organization for Acme Corp.",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "Acme Corp",
      "organizationStatus": "ACTIVE",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "acme-corp",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "550e8400e29b41d4a716446655440000",
      "archived": true
    },
    "organizationId": "<string>",
    "slug": "<string>",
    "supportsAttachment": true,
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "impact": "<string>",
    "orgSlug": "<string>"
  },
  "knowledgeItemTypeId": "<string>",
  "knowledgeItemTypeRef": "<string>",
  "knowledgeSetId": "<string>",
  "knowledgeSetSlug": "<string>",
  "orgSlug": "<string>",
  "properties": null,
  "sequenceOrder": 123,
  "slug": "<string>",
  "title": "<string>"
}
'

201

{
  "active": true,
  "attachmentContentHash": "<string>",
  "attachmentContentType": "<string>",
  "attachmentFileName": "<string>",
  "attachmentId": "<string>",
  "attachmentSize": 123,
  "attachmentUploadedAt": "2023-11-07T05:31:56Z",
  "attachmentUploadedBy": "<string>",
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "<string>",
  "knowledgeItemType": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": "<string>",
    "name": "<string>",
    "options": null,
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "Document processing organization for Acme Corp.",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "Acme Corp",
      "organizationStatus": "ACTIVE",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "acme-corp",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "550e8400e29b41d4a716446655440000",
      "archived": true
    },
    "organizationId": "<string>",
    "slug": "<string>",
    "supportsAttachment": true,
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "impact": "<string>",
    "orgSlug": "<string>"
  },
  "knowledgeItemTypeId": "<string>",
  "knowledgeSetId": "<string>",
  "knowledgeSetSlug": "<string>",
  "properties": null,
  "searchText": "<string>",
  "sequenceOrder": 123,
  "slug": "<string>",
  "title": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "knowledgeItemTypeRef": "<string>",
  "orgSlug": "<string>"
}

Authorizations

x-api-keybearerAuth

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 item is an individual piece of knowledge within a knowledge set.

active · boolean

attachmentContentHash · string | null

attachmentContentType · string | null

attachmentFileName · string | null

attachmentId · string | null

attachmentSize · integer<int64> | null

attachmentUploadedAt · string<date-time> | null

attachmentUploadedBy · string | null

description · string

knowledgeItemType · object | null

A knowledge item type defines the kind of knowledge item.

Show child attributes

knowledgeItemTypeId · string | null

knowledgeItemTypeRef · string

knowledgeSetId · string | null

knowledgeSetSlug · string

orgSlug · string

properties · unknown

sequenceOrder · integer<int32> | null

slug · string

title · string

Response

201

application/json

Created KnowledgeItem

A knowledge item is an individual piece of knowledge within a knowledge set.

active · boolean · required

attachmentContentHash · string | null · required

attachmentContentType · string | null · required

attachmentFileName · string | null · required

attachmentId · string | null · required

attachmentSize · integer<int64> | null · required

attachmentUploadedAt · string<date-time> | null · required

attachmentUploadedBy · string | null · required

changeSequence · integer<int32> · required

createdOn · string<date-time> · required

description · string · required

id · string · required

knowledgeItemType · object | null · required

A knowledge item type defines the kind of knowledge item.

Show child attributes

knowledgeItemTypeId · string | null · required

knowledgeSetId · string | null · required

knowledgeSetSlug · string · required

properties · unknown · required

searchText · string · required

sequenceOrder · integer<int32> | null · required

slug · string · required

title · string · required

updatedOn · string<date-time> · required

uuid · string · required

knowledgeItemTypeRef · string

orgSlug · string