curl --request POST \
--url http://localhost:3000/api/v1/bases/props/add \
--header 'Content-Type: application/json' \
--data '
{
"base": "<string>",
"name": "<string>",
"agent": "<string>",
"approvers": "<string>",
"config": "<string>",
"console": "<string>",
"description": "<string>",
"expectedSchemaVersion": "<string>",
"idempotencyKey": "<string>",
"inputs": "<string>",
"instructions": "<string>",
"key": "<string>",
"options": "<string>",
"output": "<string>",
"position": "<string>",
"project": "<string>",
"required": true,
"resetOn": "<string>",
"type": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/bases/props/add"
payload = {
"base": "<string>",
"name": "<string>",
"agent": "<string>",
"approvers": "<string>",
"config": "<string>",
"console": "<string>",
"description": "<string>",
"expectedSchemaVersion": "<string>",
"idempotencyKey": "<string>",
"inputs": "<string>",
"instructions": "<string>",
"key": "<string>",
"options": "<string>",
"output": "<string>",
"position": "<string>",
"project": "<string>",
"required": True,
"resetOn": "<string>",
"type": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
base: '<string>',
name: '<string>',
agent: '<string>',
approvers: '<string>',
config: '<string>',
console: '<string>',
description: '<string>',
expectedSchemaVersion: '<string>',
idempotencyKey: '<string>',
inputs: '<string>',
instructions: '<string>',
key: '<string>',
options: '<string>',
output: '<string>',
position: '<string>',
project: '<string>',
required: true,
resetOn: '<string>',
type: '<string>'
})
};
fetch('http://localhost:3000/api/v1/bases/props/add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/bases/props/add",
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([
'base' => '<string>',
'name' => '<string>',
'agent' => '<string>',
'approvers' => '<string>',
'config' => '<string>',
'console' => '<string>',
'description' => '<string>',
'expectedSchemaVersion' => '<string>',
'idempotencyKey' => '<string>',
'inputs' => '<string>',
'instructions' => '<string>',
'key' => '<string>',
'options' => '<string>',
'output' => '<string>',
'position' => '<string>',
'project' => '<string>',
'required' => true,
'resetOn' => '<string>',
'type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://localhost:3000/api/v1/bases/props/add"
payload := strings.NewReader("{\n \"base\": \"<string>\",\n \"name\": \"<string>\",\n \"agent\": \"<string>\",\n \"approvers\": \"<string>\",\n \"config\": \"<string>\",\n \"console\": \"<string>\",\n \"description\": \"<string>\",\n \"expectedSchemaVersion\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"inputs\": \"<string>\",\n \"instructions\": \"<string>\",\n \"key\": \"<string>\",\n \"options\": \"<string>\",\n \"output\": \"<string>\",\n \"position\": \"<string>\",\n \"project\": \"<string>\",\n \"required\": true,\n \"resetOn\": \"<string>\",\n \"type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/bases/props/add")
.header("Content-Type", "application/json")
.body("{\n \"base\": \"<string>\",\n \"name\": \"<string>\",\n \"agent\": \"<string>\",\n \"approvers\": \"<string>\",\n \"config\": \"<string>\",\n \"console\": \"<string>\",\n \"description\": \"<string>\",\n \"expectedSchemaVersion\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"inputs\": \"<string>\",\n \"instructions\": \"<string>\",\n \"key\": \"<string>\",\n \"options\": \"<string>\",\n \"output\": \"<string>\",\n \"position\": \"<string>\",\n \"project\": \"<string>\",\n \"required\": true,\n \"resetOn\": \"<string>\",\n \"type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/bases/props/add")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"base\": \"<string>\",\n \"name\": \"<string>\",\n \"agent\": \"<string>\",\n \"approvers\": \"<string>\",\n \"config\": \"<string>\",\n \"console\": \"<string>\",\n \"description\": \"<string>\",\n \"expectedSchemaVersion\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"inputs\": \"<string>\",\n \"instructions\": \"<string>\",\n \"key\": \"<string>\",\n \"options\": \"<string>\",\n \"output\": \"<string>\",\n \"position\": \"<string>\",\n \"project\": \"<string>\",\n \"required\": true,\n \"resetOn\": \"<string>\",\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"base": {
"capabilities": {
"manage": true,
"readDirect": true,
"writeDirect": true
},
"createdAt": "<string>",
"description": "<string>",
"icon": "<string>",
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"rowCount": 123,
"schemaVersion": 123,
"slug": "<string>",
"status": "<string>",
"timezone": "<string>",
"updatedAt": "<string>",
"version": 123
},
"consoleUrl": "<string>",
"idempotencyKey": "<string>",
"projectRef": "<string>",
"property": {
"config": {
"agent": "<string>",
"approvers": [
{
"kind": "<string>",
"minRole": "<string>",
"userId": "<string>"
}
],
"currency": "<string>",
"format": "<string>",
"includeTime": true,
"inputs": [
"<string>"
],
"instructions": "<string>",
"options": [
{
"color": "<string>",
"id": "<string>",
"name": "<string>",
"archived": true,
"group": "<string>"
}
],
"output": "<string>",
"precision": 123,
"resetOn": [
"<string>"
]
},
"deletedAt": "<string>",
"description": "<string>",
"id": "<string>",
"key": "<string>",
"name": "<string>",
"position": 123,
"required": true,
"type": "<string>"
},
"report": {
"activeRows": 123,
"cleared": 123,
"converted": 123,
"dependents": {
"charts": [
{
"id": "<string>",
"name": "<string>"
}
],
"views": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"dryRun": true,
"missing": 123
},
"success": true
}Add a property to a base
curl --request POST \
--url http://localhost:3000/api/v1/bases/props/add \
--header 'Content-Type: application/json' \
--data '
{
"base": "<string>",
"name": "<string>",
"agent": "<string>",
"approvers": "<string>",
"config": "<string>",
"console": "<string>",
"description": "<string>",
"expectedSchemaVersion": "<string>",
"idempotencyKey": "<string>",
"inputs": "<string>",
"instructions": "<string>",
"key": "<string>",
"options": "<string>",
"output": "<string>",
"position": "<string>",
"project": "<string>",
"required": true,
"resetOn": "<string>",
"type": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/bases/props/add"
payload = {
"base": "<string>",
"name": "<string>",
"agent": "<string>",
"approvers": "<string>",
"config": "<string>",
"console": "<string>",
"description": "<string>",
"expectedSchemaVersion": "<string>",
"idempotencyKey": "<string>",
"inputs": "<string>",
"instructions": "<string>",
"key": "<string>",
"options": "<string>",
"output": "<string>",
"position": "<string>",
"project": "<string>",
"required": True,
"resetOn": "<string>",
"type": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
base: '<string>',
name: '<string>',
agent: '<string>',
approvers: '<string>',
config: '<string>',
console: '<string>',
description: '<string>',
expectedSchemaVersion: '<string>',
idempotencyKey: '<string>',
inputs: '<string>',
instructions: '<string>',
key: '<string>',
options: '<string>',
output: '<string>',
position: '<string>',
project: '<string>',
required: true,
resetOn: '<string>',
type: '<string>'
})
};
fetch('http://localhost:3000/api/v1/bases/props/add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/bases/props/add",
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([
'base' => '<string>',
'name' => '<string>',
'agent' => '<string>',
'approvers' => '<string>',
'config' => '<string>',
'console' => '<string>',
'description' => '<string>',
'expectedSchemaVersion' => '<string>',
'idempotencyKey' => '<string>',
'inputs' => '<string>',
'instructions' => '<string>',
'key' => '<string>',
'options' => '<string>',
'output' => '<string>',
'position' => '<string>',
'project' => '<string>',
'required' => true,
'resetOn' => '<string>',
'type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://localhost:3000/api/v1/bases/props/add"
payload := strings.NewReader("{\n \"base\": \"<string>\",\n \"name\": \"<string>\",\n \"agent\": \"<string>\",\n \"approvers\": \"<string>\",\n \"config\": \"<string>\",\n \"console\": \"<string>\",\n \"description\": \"<string>\",\n \"expectedSchemaVersion\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"inputs\": \"<string>\",\n \"instructions\": \"<string>\",\n \"key\": \"<string>\",\n \"options\": \"<string>\",\n \"output\": \"<string>\",\n \"position\": \"<string>\",\n \"project\": \"<string>\",\n \"required\": true,\n \"resetOn\": \"<string>\",\n \"type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/bases/props/add")
.header("Content-Type", "application/json")
.body("{\n \"base\": \"<string>\",\n \"name\": \"<string>\",\n \"agent\": \"<string>\",\n \"approvers\": \"<string>\",\n \"config\": \"<string>\",\n \"console\": \"<string>\",\n \"description\": \"<string>\",\n \"expectedSchemaVersion\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"inputs\": \"<string>\",\n \"instructions\": \"<string>\",\n \"key\": \"<string>\",\n \"options\": \"<string>\",\n \"output\": \"<string>\",\n \"position\": \"<string>\",\n \"project\": \"<string>\",\n \"required\": true,\n \"resetOn\": \"<string>\",\n \"type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/bases/props/add")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"base\": \"<string>\",\n \"name\": \"<string>\",\n \"agent\": \"<string>\",\n \"approvers\": \"<string>\",\n \"config\": \"<string>\",\n \"console\": \"<string>\",\n \"description\": \"<string>\",\n \"expectedSchemaVersion\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"inputs\": \"<string>\",\n \"instructions\": \"<string>\",\n \"key\": \"<string>\",\n \"options\": \"<string>\",\n \"output\": \"<string>\",\n \"position\": \"<string>\",\n \"project\": \"<string>\",\n \"required\": true,\n \"resetOn\": \"<string>\",\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"base": {
"capabilities": {
"manage": true,
"readDirect": true,
"writeDirect": true
},
"createdAt": "<string>",
"description": "<string>",
"icon": "<string>",
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"rowCount": 123,
"schemaVersion": 123,
"slug": "<string>",
"status": "<string>",
"timezone": "<string>",
"updatedAt": "<string>",
"version": 123
},
"consoleUrl": "<string>",
"idempotencyKey": "<string>",
"projectRef": "<string>",
"property": {
"config": {
"agent": "<string>",
"approvers": [
{
"kind": "<string>",
"minRole": "<string>",
"userId": "<string>"
}
],
"currency": "<string>",
"format": "<string>",
"includeTime": true,
"inputs": [
"<string>"
],
"instructions": "<string>",
"options": [
{
"color": "<string>",
"id": "<string>",
"name": "<string>",
"archived": true,
"group": "<string>"
}
],
"output": "<string>",
"precision": 123,
"resetOn": [
"<string>"
]
},
"deletedAt": "<string>",
"description": "<string>",
"id": "<string>",
"key": "<string>",
"name": "<string>",
"position": 123,
"required": true,
"type": "<string>"
},
"report": {
"activeRows": 123,
"cleared": 123,
"converted": 123,
"dependents": {
"charts": [
{
"id": "<string>",
"name": "<string>"
}
],
"views": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"dryRun": true,
"missing": 123
},
"success": true
}Body
Base id or slug
Property display name
Agent column: the agent that fills it (a label, max 64)
Approval: who decides, comma-separated role:<viewer|developer|project_admin> or user: (1-20)
Property config JSON (options, format, includeTime...)
Console base URL
Property description
Schema version you read (default: read the current one first)
Idempotency key: a retry with the same key and request returns the created object (default: generated)
Agent column: property keys the agent reads (1-20)
Agent column: what the agent fills (1-4000 chars)
API key, ^[a-z][a-z0-9_]{0,62}$ (default: derived from the name)
Select/status options (or an agent column's select output), comma-separated; status groups as Name:todo|in_progress|done
Agent column: value type text|number|checkbox|select|multi_select|url|date
Column position
Console project id or slug; overrides the saved Console scope
Require a value on create and on updates that touch it
Approval: property keys whose change sends a decided approval back to pending
text|number|checkbox|date|select|multi_select|status|url|email|phone|person|ref|approval|agent (default: text)