Invoke LLM
curl --request POST \
--url https://platform.kodexa.ai/api/organizations/{orgId}/llm \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"parameters": {},
"prompt": "<string>",
"promptRef": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/organizations/{orgId}/llm"
payload = {
"parameters": {},
"prompt": "<string>",
"promptRef": "<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({parameters: {}, prompt: '<string>', promptRef: '<string>'})
};
fetch('https://platform.kodexa.ai/api/organizations/{orgId}/llm', 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/organizations/{orgId}/llm",
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([
'parameters' => [
],
'prompt' => '<string>',
'promptRef' => '<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/organizations/{orgId}/llm"
payload := strings.NewReader("{\n \"parameters\": {},\n \"prompt\": \"<string>\",\n \"promptRef\": \"<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/organizations/{orgId}/llm")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"parameters\": {},\n \"prompt\": \"<string>\",\n \"promptRef\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/organizations/{orgId}/llm")
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 \"parameters\": {},\n \"prompt\": \"<string>\",\n \"promptRef\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body"<string>"Organizations
Invoke LLM
Invokes the platform LLM for the specified organization. Resolves the prompt template (either from a stored prompt reference or an inline string), renders template parameters, and returns the LLM response as plain text.
POST
/
api
/
organizations
/
{orgId}
/
llm
Invoke LLM
curl --request POST \
--url https://platform.kodexa.ai/api/organizations/{orgId}/llm \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"parameters": {},
"prompt": "<string>",
"promptRef": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/organizations/{orgId}/llm"
payload = {
"parameters": {},
"prompt": "<string>",
"promptRef": "<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({parameters: {}, prompt: '<string>', promptRef: '<string>'})
};
fetch('https://platform.kodexa.ai/api/organizations/{orgId}/llm', 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/organizations/{orgId}/llm",
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([
'parameters' => [
],
'prompt' => '<string>',
'promptRef' => '<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/organizations/{orgId}/llm"
payload := strings.NewReader("{\n \"parameters\": {},\n \"prompt\": \"<string>\",\n \"promptRef\": \"<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/organizations/{orgId}/llm")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"parameters\": {},\n \"prompt\": \"<string>\",\n \"promptRef\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/organizations/{orgId}/llm")
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 \"parameters\": {},\n \"prompt\": \"<string>\",\n \"promptRef\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body"<string>"Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Path Parameters
Unique identifier (UUID) of the organization.
Body
application/json
Request body for invoking the platform LLM. Supply either a promptRef (referencing a stored prompt template) or an inline prompt string.
Size of the model to use.
Available options:
SMALL, LARGE Key-value parameters for template rendering.
Show child attributes
Show child attributes
Inline prompt text. Mutually exclusive with promptRef.
Reference to a stored prompt template (e.g., 'orgSlug/promptSlug' or 'promptSlug'). Mutually exclusive with prompt.
Response
LLM response text
The response is of type string.