Skip to main content
PUT
/
api
/
knowledge-set-snapshots
/
{id}
Update KnowledgeSetSnapshot
curl --request PUT \
  --url https://platform.kodexa.ai/api/knowledge-set-snapshots/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeReason": "<string>",
  "changeSequence": 123,
  "contentHash": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "data": "<unknown>",
  "id": "<string>",
  "knowledgeSetId": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "version": 123
}
'
import requests

url = "https://platform.kodexa.ai/api/knowledge-set-snapshots/{id}"

payload = {
"changeReason": "<string>",
"changeSequence": 123,
"contentHash": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"data": "<unknown>",
"id": "<string>",
"knowledgeSetId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"version": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeReason: '<string>',
changeSequence: 123,
contentHash: '<string>',
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
createdOn: '2023-11-07T05:31:56Z',
data: '<unknown>',
id: '<string>',
knowledgeSetId: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>',
version: 123
})
};

fetch('https://platform.kodexa.ai/api/knowledge-set-snapshots/{id}', 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-set-snapshots/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'changeReason' => '<string>',
'changeSequence' => 123,
'contentHash' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'data' => '<unknown>',
'id' => '<string>',
'knowledgeSetId' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>',
'version' => 123
]),
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-set-snapshots/{id}"

payload := strings.NewReader("{\n \"changeReason\": \"<string>\",\n \"changeSequence\": 123,\n \"contentHash\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"data\": \"<unknown>\",\n \"id\": \"<string>\",\n \"knowledgeSetId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"version\": 123\n}")

req, _ := http.NewRequest("PUT", 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.put("https://platform.kodexa.ai/api/knowledge-set-snapshots/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeReason\": \"<string>\",\n \"changeSequence\": 123,\n \"contentHash\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"data\": \"<unknown>\",\n \"id\": \"<string>\",\n \"knowledgeSetId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"version\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/knowledge-set-snapshots/{id}")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changeReason\": \"<string>\",\n \"changeSequence\": 123,\n \"contentHash\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"data\": \"<unknown>\",\n \"id\": \"<string>\",\n \"knowledgeSetId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"version\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "changeReason": "<string>",
  "changeSequence": 123,
  "contentHash": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "data": "<unknown>",
  "id": "<string>",
  "knowledgeSetId": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "version": 123
}

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json

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

changeReason
string | null
changeSequence
integer<int32>
contentHash
string
createdAt
string<date-time>
createdBy
string | null
createdOn
string<date-time>
data
any
id
string
knowledgeSetId
string | null
updatedOn
string<date-time>
uuid
string
version
integer<int32>

Response

Updated KnowledgeSetSnapshot

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

changeReason
string | null
changeSequence
integer<int32>
contentHash
string
createdAt
string<date-time>
createdBy
string | null
createdOn
string<date-time>
data
any
id
string
knowledgeSetId
string | null
updatedOn
string<date-time>
uuid
string
version
integer<int32>