Get source runtime docs
curl --request GET \
--url https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs \
--header 'x-api-key: <api-key>'import requests
url = "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs', 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.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"schemaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseUrl": "https://api.synthbrew.com/api",
"runtimeBasePath": "/runtime/11111111-1111-1111-1111-111111111111",
"auth": {
"headerName": "x-api-key",
"keyPrefix": "sb_src_"
},
"entities": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"primaryKey": [
"<string>"
],
"fields": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"type": "<string>",
"nullable": true,
"references": {
"entity": "<string>",
"field": "<string>",
"relation": "many-to-one",
"pick": "random",
"onDelete": "restrict",
"onUpdate": "restrict"
}
}
]
}
],
"examples": {
"curl": "<string>",
"fetch": "<string>"
}
}
Sources
Get Source Runtime Docs
Returns machine-readable runtime API details for a source.
GET
/
public
/
v1
/
projects
/
{projectId}
/
sources
/
{sourceId}
/
runtime-docs
Get source runtime docs
curl --request GET \
--url https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs \
--header 'x-api-key: <api-key>'import requests
url = "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs', 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.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"schemaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseUrl": "https://api.synthbrew.com/api",
"runtimeBasePath": "/runtime/11111111-1111-1111-1111-111111111111",
"auth": {
"headerName": "x-api-key",
"keyPrefix": "sb_src_"
},
"entities": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"primaryKey": [
"<string>"
],
"fields": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"type": "<string>",
"nullable": true,
"references": {
"entity": "<string>",
"field": "<string>",
"relation": "many-to-one",
"pick": "random",
"onDelete": "restrict",
"onUpdate": "restrict"
}
}
]
}
],
"examples": {
"curl": "<string>",
"fetch": "<string>"
}
}
Authorizations
Team API key created under /api/api-keys. Prefix: sb_api_.
Path Parameters
Project UUID in the team associated with the API key.
Source UUID. For runtime endpoints this identifies the source backing the table; for public v1 it identifies the source resource inside the project.
Response
Runtime docs
⌘I