curl --request POST \
--url http://localhost:8080/api/v1/tap/run \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"mode": "test",
"params": {
"since": "2026-05-01",
"until": "2026-05-02"
}
}
'import requests
url = "http://localhost:8080/api/v1/tap/run"
payload = {
"name": "<string>",
"mode": "test",
"params": {
"since": "2026-05-01",
"until": "2026-05-02"
}
}
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>',
mode: 'test',
params: {since: '2026-05-01', until: '2026-05-02'}
})
};
fetch('http://localhost:8080/api/v1/tap/run', 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/tap/run",
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>',
'mode' => 'test',
'params' => [
'since' => '2026-05-01',
'until' => '2026-05-02'
]
]),
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/tap/run"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"mode\": \"test\",\n \"params\": {\n \"since\": \"2026-05-01\",\n \"until\": \"2026-05-02\"\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/tap/run")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"mode\": \"test\",\n \"params\": {\n \"since\": \"2026-05-01\",\n \"until\": \"2026-05-02\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/tap/run")
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 \"name\": \"<string>\",\n \"mode\": \"test\",\n \"params\": {\n \"since\": \"2026-05-01\",\n \"until\": \"2026-05-02\"\n }\n}"
response = http.request(request)
puts response.read_body{
"tap": "<string>",
"description": "<string>",
"status": "success",
"mode": "run",
"targetPipeline": "<string>",
"persisted": true,
"persistedReason": "test_mode",
"publisherToken": "<string>",
"pipelineTokens": [
"<string>"
],
"records": [
{}
],
"recordCount": 123,
"dataType": "<string>",
"columns": [
"<string>"
],
"logs": "<string>",
"error": "<string>",
"aiExplanation": "<string>"
}Run a tap
Executes a saved tap. Optionally sends data to the configured pipeline.
curl --request POST \
--url http://localhost:8080/api/v1/tap/run \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"mode": "test",
"params": {
"since": "2026-05-01",
"until": "2026-05-02"
}
}
'import requests
url = "http://localhost:8080/api/v1/tap/run"
payload = {
"name": "<string>",
"mode": "test",
"params": {
"since": "2026-05-01",
"until": "2026-05-02"
}
}
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>',
mode: 'test',
params: {since: '2026-05-01', until: '2026-05-02'}
})
};
fetch('http://localhost:8080/api/v1/tap/run', 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/tap/run",
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>',
'mode' => 'test',
'params' => [
'since' => '2026-05-01',
'until' => '2026-05-02'
]
]),
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/tap/run"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"mode\": \"test\",\n \"params\": {\n \"since\": \"2026-05-01\",\n \"until\": \"2026-05-02\"\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/tap/run")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"mode\": \"test\",\n \"params\": {\n \"since\": \"2026-05-01\",\n \"until\": \"2026-05-02\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/tap/run")
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 \"name\": \"<string>\",\n \"mode\": \"test\",\n \"params\": {\n \"since\": \"2026-05-01\",\n \"until\": \"2026-05-02\"\n }\n}"
response = http.request(request)
puts response.read_body{
"tap": "<string>",
"description": "<string>",
"status": "success",
"mode": "run",
"targetPipeline": "<string>",
"persisted": true,
"persistedReason": "test_mode",
"publisherToken": "<string>",
"pipelineTokens": [
"<string>"
],
"records": [
{}
],
"recordCount": 123,
"dataType": "<string>",
"columns": [
"<string>"
],
"logs": "<string>",
"error": "<string>",
"aiExplanation": "<string>"
}Authorizations
Optional API key for authentication (enabled via application.yaml)
Body
'run' feeds records into the configured target pipeline; 'test' executes the script and returns results without persisting
run, test Optional per-run parameters. Each value is stringified and exposed to the tap script as an environment variable (nested objects/arrays are JSON-encoded so the script can json.loads() them back). Use for date-windowed backfills, e.g. {"since": "2026-05-01", "until": "2026-05-02"}. From Airflow, pass Jinja-templated values like {"since": "{{ ds }}"}.
{
"since": "2026-05-01",
"until": "2026-05-02"
}
Response
Run result
success, failure The mode this invocation ran in
run, test The pipeline configured on the tap (null if none — records will not persist)
True iff records were fed into the target pipeline
Present when persisted is false; explains why records did not land in a pipeline
test_mode, run_error, no_records, no_target_pipeline UUID grouping every ingestion job this run submitted. Pass to GET /pipeline/status?publishertoken= to watch load progress. Only present on persisted runs.
UUIDs for each StreamNotifier job submitted. Length 1 for structured taps, N for document taps (one per document). Only present on persisted runs.
