curl -X POST https://app.runtm.com/api/knowledge/oauth/bigquery/google_oauth/install \
-H "Authorization: Bearer runtm_xxx" \
-H "X-Organization-Id: org_abc123" \
-H "Content-Type: application/json" \
-d '{
"scope": "org",
"display_name": "BigQuery (OAuth)",
"provider_metadata": {
"project_id": "my-gcp-project"
}
}'
import requests
resp = requests.post(
"https://app.runtm.com/api/knowledge/oauth/bigquery/google_oauth/install",
headers={
"Authorization": "Bearer runtm_xxx",
"X-Organization-Id": "org_abc123",
"Content-Type": "application/json",
},
json={
"scope": "org",
"display_name": "BigQuery (OAuth)",
"provider_metadata": {"project_id": "my-gcp-project"},
},
)
data = resp.json()
# Redirect user to data["install_url"]
const resp = await fetch(
"https://app.runtm.com/api/knowledge/oauth/bigquery/google_oauth/install",
{
method: "POST",
headers: {
Authorization: "Bearer runtm_xxx",
"X-Organization-Id": "org_abc123",
"Content-Type": "application/json",
},
body: JSON.stringify({
scope: "org",
display_name: "BigQuery (OAuth)",
provider_metadata: { project_id: "my-gcp-project" },
}),
}
);
const data = await resp.json();
// Redirect user to data.install_url
{
"install_url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...&state=...",
"state": "eyJhbGciOiJIUzI1NiJ9..."
}
Knowledge
OAuth Install
Start an OAuth connection flow for a knowledge provider.
POST
/
api
/
knowledge
/
oauth
/
{provider_id}
/
{auth_method_id}
/
install
curl -X POST https://app.runtm.com/api/knowledge/oauth/bigquery/google_oauth/install \
-H "Authorization: Bearer runtm_xxx" \
-H "X-Organization-Id: org_abc123" \
-H "Content-Type: application/json" \
-d '{
"scope": "org",
"display_name": "BigQuery (OAuth)",
"provider_metadata": {
"project_id": "my-gcp-project"
}
}'
import requests
resp = requests.post(
"https://app.runtm.com/api/knowledge/oauth/bigquery/google_oauth/install",
headers={
"Authorization": "Bearer runtm_xxx",
"X-Organization-Id": "org_abc123",
"Content-Type": "application/json",
},
json={
"scope": "org",
"display_name": "BigQuery (OAuth)",
"provider_metadata": {"project_id": "my-gcp-project"},
},
)
data = resp.json()
# Redirect user to data["install_url"]
const resp = await fetch(
"https://app.runtm.com/api/knowledge/oauth/bigquery/google_oauth/install",
{
method: "POST",
headers: {
Authorization: "Bearer runtm_xxx",
"X-Organization-Id": "org_abc123",
"Content-Type": "application/json",
},
body: JSON.stringify({
scope: "org",
display_name: "BigQuery (OAuth)",
provider_metadata: { project_id: "my-gcp-project" },
}),
}
);
const data = await resp.json();
// Redirect user to data.install_url
{
"install_url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...&state=...",
"state": "eyJhbGciOiJIUzI1NiJ9..."
}
Generates a signed install URL for an OAuth-based knowledge provider.
Redirect the user’s browser to the returned
install_url to begin the OAuth consent flow.
The state token encodes org, user, scope, and provider metadata so the callback can route back securely.
After the user grants consent, the provider redirects to the platform’s callback endpoint which
exchanges the authorization code, persists the tokens, and redirects the browser to the dashboard.
Required scope: integrations:write
Requires organization context via the
X-Organization-Id header.Provider identifier from the catalog (e.g.
"bigquery").OAuth auth method identifier from the provider’s catalog entry. Must have
auth_kind: "oauth".curl -X POST https://app.runtm.com/api/knowledge/oauth/bigquery/google_oauth/install \
-H "Authorization: Bearer runtm_xxx" \
-H "X-Organization-Id: org_abc123" \
-H "Content-Type: application/json" \
-d '{
"scope": "org",
"display_name": "BigQuery (OAuth)",
"provider_metadata": {
"project_id": "my-gcp-project"
}
}'
import requests
resp = requests.post(
"https://app.runtm.com/api/knowledge/oauth/bigquery/google_oauth/install",
headers={
"Authorization": "Bearer runtm_xxx",
"X-Organization-Id": "org_abc123",
"Content-Type": "application/json",
},
json={
"scope": "org",
"display_name": "BigQuery (OAuth)",
"provider_metadata": {"project_id": "my-gcp-project"},
},
)
data = resp.json()
# Redirect user to data["install_url"]
const resp = await fetch(
"https://app.runtm.com/api/knowledge/oauth/bigquery/google_oauth/install",
{
method: "POST",
headers: {
Authorization: "Bearer runtm_xxx",
"X-Organization-Id": "org_abc123",
"Content-Type": "application/json",
},
body: JSON.stringify({
scope: "org",
display_name: "BigQuery (OAuth)",
provider_metadata: { project_id: "my-gcp-project" },
}),
}
);
const data = await resp.json();
// Redirect user to data.install_url
{
"install_url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...&state=...",
"state": "eyJhbGciOiJIUzI1NiJ9..."
}