Get template by ID
curl --request GET \
--url https://api.kadoa.com/v4/templates/{templateId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.kadoa.com/v4/templates/{templateId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.kadoa.com/v4/templates/{templateId}', 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://api.kadoa.com/v4/templates/{templateId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.kadoa.com/v4/templates/{templateId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.kadoa.com/v4/templates/{templateId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kadoa.com/v4/templates/{templateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": false,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latestVersion": 123,
"archivedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"versions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"name": "<string>",
"publisher": {
"kind": "HUMAN",
"label": "<string>"
},
"prompt": "<string>",
"schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"frequency": {
"interval": "ONLY_ONCE",
"schedules": [
{
"type": "repeat",
"interval": "<string>",
"expressions": [
"<string>"
],
"timezone": "<string>"
}
],
"weekdaysOnly": true
},
"createdAt": "<string>",
"schemaFields": [
{
"name": "<string>",
"mapper": "jobDescription",
"mapperConfig": {},
"description": "<string>",
"instruction": "<string>",
"fieldType": "<string>",
"example": "<unknown>",
"shape": "<unknown>",
"dataType": "<string>",
"isKey": true,
"categories": [
{
"title": "<string>",
"definition": "<string>"
}
]
}
],
"schemaValidationRules": {},
"notifications": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"eventType": "<string>",
"eventConfiguration": {},
"enabled": true,
"channels": [
{
"channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channelName": "<string>",
"channelType": "<string>"
}
]
}
],
"recordLimit": 1073741824,
"recordLimitManaged": true,
"schemaName": "<string>",
"schemaEntity": "<string>"
}
],
"workflowCount": 123,
"latestVersionSummary": {
"promptPreview": "<string>",
"schemaFieldNames": [
"<string>"
],
"dqRuleCount": 0,
"notificationChannelCount": 0,
"frequencyInterval": "ONLY_ONCE",
"frequencyWeekdaysOnly": true
}
}
}{
"error": true,
"message": "<string>",
"details": "<unknown>"
}{
"error": true,
"message": "<string>",
"details": "<unknown>"
}{
"error": true,
"message": "<string>",
"details": "<unknown>"
}Templates
Get template
Retrieve a template by ID, including its version history
GET
/
v4
/
templates
/
{templateId}
Get template by ID
curl --request GET \
--url https://api.kadoa.com/v4/templates/{templateId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.kadoa.com/v4/templates/{templateId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.kadoa.com/v4/templates/{templateId}', 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://api.kadoa.com/v4/templates/{templateId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.kadoa.com/v4/templates/{templateId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.kadoa.com/v4/templates/{templateId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kadoa.com/v4/templates/{templateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": false,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latestVersion": 123,
"archivedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"versions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"name": "<string>",
"publisher": {
"kind": "HUMAN",
"label": "<string>"
},
"prompt": "<string>",
"schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"frequency": {
"interval": "ONLY_ONCE",
"schedules": [
{
"type": "repeat",
"interval": "<string>",
"expressions": [
"<string>"
],
"timezone": "<string>"
}
],
"weekdaysOnly": true
},
"createdAt": "<string>",
"schemaFields": [
{
"name": "<string>",
"mapper": "jobDescription",
"mapperConfig": {},
"description": "<string>",
"instruction": "<string>",
"fieldType": "<string>",
"example": "<unknown>",
"shape": "<unknown>",
"dataType": "<string>",
"isKey": true,
"categories": [
{
"title": "<string>",
"definition": "<string>"
}
]
}
],
"schemaValidationRules": {},
"notifications": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"eventType": "<string>",
"eventConfiguration": {},
"enabled": true,
"channels": [
{
"channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channelName": "<string>",
"channelType": "<string>"
}
]
}
],
"recordLimit": 1073741824,
"recordLimitManaged": true,
"schemaName": "<string>",
"schemaEntity": "<string>"
}
],
"workflowCount": 123,
"latestVersionSummary": {
"promptPreview": "<string>",
"schemaFieldNames": [
"<string>"
],
"dqRuleCount": 0,
"notificationChannelCount": 0,
"frequencyInterval": "ONLY_ONCE",
"frequencyWeekdaysOnly": true
}
}
}{
"error": true,
"message": "<string>",
"details": "<unknown>"
}{
"error": true,
"message": "<string>",
"details": "<unknown>"
}{
"error": true,
"message": "<string>",
"details": "<unknown>"
}Authorizations
API key for authentication
Path Parameters
Template ID
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$⌘I