Skip to main content
POST
/
v4
/
schemas
/
Create new schema
curl --request POST \
  --url https://api.kadoa.com/v4/schemas/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "fields": [
    {
      "name": "<string>",
      "description": "<string>",
      "instruction": "<string>",
      "fieldType": "SCHEMA",
      "example": "<string>",
      "shape": "<unknown>",
      "isKey": true
    }
  ],
  "entity": "<string>"
}
'
import requests

url = "https://api.kadoa.com/v4/schemas/"

payload = {
"name": "<string>",
"fields": [
{
"name": "<string>",
"description": "<string>",
"instruction": "<string>",
"fieldType": "SCHEMA",
"example": "<string>",
"shape": "<unknown>",
"isKey": True
}
],
"entity": "<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>',
fields: [
{
name: '<string>',
description: '<string>',
instruction: '<string>',
fieldType: 'SCHEMA',
example: '<string>',
shape: '<unknown>',
isKey: true
}
],
entity: '<string>'
})
};

fetch('https://api.kadoa.com/v4/schemas/', 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/schemas/",
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>',
'fields' => [
[
'name' => '<string>',
'description' => '<string>',
'instruction' => '<string>',
'fieldType' => 'SCHEMA',
'example' => '<string>',
'shape' => '<unknown>',
'isKey' => true
]
],
'entity' => '<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://api.kadoa.com/v4/schemas/"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instruction\": \"<string>\",\n \"fieldType\": \"SCHEMA\",\n \"example\": \"<string>\",\n \"shape\": \"<unknown>\",\n \"isKey\": true\n }\n ],\n \"entity\": \"<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://api.kadoa.com/v4/schemas/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instruction\": \"<string>\",\n \"fieldType\": \"SCHEMA\",\n \"example\": \"<string>\",\n \"shape\": \"<unknown>\",\n \"isKey\": true\n }\n ],\n \"entity\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.kadoa.com/v4/schemas/")

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 \"fields\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instruction\": \"<string>\",\n \"fieldType\": \"SCHEMA\",\n \"example\": \"<string>\",\n \"shape\": \"<unknown>\",\n \"isKey\": true\n }\n ],\n \"entity\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "error": false,
  "success": true,
  "schemaId": "<string>",
  "message": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}
{
"error": true,
"message": "<string>",
"details": "<unknown>"
}
{
"error": true,
"message": "<string>",
"details": "<unknown>"
}
{
"error": true,
"message": "<string>",
"details": "<unknown>"
}

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json

Body

Request body for creating a new schema

name
string
required

Name of the schema

Required string length: 1 - 255
fields
(DataField · object | ClassificationField · object)[]
required

Schema fields for extraction - choose from Data Field (typed data) or Classification Field

Minimum array length: 1

Extraction field schema

entity
string

Entity type for the schema

Minimum string length: 1

Response

201

Response for schema creation

error
enum<boolean>
required

Error flag (always false on success)

Available options:
false
success
boolean
required

Success flag

schemaId
string
required

ID of the created schema

message
string
required

Success message

createdAt
string

Creation timestamp

updatedAt
string

Last update timestamp