Update Prompts - Kodexa Developer Portal

Update Prompts

curl --request PUT \
  --url https://platform.kodexa.ai/api/prompts/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "deprecated": true,
  "extensionPackRef": "<string>",
  "metadata": null,
  "name": "<string>",
  "orgSlug": "<string>",
  "organization": {
    "id": "<string>"
  },
  "publicAccess": true,
  "ref": "<string>",
  "slug": "<string>",
  "template": true,
  "type": "<string>",
  "uri": "<string>",
  "yamlSource": "<string>"
}
'

import requests

url = "https://platform.kodexa.ai/api/prompts/{id}"

payload = {
    "changeSequence": 123,
    "deprecated": True,
    "extensionPackRef": "<string>",
    "metadata": None,
    "name": "<string>",
    "orgSlug": "<string>",
    "organization": { "id": "<string>" },
    "publicAccess": True,
    "ref": "<string>",
    "slug": "<string>",
    "template": True,
    "type": "<string>",
    "uri": "<string>",
    "yamlSource": "<string>"
}
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({
    changeSequence: 123,
    deprecated: true,
    extensionPackRef: '<string>',
    metadata: null,
    name: '<string>',
    orgSlug: '<string>',
    organization: {id: '<string>'},
    publicAccess: true,
    ref: '<string>',
    slug: '<string>',
    template: true,
    type: '<string>',
    uri: '<string>',
    yamlSource: '<string>'
  })
};

fetch('https://platform.kodexa.ai/api/prompts/{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/prompts/{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([
    'changeSequence' => 123,
    'deprecated' => true,
    'extensionPackRef' => '<string>',
    'metadata' => null,
    'name' => '<string>',
    'orgSlug' => '<string>',
    'organization' => [
        'id' => '<string>'
    ],
    'publicAccess' => true,
    'ref' => '<string>',
    'slug' => '<string>',
    'template' => true,
    'type' => '<string>',
    'uri' => '<string>',
    'yamlSource' => '<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/prompts/{id}"

	payload := strings.NewReader("{\n  \"changeSequence\": 123,\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"metadata\": null,\n  \"name\": \"<string>\",\n  \"orgSlug\": \"<string>\",\n  \"organization\": {\n    \"id\": \"<string>\"\n  },\n  \"publicAccess\": true,\n  \"ref\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"yamlSource\": \"<string>\"\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/prompts/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"changeSequence\": 123,\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"metadata\": null,\n  \"name\": \"<string>\",\n  \"orgSlug\": \"<string>\",\n  \"organization\": {\n    \"id\": \"<string>\"\n  },\n  \"publicAccess\": true,\n  \"ref\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/prompts/{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  \"changeSequence\": 123,\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"metadata\": null,\n  \"name\": \"<string>\",\n  \"orgSlug\": \"<string>\",\n  \"organization\": {\n    \"id\": \"<string>\"\n  },\n  \"publicAccess\": true,\n  \"ref\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleted": true,
  "deprecated": true,
  "id": "<string>",
  "metadata": null,
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deletedDate": "2023-11-07T05:31:56Z",
  "extensionPackRef": "<string>",
  "orgSlug": "<string>",
  "organization": {
    "id": "<string>"
  },
  "ref": "<string>",
  "type": "<string>",
  "uri": "<string>",
  "yamlSource": "<string>"
}

PUT

api

prompts

{id}

Update Prompts

curl --request PUT \
  --url https://platform.kodexa.ai/api/prompts/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "deprecated": true,
  "extensionPackRef": "<string>",
  "metadata": null,
  "name": "<string>",
  "orgSlug": "<string>",
  "organization": {
    "id": "<string>"
  },
  "publicAccess": true,
  "ref": "<string>",
  "slug": "<string>",
  "template": true,
  "type": "<string>",
  "uri": "<string>",
  "yamlSource": "<string>"
}
'

import requests

url = "https://platform.kodexa.ai/api/prompts/{id}"

payload = {
    "changeSequence": 123,
    "deprecated": True,
    "extensionPackRef": "<string>",
    "metadata": None,
    "name": "<string>",
    "orgSlug": "<string>",
    "organization": { "id": "<string>" },
    "publicAccess": True,
    "ref": "<string>",
    "slug": "<string>",
    "template": True,
    "type": "<string>",
    "uri": "<string>",
    "yamlSource": "<string>"
}
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({
    changeSequence: 123,
    deprecated: true,
    extensionPackRef: '<string>',
    metadata: null,
    name: '<string>',
    orgSlug: '<string>',
    organization: {id: '<string>'},
    publicAccess: true,
    ref: '<string>',
    slug: '<string>',
    template: true,
    type: '<string>',
    uri: '<string>',
    yamlSource: '<string>'
  })
};

fetch('https://platform.kodexa.ai/api/prompts/{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/prompts/{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([
    'changeSequence' => 123,
    'deprecated' => true,
    'extensionPackRef' => '<string>',
    'metadata' => null,
    'name' => '<string>',
    'orgSlug' => '<string>',
    'organization' => [
        'id' => '<string>'
    ],
    'publicAccess' => true,
    'ref' => '<string>',
    'slug' => '<string>',
    'template' => true,
    'type' => '<string>',
    'uri' => '<string>',
    'yamlSource' => '<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/prompts/{id}"

	payload := strings.NewReader("{\n  \"changeSequence\": 123,\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"metadata\": null,\n  \"name\": \"<string>\",\n  \"orgSlug\": \"<string>\",\n  \"organization\": {\n    \"id\": \"<string>\"\n  },\n  \"publicAccess\": true,\n  \"ref\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"yamlSource\": \"<string>\"\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/prompts/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"changeSequence\": 123,\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"metadata\": null,\n  \"name\": \"<string>\",\n  \"orgSlug\": \"<string>\",\n  \"organization\": {\n    \"id\": \"<string>\"\n  },\n  \"publicAccess\": true,\n  \"ref\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/prompts/{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  \"changeSequence\": 123,\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"metadata\": null,\n  \"name\": \"<string>\",\n  \"orgSlug\": \"<string>\",\n  \"organization\": {\n    \"id\": \"<string>\"\n  },\n  \"publicAccess\": true,\n  \"ref\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleted": true,
  "deprecated": true,
  "id": "<string>",
  "metadata": null,
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deletedDate": "2023-11-07T05:31:56Z",
  "extensionPackRef": "<string>",
  "orgSlug": "<string>",
  "organization": {
    "id": "<string>"
  },
  "ref": "<string>",
  "type": "<string>",
  "uri": "<string>",
  "yamlSource": "<string>"
}

Authorizations

x-api-key

string

header

required

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

Path Parameters

string<uuid>

required

Unique identifier (UUID) of the resource.

Body

application/json

Prompt metadata defines a prompt template used by AI assistants for document processing.

changeSequence

integer<int32>

Optimistic locking version number.

deprecated

boolean

Whether this prompt is deprecated.

extensionPackRef

string

metadata

unknown

name

string

Display name of the prompt.

orgSlug

string

organization

object | null

Show child attributes

publicAccess

boolean

Whether the prompt is publicly accessible.

ref

string

slug

string

URL-friendly identifier for the prompt.

template

boolean

Whether this prompt is a template.

type

string

uri

string

Computed resource URI (scheme://orgSlug/slug), present on serialized responses.

yamlSource

string | null

Response

Updated Prompts

Prompt metadata defines a prompt template used by AI assistants for document processing.

changeSequence

integer<int32>

required

Optimistic locking version number.

createdOn

string<date-time>

required

Timestamp when the prompt was created.

deleted

boolean

required

deprecated

boolean

required

Whether this prompt is deprecated.

string

required

Unique identifier (UUID) for the prompt.

metadata

unknown

required

name

string

required

Display name of the prompt.

organizationId

string

required

publicAccess

boolean

required

Whether the prompt is publicly accessible.

slug

string

required

URL-friendly identifier for the prompt.

template

boolean

required

Whether this prompt is a template.

updatedOn

string<date-time>

required

Timestamp when the prompt was last updated.

uuid

string

required

Secondary UUID identifier.

deleteUserEmail

string | null

deleteUserId

string | null

deletedDate

string<date-time> | null

extensionPackRef

string

orgSlug

string

organization

object | null

Show child attributes

ref

string

type

string

uri

string

Computed resource URI (scheme://orgSlug/slug), present on serialized responses.

yamlSource

string | null