curl --request POST \
--url https://platform.kodexa.ai/api/prompts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"slug": "<string>",
"deprecated": true,
"extensionPackRef": "<string>",
"metadata": null,
"name": "<string>",
"orgSlug": "<string>",
"organization": {
"id": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"ref": "<string>",
"template": true,
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/prompts"
payload = {
"slug": "<string>",
"deprecated": True,
"extensionPackRef": "<string>",
"metadata": None,
"name": "<string>",
"orgSlug": "<string>",
"organization": { "id": "<string>" },
"organizationId": "<string>",
"publicAccess": True,
"ref": "<string>",
"template": True,
"type": "<string>",
"uri": "<string>",
"yamlSource": "<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({
slug: '<string>',
deprecated: true,
extensionPackRef: '<string>',
metadata: null,
name: '<string>',
orgSlug: '<string>',
organization: {id: '<string>'},
organizationId: '<string>',
publicAccess: true,
ref: '<string>',
template: true,
type: '<string>',
uri: '<string>',
yamlSource: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/prompts', 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",
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([
'slug' => '<string>',
'deprecated' => true,
'extensionPackRef' => '<string>',
'metadata' => null,
'name' => '<string>',
'orgSlug' => '<string>',
'organization' => [
'id' => '<string>'
],
'organizationId' => '<string>',
'publicAccess' => true,
'ref' => '<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"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": null,\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<string>\",\n \"template\": true,\n \"type\": \"<string>\",\n \"uri\": \"<string>\",\n \"yamlSource\": \"<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/prompts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": null,\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<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")
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 \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": null,\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<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>"
}Create Prompts
Creates a new Prompts. Prompts are templates used by AI assistants for document processing.
curl --request POST \
--url https://platform.kodexa.ai/api/prompts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"slug": "<string>",
"deprecated": true,
"extensionPackRef": "<string>",
"metadata": null,
"name": "<string>",
"orgSlug": "<string>",
"organization": {
"id": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"ref": "<string>",
"template": true,
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/prompts"
payload = {
"slug": "<string>",
"deprecated": True,
"extensionPackRef": "<string>",
"metadata": None,
"name": "<string>",
"orgSlug": "<string>",
"organization": { "id": "<string>" },
"organizationId": "<string>",
"publicAccess": True,
"ref": "<string>",
"template": True,
"type": "<string>",
"uri": "<string>",
"yamlSource": "<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({
slug: '<string>',
deprecated: true,
extensionPackRef: '<string>',
metadata: null,
name: '<string>',
orgSlug: '<string>',
organization: {id: '<string>'},
organizationId: '<string>',
publicAccess: true,
ref: '<string>',
template: true,
type: '<string>',
uri: '<string>',
yamlSource: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/prompts', 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",
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([
'slug' => '<string>',
'deprecated' => true,
'extensionPackRef' => '<string>',
'metadata' => null,
'name' => '<string>',
'orgSlug' => '<string>',
'organization' => [
'id' => '<string>'
],
'organizationId' => '<string>',
'publicAccess' => true,
'ref' => '<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"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": null,\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<string>\",\n \"template\": true,\n \"type\": \"<string>\",\n \"uri\": \"<string>\",\n \"yamlSource\": \"<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/prompts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": null,\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<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")
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 \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": null,\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<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
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
Prompt metadata defines a prompt template used by AI assistants for document processing.
URL-friendly identifier for the prompt.
Whether this prompt is deprecated.
Display name of the prompt.
Show child attributes
Show child attributes
Whether the prompt is publicly accessible.
Whether this prompt is a template.
Computed resource URI (scheme://orgSlug/slug), present on serialized responses.
Response
Created Prompts
Prompt metadata defines a prompt template used by AI assistants for document processing.
Optimistic locking version number.
Timestamp when the prompt was created.
Whether this prompt is deprecated.
Unique identifier (UUID) for the prompt.
Display name of the prompt.
Whether the prompt is publicly accessible.
URL-friendly identifier for the prompt.
Whether this prompt is a template.
Timestamp when the prompt was last updated.
Secondary UUID identifier.
Show child attributes
Show child attributes
Computed resource URI (scheme://orgSlug/slug), present on serialized responses.
