Skip to main content
POST
/
api
/
knowledge-items
Create KnowledgeItem
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>",
  "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": "<unknown>",
    "organization": {
      "archived": true,
      "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"
    },
    "organizationId": "<string>",
    "slug": "<string>",
    "supportsAttachment": true,
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "knowledgeItemTypeId": "<string>",
  "knowledgeSetId": "<string>",
  "knowledgeSetSlug": "<string>",
  "properties": "<unknown>",
  "searchText": "<string>",
  "sequenceOrder": 123,
  "slug": "<string>",
  "title": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
import requests

url = "https://platform.kodexa.ai/api/knowledge-items"

payload = {
    "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": "<unknown>",
        "organization": {
            "archived": True,
            "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"
        },
        "organizationId": "<string>",
        "slug": "<string>",
        "supportsAttachment": True,
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
    },
    "knowledgeItemTypeId": "<string>",
    "knowledgeSetId": "<string>",
    "knowledgeSetSlug": "<string>",
    "properties": "<unknown>",
    "searchText": "<string>",
    "sequenceOrder": 123,
    "slug": "<string>",
    "title": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: '<unknown>',
      organization: {
        archived: true,
        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'
      },
      organizationId: '<string>',
      slug: '<string>',
      supportsAttachment: true,
      updatedOn: '2023-11-07T05:31:56Z',
      uuid: '<string>'
    },
    knowledgeItemTypeId: '<string>',
    knowledgeSetId: '<string>',
    knowledgeSetSlug: '<string>',
    properties: '<unknown>',
    searchText: '<string>',
    sequenceOrder: 123,
    slug: '<string>',
    title: '<string>',
    updatedOn: '2023-11-07T05:31:56Z',
    uuid: '<string>'
  })
};

fetch('https://platform.kodexa.ai/api/knowledge-items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.kodexa.ai/api/knowledge-items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => '<unknown>',
        'organization' => [
                'archived' => true,
                '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'
        ],
        'organizationId' => '<string>',
        'slug' => '<string>',
        'supportsAttachment' => true,
        'updatedOn' => '2023-11-07T05:31:56Z',
        'uuid' => '<string>'
    ],
    'knowledgeItemTypeId' => '<string>',
    'knowledgeSetId' => '<string>',
    'knowledgeSetSlug' => '<string>',
    'properties' => '<unknown>',
    'searchText' => '<string>',
    'sequenceOrder' => 123,
    'slug' => '<string>',
    'title' => '<string>',
    'updatedOn' => '2023-11-07T05:31:56Z',
    'uuid' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.kodexa.ai/api/knowledge-items"

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

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://platform.kodexa.ai/api/knowledge-items")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true,\n  \"attachmentContentHash\": \"<string>\",\n  \"attachmentContentType\": \"<string>\",\n  \"attachmentFileName\": \"<string>\",\n  \"attachmentId\": \"<string>\",\n  \"attachmentSize\": 123,\n  \"attachmentUploadedAt\": \"2023-11-07T05:31:56Z\",\n  \"attachmentUploadedBy\": \"<string>\",\n  \"changeSequence\": 123,\n  \"createdOn\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"id\": \"<string>\",\n  \"knowledgeItemType\": {\n    \"changeSequence\": 123,\n    \"createdOn\": \"2023-11-07T05:31:56Z\",\n    \"description\": \"<string>\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"options\": \"<unknown>\",\n    \"organization\": {\n      \"archived\": true,\n      \"authGroupLink\": {\n        \"authGroup\": \"<string>\"\n      },\n      \"changeSequence\": 123,\n      \"createdOn\": \"2023-11-07T05:31:56Z\",\n      \"defaultToPrivateTemplates\": true,\n      \"description\": \"Document processing organization for Acme Corp.\",\n      \"enterpriseOrganization\": true,\n      \"features\": {},\n      \"hasImage\": true,\n      \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"memory\": {\n        \"orderedDashboards\": [\n          \"<string>\"\n        ]\n      },\n      \"name\": \"Acme Corp\",\n      \"organizationStatus\": \"ACTIVE\",\n      \"properties\": {},\n      \"publicAccess\": true,\n      \"searchText\": \"<string>\",\n      \"slug\": \"acme-corp\",\n      \"stripeCustomerId\": \"<string>\",\n      \"supportAccess\": true,\n      \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n      \"updatedOn\": \"2023-11-07T05:31:56Z\",\n      \"uuid\": \"550e8400e29b41d4a716446655440000\"\n    },\n    \"organizationId\": \"<string>\",\n    \"slug\": \"<string>\",\n    \"supportsAttachment\": true,\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"knowledgeItemTypeId\": \"<string>\",\n  \"knowledgeSetId\": \"<string>\",\n  \"knowledgeSetSlug\": \"<string>\",\n  \"properties\": \"<unknown>\",\n  \"searchText\": \"<string>\",\n  \"sequenceOrder\": 123,\n  \"slug\": \"<string>\",\n  \"title\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/knowledge-items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"active\": true,\n  \"attachmentContentHash\": \"<string>\",\n  \"attachmentContentType\": \"<string>\",\n  \"attachmentFileName\": \"<string>\",\n  \"attachmentId\": \"<string>\",\n  \"attachmentSize\": 123,\n  \"attachmentUploadedAt\": \"2023-11-07T05:31:56Z\",\n  \"attachmentUploadedBy\": \"<string>\",\n  \"changeSequence\": 123,\n  \"createdOn\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"id\": \"<string>\",\n  \"knowledgeItemType\": {\n    \"changeSequence\": 123,\n    \"createdOn\": \"2023-11-07T05:31:56Z\",\n    \"description\": \"<string>\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"options\": \"<unknown>\",\n    \"organization\": {\n      \"archived\": true,\n      \"authGroupLink\": {\n        \"authGroup\": \"<string>\"\n      },\n      \"changeSequence\": 123,\n      \"createdOn\": \"2023-11-07T05:31:56Z\",\n      \"defaultToPrivateTemplates\": true,\n      \"description\": \"Document processing organization for Acme Corp.\",\n      \"enterpriseOrganization\": true,\n      \"features\": {},\n      \"hasImage\": true,\n      \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"memory\": {\n        \"orderedDashboards\": [\n          \"<string>\"\n        ]\n      },\n      \"name\": \"Acme Corp\",\n      \"organizationStatus\": \"ACTIVE\",\n      \"properties\": {},\n      \"publicAccess\": true,\n      \"searchText\": \"<string>\",\n      \"slug\": \"acme-corp\",\n      \"stripeCustomerId\": \"<string>\",\n      \"supportAccess\": true,\n      \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n      \"updatedOn\": \"2023-11-07T05:31:56Z\",\n      \"uuid\": \"550e8400e29b41d4a716446655440000\"\n    },\n    \"organizationId\": \"<string>\",\n    \"slug\": \"<string>\",\n    \"supportsAttachment\": true,\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"knowledgeItemTypeId\": \"<string>\",\n  \"knowledgeSetId\": \"<string>\",\n  \"knowledgeSetSlug\": \"<string>\",\n  \"properties\": \"<unknown>\",\n  \"searchText\": \"<string>\",\n  \"sequenceOrder\": 123,\n  \"slug\": \"<string>\",\n  \"title\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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": "<unknown>",
    "organization": {
      "archived": true,
      "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"
    },
    "organizationId": "<string>",
    "slug": "<string>",
    "supportsAttachment": true,
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "knowledgeItemTypeId": "<string>",
  "knowledgeSetId": "<string>",
  "knowledgeSetSlug": "<string>",
  "properties": "<unknown>",
  "searchText": "<string>",
  "sequenceOrder": 123,
  "slug": "<string>",
  "title": "<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

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
​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
description
string
​
id
string
​
knowledgeItemType
object | null

A knowledge item type defines the kind of knowledge item.

​
knowledgeItemTypeId
string | null
​
knowledgeSetId
string | null
​
knowledgeSetSlug
string
​
properties
any
​
searchText
string
​
sequenceOrder
integer<int32> | null
​
slug
string
​
title
string
​
updatedOn
string<date-time>
​
uuid
string

Response

Created KnowledgeItem

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
​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
description
string
​
id
string
​
knowledgeItemType
object | null

A knowledge item type defines the kind of knowledge item.

​
knowledgeItemTypeId
string | null
​
knowledgeSetId
string | null
​
knowledgeSetSlug
string
​
properties
any
​
searchText
string
​
sequenceOrder
integer<int32> | null
​
slug
string
​
title
string
​
updatedOn
string<date-time>
​
uuid
string