Create TaskDocumentFamily
curl --request POST \
--url https://platform.kodexa.ai/api/task-document-families \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"documentFamilyId": "<string>",
"ordinal": 123,
"taskId": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/task-document-families"
payload = {
"documentFamilyId": "<string>",
"ordinal": 123,
"taskId": "<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({documentFamilyId: '<string>', ordinal: 123, taskId: '<string>'})
};
fetch('https://platform.kodexa.ai/api/task-document-families', 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/task-document-families",
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([
'documentFamilyId' => '<string>',
'ordinal' => 123,
'taskId' => '<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/task-document-families"
payload := strings.NewReader("{\n \"documentFamilyId\": \"<string>\",\n \"ordinal\": 123,\n \"taskId\": \"<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/task-document-families")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"documentFamilyId\": \"<string>\",\n \"ordinal\": 123,\n \"taskId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/task-document-families")
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 \"documentFamilyId\": \"<string>\",\n \"ordinal\": 123,\n \"taskId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"documentFamilyId": "<string>",
"id": "<string>",
"ordinal": 123,
"taskId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}TaskDocumentFamilies
Create TaskDocumentFamily
Creates a new TaskDocumentFamily. Task document families associate document families with tasks for review.
POST
/
api
/
task-document-families
Create TaskDocumentFamily
curl --request POST \
--url https://platform.kodexa.ai/api/task-document-families \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"documentFamilyId": "<string>",
"ordinal": 123,
"taskId": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/task-document-families"
payload = {
"documentFamilyId": "<string>",
"ordinal": 123,
"taskId": "<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({documentFamilyId: '<string>', ordinal: 123, taskId: '<string>'})
};
fetch('https://platform.kodexa.ai/api/task-document-families', 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/task-document-families",
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([
'documentFamilyId' => '<string>',
'ordinal' => 123,
'taskId' => '<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/task-document-families"
payload := strings.NewReader("{\n \"documentFamilyId\": \"<string>\",\n \"ordinal\": 123,\n \"taskId\": \"<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/task-document-families")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"documentFamilyId\": \"<string>\",\n \"ordinal\": 123,\n \"taskId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/task-document-families")
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 \"documentFamilyId\": \"<string>\",\n \"ordinal\": 123,\n \"taskId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"documentFamilyId": "<string>",
"id": "<string>",
"ordinal": 123,
"taskId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
application/json
Response
Created TaskDocumentFamily
A task document family associates a document family with a task for review.