Create ActivityPlan
curl --request POST \
--url https://platform.kodexa.ai/api/activity-plans \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"slug": "<string>",
"defaultDescriptionTemplate": "<string>",
"defaultTitleTemplate": "<string>",
"deprecated": true,
"description": "<string>",
"documentFamilyGroups": null,
"documentSummarizationPrompt": "<string>",
"documentValidationPrompt": "<string>",
"extensionPackRef": "<string>",
"inputOptions": null,
"inputsSchema": null,
"knowledgeAgent": true,
"metadata": null,
"name": "<string>",
"orgSlug": "<string>",
"organization": {
"id": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"ref": "<string>",
"steps": null,
"template": true,
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/activity-plans"
payload = {
"slug": "<string>",
"defaultDescriptionTemplate": "<string>",
"defaultTitleTemplate": "<string>",
"deprecated": True,
"description": "<string>",
"documentFamilyGroups": None,
"documentSummarizationPrompt": "<string>",
"documentValidationPrompt": "<string>",
"extensionPackRef": "<string>",
"inputOptions": None,
"inputsSchema": None,
"knowledgeAgent": True,
"metadata": None,
"name": "<string>",
"orgSlug": "<string>",
"organization": { "id": "<string>" },
"organizationId": "<string>",
"publicAccess": True,
"ref": "<string>",
"steps": None,
"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>',
defaultDescriptionTemplate: '<string>',
defaultTitleTemplate: '<string>',
deprecated: true,
description: '<string>',
documentFamilyGroups: null,
documentSummarizationPrompt: '<string>',
documentValidationPrompt: '<string>',
extensionPackRef: '<string>',
inputOptions: null,
inputsSchema: null,
knowledgeAgent: true,
metadata: null,
name: '<string>',
orgSlug: '<string>',
organization: {id: '<string>'},
organizationId: '<string>',
publicAccess: true,
ref: '<string>',
steps: null,
template: true,
type: '<string>',
uri: '<string>',
yamlSource: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/activity-plans', 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/activity-plans",
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>',
'defaultDescriptionTemplate' => '<string>',
'defaultTitleTemplate' => '<string>',
'deprecated' => true,
'description' => '<string>',
'documentFamilyGroups' => null,
'documentSummarizationPrompt' => '<string>',
'documentValidationPrompt' => '<string>',
'extensionPackRef' => '<string>',
'inputOptions' => null,
'inputsSchema' => null,
'knowledgeAgent' => true,
'metadata' => null,
'name' => '<string>',
'orgSlug' => '<string>',
'organization' => [
'id' => '<string>'
],
'organizationId' => '<string>',
'publicAccess' => true,
'ref' => '<string>',
'steps' => null,
'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/activity-plans"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"defaultDescriptionTemplate\": \"<string>\",\n \"defaultTitleTemplate\": \"<string>\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"documentFamilyGroups\": null,\n \"documentSummarizationPrompt\": \"<string>\",\n \"documentValidationPrompt\": \"<string>\",\n \"extensionPackRef\": \"<string>\",\n \"inputOptions\": null,\n \"inputsSchema\": null,\n \"knowledgeAgent\": true,\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 \"steps\": null,\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/activity-plans")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"defaultDescriptionTemplate\": \"<string>\",\n \"defaultTitleTemplate\": \"<string>\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"documentFamilyGroups\": null,\n \"documentSummarizationPrompt\": \"<string>\",\n \"documentValidationPrompt\": \"<string>\",\n \"extensionPackRef\": \"<string>\",\n \"inputOptions\": null,\n \"inputsSchema\": null,\n \"knowledgeAgent\": true,\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 \"steps\": null,\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/activity-plans")
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 \"defaultDescriptionTemplate\": \"<string>\",\n \"defaultTitleTemplate\": \"<string>\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"documentFamilyGroups\": null,\n \"documentSummarizationPrompt\": \"<string>\",\n \"documentValidationPrompt\": \"<string>\",\n \"extensionPackRef\": \"<string>\",\n \"inputOptions\": null,\n \"inputsSchema\": null,\n \"knowledgeAgent\": true,\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 \"steps\": null,\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,
"description": "<string>",
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"steps": null,
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"defaultDescriptionTemplate": "<string>",
"defaultTitleTemplate": "<string>",
"deleteUserEmail": "<string>",
"deleteUserId": "<string>",
"deletedDate": "2023-11-07T05:31:56Z",
"documentFamilyGroups": null,
"documentSummarizationPrompt": "<string>",
"documentValidationPrompt": "<string>",
"extensionPackRef": "<string>",
"inputOptions": null,
"inputsSchema": null,
"knowledgeAgent": true,
"metadata": null,
"orgSlug": "<string>",
"organization": {
"id": "<string>"
},
"ref": "<string>",
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}ActivityPlans
Create ActivityPlan
Creates a new ActivityPlan. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.
POST
/
api
/
activity-plans
Create ActivityPlan
curl --request POST \
--url https://platform.kodexa.ai/api/activity-plans \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"slug": "<string>",
"defaultDescriptionTemplate": "<string>",
"defaultTitleTemplate": "<string>",
"deprecated": true,
"description": "<string>",
"documentFamilyGroups": null,
"documentSummarizationPrompt": "<string>",
"documentValidationPrompt": "<string>",
"extensionPackRef": "<string>",
"inputOptions": null,
"inputsSchema": null,
"knowledgeAgent": true,
"metadata": null,
"name": "<string>",
"orgSlug": "<string>",
"organization": {
"id": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"ref": "<string>",
"steps": null,
"template": true,
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/activity-plans"
payload = {
"slug": "<string>",
"defaultDescriptionTemplate": "<string>",
"defaultTitleTemplate": "<string>",
"deprecated": True,
"description": "<string>",
"documentFamilyGroups": None,
"documentSummarizationPrompt": "<string>",
"documentValidationPrompt": "<string>",
"extensionPackRef": "<string>",
"inputOptions": None,
"inputsSchema": None,
"knowledgeAgent": True,
"metadata": None,
"name": "<string>",
"orgSlug": "<string>",
"organization": { "id": "<string>" },
"organizationId": "<string>",
"publicAccess": True,
"ref": "<string>",
"steps": None,
"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>',
defaultDescriptionTemplate: '<string>',
defaultTitleTemplate: '<string>',
deprecated: true,
description: '<string>',
documentFamilyGroups: null,
documentSummarizationPrompt: '<string>',
documentValidationPrompt: '<string>',
extensionPackRef: '<string>',
inputOptions: null,
inputsSchema: null,
knowledgeAgent: true,
metadata: null,
name: '<string>',
orgSlug: '<string>',
organization: {id: '<string>'},
organizationId: '<string>',
publicAccess: true,
ref: '<string>',
steps: null,
template: true,
type: '<string>',
uri: '<string>',
yamlSource: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/activity-plans', 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/activity-plans",
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>',
'defaultDescriptionTemplate' => '<string>',
'defaultTitleTemplate' => '<string>',
'deprecated' => true,
'description' => '<string>',
'documentFamilyGroups' => null,
'documentSummarizationPrompt' => '<string>',
'documentValidationPrompt' => '<string>',
'extensionPackRef' => '<string>',
'inputOptions' => null,
'inputsSchema' => null,
'knowledgeAgent' => true,
'metadata' => null,
'name' => '<string>',
'orgSlug' => '<string>',
'organization' => [
'id' => '<string>'
],
'organizationId' => '<string>',
'publicAccess' => true,
'ref' => '<string>',
'steps' => null,
'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/activity-plans"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"defaultDescriptionTemplate\": \"<string>\",\n \"defaultTitleTemplate\": \"<string>\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"documentFamilyGroups\": null,\n \"documentSummarizationPrompt\": \"<string>\",\n \"documentValidationPrompt\": \"<string>\",\n \"extensionPackRef\": \"<string>\",\n \"inputOptions\": null,\n \"inputsSchema\": null,\n \"knowledgeAgent\": true,\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 \"steps\": null,\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/activity-plans")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"defaultDescriptionTemplate\": \"<string>\",\n \"defaultTitleTemplate\": \"<string>\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"documentFamilyGroups\": null,\n \"documentSummarizationPrompt\": \"<string>\",\n \"documentValidationPrompt\": \"<string>\",\n \"extensionPackRef\": \"<string>\",\n \"inputOptions\": null,\n \"inputsSchema\": null,\n \"knowledgeAgent\": true,\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 \"steps\": null,\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/activity-plans")
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 \"defaultDescriptionTemplate\": \"<string>\",\n \"defaultTitleTemplate\": \"<string>\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"documentFamilyGroups\": null,\n \"documentSummarizationPrompt\": \"<string>\",\n \"documentValidationPrompt\": \"<string>\",\n \"extensionPackRef\": \"<string>\",\n \"inputOptions\": null,\n \"inputsSchema\": null,\n \"knowledgeAgent\": true,\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 \"steps\": null,\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,
"description": "<string>",
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"steps": null,
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"defaultDescriptionTemplate": "<string>",
"defaultTitleTemplate": "<string>",
"deleteUserEmail": "<string>",
"deleteUserId": "<string>",
"deletedDate": "2023-11-07T05:31:56Z",
"documentFamilyGroups": null,
"documentSummarizationPrompt": "<string>",
"documentValidationPrompt": "<string>",
"extensionPackRef": "<string>",
"inputOptions": null,
"inputsSchema": null,
"knowledgeAgent": true,
"metadata": null,
"orgSlug": "<string>",
"organization": {
"id": "<string>"
},
"ref": "<string>",
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
application/json
Show child attributes
Show child attributes
Computed resource URI (scheme://orgSlug/slug), present on serialized responses.
Response
Created ActivityPlan
Show child attributes
Show child attributes
Computed resource URI (scheme://orgSlug/slug), present on serialized responses.