Skip to main content
POST
/
orgs
/
{org_id}
/
connectors
/
{connector_id}
/
syncs
`POST /orgs/{org_id}/connectors/{connector_id}/syncs`
curl --request POST \
  --url https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/syncs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dest_table": "<string>",
  "interval_secs": 123,
  "kb_id": 123,
  "source": {
    "connection_ref": "<string>",
    "cursor_column": "<string>",
    "table": "<string>",
    "kind": "postgres",
    "columns": [
      "<string>"
    ],
    "schema": "<string>"
  },
  "name": "<string>"
}
'
import requests

url = "https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/syncs"

payload = {
"dest_table": "<string>",
"interval_secs": 123,
"kb_id": 123,
"source": {
"connection_ref": "<string>",
"cursor_column": "<string>",
"table": "<string>",
"kind": "postgres",
"columns": ["<string>"],
"schema": "<string>"
},
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dest_table: '<string>',
interval_secs: 123,
kb_id: 123,
source: {
connection_ref: '<string>',
cursor_column: '<string>',
table: '<string>',
kind: 'postgres',
columns: ['<string>'],
schema: '<string>'
},
name: '<string>'
})
};

fetch('https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/syncs', 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.timbal.ai/orgs/{org_id}/connectors/{connector_id}/syncs",
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([
'dest_table' => '<string>',
'interval_secs' => 123,
'kb_id' => 123,
'source' => [
'connection_ref' => '<string>',
'cursor_column' => '<string>',
'table' => '<string>',
'kind' => 'postgres',
'columns' => [
'<string>'
],
'schema' => '<string>'
],
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/syncs"

payload := strings.NewReader("{\n \"dest_table\": \"<string>\",\n \"interval_secs\": 123,\n \"kb_id\": 123,\n \"source\": {\n \"connection_ref\": \"<string>\",\n \"cursor_column\": \"<string>\",\n \"table\": \"<string>\",\n \"kind\": \"postgres\",\n \"columns\": [\n \"<string>\"\n ],\n \"schema\": \"<string>\"\n },\n \"name\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
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.timbal.ai/orgs/{org_id}/connectors/{connector_id}/syncs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dest_table\": \"<string>\",\n \"interval_secs\": 123,\n \"kb_id\": 123,\n \"source\": {\n \"connection_ref\": \"<string>\",\n \"cursor_column\": \"<string>\",\n \"table\": \"<string>\",\n \"kind\": \"postgres\",\n \"columns\": [\n \"<string>\"\n ],\n \"schema\": \"<string>\"\n },\n \"name\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.timbal.ai/orgs/{org_id}/connectors/{connector_id}/syncs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dest_table\": \"<string>\",\n \"interval_secs\": 123,\n \"kb_id\": 123,\n \"source\": {\n \"connection_ref\": \"<string>\",\n \"cursor_column\": \"<string>\",\n \"table\": \"<string>\",\n \"kind\": \"postgres\",\n \"columns\": [\n \"<string>\"\n ],\n \"schema\": \"<string>\"\n },\n \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "sync_id": "<string>"
}

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required
connector_id
string
required

Body

application/json
dest_table
string
required

Destination table inside the KB. Must not pre-exist: the first run creates it, later runs append.

interval_secs
integer<int64>
required

Seconds between run starts. The scheduler ticks every 30s, so smaller values effectively mean "every tick".

kb_id
integer<int64>
required

Target KB (numeric id, same as the /k2 routes).

source
object
required

The source half of a dispatch, tagged by kind. Each variant maps to a SourceSpec and gates on the connector advertising the matching source:<kind> capability. Request shape: "source": { "kind": "sql_server", "connection_ref": "...", "table": "...", "cursor_column": "..." }.

name
string | null

Operator label.

Response

Sync created

sync_id
string
required