curl --request POST \
--url https://allocait.app/api/v1/inputs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"display_mode": "TIME_SERIES",
"description": "<string>",
"color": "<string>",
"scope": "PORTFOLIO",
"chart_role": "STANDALONE",
"carry_forward": false,
"optional": false,
"emphasis": "none",
"options": [
"<string>"
]
}
'import requests
url = "https://allocait.app/api/v1/inputs"
payload = {
"name": "<string>",
"display_mode": "TIME_SERIES",
"description": "<string>",
"color": "<string>",
"scope": "PORTFOLIO",
"chart_role": "STANDALONE",
"carry_forward": False,
"optional": False,
"emphasis": "none",
"options": ["<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({
name: '<string>',
display_mode: 'TIME_SERIES',
description: '<string>',
color: '<string>',
scope: 'PORTFOLIO',
chart_role: 'STANDALONE',
carry_forward: false,
optional: false,
emphasis: 'none',
options: ['<string>']
})
};
fetch('https://allocait.app/api/v1/inputs', 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://allocait.app/api/v1/inputs",
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([
'name' => '<string>',
'display_mode' => 'TIME_SERIES',
'description' => '<string>',
'color' => '<string>',
'scope' => 'PORTFOLIO',
'chart_role' => 'STANDALONE',
'carry_forward' => false,
'optional' => false,
'emphasis' => 'none',
'options' => [
'<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://allocait.app/api/v1/inputs"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"display_mode\": \"TIME_SERIES\",\n \"description\": \"<string>\",\n \"color\": \"<string>\",\n \"scope\": \"PORTFOLIO\",\n \"chart_role\": \"STANDALONE\",\n \"carry_forward\": false,\n \"optional\": false,\n \"emphasis\": \"none\",\n \"options\": [\n \"<string>\"\n ]\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://allocait.app/api/v1/inputs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"display_mode\": \"TIME_SERIES\",\n \"description\": \"<string>\",\n \"color\": \"<string>\",\n \"scope\": \"PORTFOLIO\",\n \"chart_role\": \"STANDALONE\",\n \"carry_forward\": false,\n \"optional\": false,\n \"emphasis\": \"none\",\n \"options\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://allocait.app/api/v1/inputs")
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 \"name\": \"<string>\",\n \"display_mode\": \"TIME_SERIES\",\n \"description\": \"<string>\",\n \"color\": \"<string>\",\n \"scope\": \"PORTFOLIO\",\n \"chart_role\": \"STANDALONE\",\n \"carry_forward\": false,\n \"optional\": false,\n \"emphasis\": \"none\",\n \"options\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"definition": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"data_type": "PERCENTAGE",
"display_mode": "TIME_SERIES",
"description": "<string>",
"color": "<string>",
"scope": "PORTFOLIO",
"chart_role": "OVERLAY",
"carry_forward": true,
"optional": true,
"emphasis": "none",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "Portfolio not found or access denied",
"error_code": "NOT_FOUND"
}{
"error": "Portfolio not found or access denied",
"error_code": "NOT_FOUND"
}{
"error": "Portfolio not found or access denied",
"error_code": "NOT_FOUND"
}{
"error": "Portfolio not found or access denied",
"error_code": "NOT_FOUND"
}{
"error": "Portfolio not found or access denied",
"error_code": "NOT_FOUND"
}{
"error": "Internal error",
"error_code": "INTERNAL_ERROR",
"request_id": "5b1e7c52-3f4a-4d0e-9a55-2d5cbe6f0a11"
}Create an Input (tracked-value) definition
Defines a new tracked value’s shape (name, data_type, display_mode,
scope, chart_role, color, carry_forward, optional) and, for a CHOICE input, its
options in the same transaction. Requires the data_charts feature
entitlement (an Advanced plan, trial included). Complements
POST /inputs/entries, which only records values against a
definition that already exists.
scope (default PORTFOLIO) decides whether every recorded value
needs a symbol (SYMBOL) or none may have one (PORTFOLIO).
chart_role (default STANDALONE) is only ever OVERLAY when
scope is SYMBOL (ADR-013). Allocait rejects an OVERLAY on a
portfolio-wide value rather than let it share an incompatible scale
with a symbol’s price chart.
carry_forward (default false) is “keep until changed”. A
playbook shows a kept Input’s latest value on or before the date it
is read for, flagged carried when that value was recorded earlier.
The setting changes how a playbook reads; it never copies a value.
optional (default false) leaves the Input’s blank cells out of a
playbook’s needs_input (ADR-189). A recorded value is read as for any
Input.
emphasis (default none) is the change against the previous entry a
playbook marks: lower, higher, not_higher or not_lower (ADR-198).
NUMBER, DECIMAL and PERCENTAGE Inputs only; any other Input with a
setting is refused as INVALID_INPUT.
Requires the API key to have the write permission.
curl --request POST \
--url https://allocait.app/api/v1/inputs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"display_mode": "TIME_SERIES",
"description": "<string>",
"color": "<string>",
"scope": "PORTFOLIO",
"chart_role": "STANDALONE",
"carry_forward": false,
"optional": false,
"emphasis": "none",
"options": [
"<string>"
]
}
'import requests
url = "https://allocait.app/api/v1/inputs"
payload = {
"name": "<string>",
"display_mode": "TIME_SERIES",
"description": "<string>",
"color": "<string>",
"scope": "PORTFOLIO",
"chart_role": "STANDALONE",
"carry_forward": False,
"optional": False,
"emphasis": "none",
"options": ["<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({
name: '<string>',
display_mode: 'TIME_SERIES',
description: '<string>',
color: '<string>',
scope: 'PORTFOLIO',
chart_role: 'STANDALONE',
carry_forward: false,
optional: false,
emphasis: 'none',
options: ['<string>']
})
};
fetch('https://allocait.app/api/v1/inputs', 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://allocait.app/api/v1/inputs",
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([
'name' => '<string>',
'display_mode' => 'TIME_SERIES',
'description' => '<string>',
'color' => '<string>',
'scope' => 'PORTFOLIO',
'chart_role' => 'STANDALONE',
'carry_forward' => false,
'optional' => false,
'emphasis' => 'none',
'options' => [
'<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://allocait.app/api/v1/inputs"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"display_mode\": \"TIME_SERIES\",\n \"description\": \"<string>\",\n \"color\": \"<string>\",\n \"scope\": \"PORTFOLIO\",\n \"chart_role\": \"STANDALONE\",\n \"carry_forward\": false,\n \"optional\": false,\n \"emphasis\": \"none\",\n \"options\": [\n \"<string>\"\n ]\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://allocait.app/api/v1/inputs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"display_mode\": \"TIME_SERIES\",\n \"description\": \"<string>\",\n \"color\": \"<string>\",\n \"scope\": \"PORTFOLIO\",\n \"chart_role\": \"STANDALONE\",\n \"carry_forward\": false,\n \"optional\": false,\n \"emphasis\": \"none\",\n \"options\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://allocait.app/api/v1/inputs")
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 \"name\": \"<string>\",\n \"display_mode\": \"TIME_SERIES\",\n \"description\": \"<string>\",\n \"color\": \"<string>\",\n \"scope\": \"PORTFOLIO\",\n \"chart_role\": \"STANDALONE\",\n \"carry_forward\": false,\n \"optional\": false,\n \"emphasis\": \"none\",\n \"options\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"definition": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"data_type": "PERCENTAGE",
"display_mode": "TIME_SERIES",
"description": "<string>",
"color": "<string>",
"scope": "PORTFOLIO",
"chart_role": "OVERLAY",
"carry_forward": true,
"optional": true,
"emphasis": "none",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "Portfolio not found or access denied",
"error_code": "NOT_FOUND"
}{
"error": "Portfolio not found or access denied",
"error_code": "NOT_FOUND"
}{
"error": "Portfolio not found or access denied",
"error_code": "NOT_FOUND"
}{
"error": "Portfolio not found or access denied",
"error_code": "NOT_FOUND"
}{
"error": "Portfolio not found or access denied",
"error_code": "NOT_FOUND"
}{
"error": "Internal error",
"error_code": "INTERNAL_ERROR",
"request_id": "5b1e7c52-3f4a-4d0e-9a55-2d5cbe6f0a11"
}Authorizations
Raw API key shown once when created in the Allocait app (Settings > API keys). Send it verbatim in this header; the server stores and compares only its SHA-256 hash. Allocait generates every key: alc_ followed by 64 lowercase hex characters. Keys issued before 2026-10-10 are 64 hex characters with no prefix and keep working. A key may carry an expiry (90 days or 1 year, or never). A malformed, unknown, revoked or expired key gets 401 with no further detail, and a malformed one is refused before any lookup. Keys cannot be created through this API.
Body
PERCENTAGE, DECIMAL, NUMBER, TEXT, CHOICE TIME_SERIES, LEVEL_MARKER PORTFOLIO, SYMBOL OVERLAY, STANDALONE Keep until changed. A playbook shows this Input's latest value on or before the date it is read for.
Optional. A playbook leaves this Input's blank cells out of needs_input.
Which change against the previous entry a playbook marks. NUMBER, DECIMAL and PERCENTAGE Inputs only.
none, lower, higher, not_higher, not_lower A CHOICE input's options, in display order.
Response
The Input definition was created. With options, the response is the InputSaveResponse shape that PUT /inputs/{id} returns.