Propose destination column types from preview rows
curl --request POST \
--url http://localhost:8080/api/v1/pipeline/propose-schema \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"records": [
{}
],
"columns": [
"<string>"
]
}
'import requests
url = "http://localhost:8080/api/v1/pipeline/propose-schema"
payload = {
"records": [{}],
"columns": ["<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({records: [{}], columns: ['<string>']})
};
fetch('http://localhost:8080/api/v1/pipeline/propose-schema', 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 => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/pipeline/propose-schema",
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([
'records' => [
[
]
],
'columns' => [
'<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 := "http://localhost:8080/api/v1/pipeline/propose-schema"
payload := strings.NewReader("{\n \"records\": [\n {}\n ],\n \"columns\": [\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("http://localhost:8080/api/v1/pipeline/propose-schema")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"records\": [\n {}\n ],\n \"columns\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/pipeline/propose-schema")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"records\": [\n {}\n ],\n \"columns\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"eligible": true,
"sampleRowCount": 123,
"fields": [
{
"name": "<string>",
"type": "string",
"samples": [
"<string>"
],
"stringReason": {
"value": "<string>",
"blocked": "<string>"
},
"note": "<string>"
}
]
}Pipelines
Propose destination column types from preview rows
Stateless type inference over rows you post, typically a tap’s test preview, before any pipeline exists. Uses the same deterministic inference as GET /api/v1/pipeline/dest-types but is more cautious: a column needs at least 5 non-null typed values to be typed. Below that, or when every value is null, the column stays string and carries a note (for example “2 non-null values in 20 rows; would be int”). A dirty value keeps the column string and reports it in stringReason. Nothing is read from a destination and nothing is stored.
POST
/
api
/
v1
/
pipeline
/
propose-schema
Propose destination column types from preview rows
curl --request POST \
--url http://localhost:8080/api/v1/pipeline/propose-schema \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"records": [
{}
],
"columns": [
"<string>"
]
}
'import requests
url = "http://localhost:8080/api/v1/pipeline/propose-schema"
payload = {
"records": [{}],
"columns": ["<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({records: [{}], columns: ['<string>']})
};
fetch('http://localhost:8080/api/v1/pipeline/propose-schema', 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 => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/pipeline/propose-schema",
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([
'records' => [
[
]
],
'columns' => [
'<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 := "http://localhost:8080/api/v1/pipeline/propose-schema"
payload := strings.NewReader("{\n \"records\": [\n {}\n ],\n \"columns\": [\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("http://localhost:8080/api/v1/pipeline/propose-schema")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"records\": [\n {}\n ],\n \"columns\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/pipeline/propose-schema")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"records\": [\n {}\n ],\n \"columns\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"eligible": true,
"sampleRowCount": 123,
"fields": [
{
"name": "<string>",
"type": "string",
"samples": [
"<string>"
],
"stringReason": {
"value": "<string>",
"blocked": "<string>"
},
"note": "<string>"
}
]
}Authorizations
Body
application/json
