> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/concepts/foundations/activation/apis/getting-started/sdks.md). # SDKs Two first-party SDKs are available — Python and TypeScript. Both handle auth, base URL construction, JSON parsing, and error wrapping for you. The REST API works without an SDK, but the SDKs cut boilerplate significantly.

SDK	Notes
🐍 Python SDK	Built on uplink + Pydantic v2. Typed models with full IDE autocomplete. Python 3.8+.
🟦 TypeScript SDK	Zero runtime dependencies — uses the native `fetch` API. Fully typed. Node.js 18+, TypeScript 5.0+.

## Python SDK {% file src="/files/KlgWabGG1Ac2bBB4h9zU" %} **Installation** ```bash pip install vulcan_sdk-0.1.0-py3-none-any.whl ``` **Quick Start** ```python from vulcan_sdk import VulcanClient client = VulcanClient( fqdn="example.dataos.io", dp_name="b2b_saas", access_token="", tenant="public", ) ``` > **Base URL auto-built:** `https://{fqdn}/vulcan/tenants/{tenant}/data-products/{tenant}-{dp_name}/api/v1`. Sets `Accept: application/json` on every request. **Available methods at a glance**

Client	Methods
`client.metadata`	`.get()` · `.get_semantic()` · `.download_powerbi()` · `.download_tableau()`
`client.activity`	`.list_plans()` · `.get_plan(id)` · `.get_plan_git_diff(id)` · `.list_runs()` · `.get_run(id)` · `.list_models()` · `.get_model_runs(name)`
`client.dq`	`.get_summary()` · `.list_rules()` · `.get_rule(id)` · `.get_rule_by_name(model, dim, name)`
`client.query`	`.submit_statement(sql)` · `.get_statement(id)` · `.get_statement_result(id)` · `.submit_semantic_rest(query)` · `.submit_semantic_sql(sql)` · `.get_metric(name)` · `.get_usage_metrics()`
`client.perspectives`	`.list()` · `.get(slug)` · `.get_result(slug)` · `.create(slug, req)` · `.update(slug, req)` · `.delete(slug)`
`client.notifications`	`.list()`
`client.followers`	`.follow()` · `.unfollow()` · `.get_follow_status()` · `.list()` · `.get_analytics()`

**Example — query and fetch results** ```python import time stmt = client.query.submit_statement("SELECT country, COUNT(*) AS users FROM users GROUP BY 1") while stmt.status.upper() not in {"SUCCESS", "FAILED"}: time.sleep(2) stmt = client.query.get_statement(stmt.id) result = client.query.get_statement_result(stmt.id) print(result.cols) # ["country", "users"] for row in result.rows: print(row) # ["US", 4821] ``` **Error handling** ```python from vulcan_sdk import VulcanError try: plan = client.activity.get_plan("bad-id") except VulcanError as e: print(e.status_code, e.detail) ``` *** ## TypeScript SDK {% file src="/files/ZsZBrjzb4izigkhXl8Kq" %} **Installation** ```bash npm install vulcan-sdk-0.1.0.tgz ``` **Quick Start** ```typescript import { VulcanClient } from "vulcan-sdk"; const client = new VulcanClient({ fqdn: "example.dataos.io", dpName: "b2b_saas", accessToken: "", tenant: "public", }); ``` > **Base URL auto-built:** `https://{fqdn}/vulcan/tenants/{tenant}/data-products/{tenant}-{dpName}/api/v1`. Sets `Accept: application/json` on every request. **Available methods at a glance**

Client	Methods
`client.metadata`	`.get()` · `.getSemantic()` · `.downloadPowerBI()` · `.downloadTableau()`
`client.activity`	`.listPlans()` · `.getPlan(id)` · `.getPlanGitDiff(id)` · `.listRuns()` · `.getRun(id)` · `.listModels()` · `.getModelRuns(name)`
`client.dq`	`.getSummary()` · `.listRules()` · `.getRule(id)` · `.getRuleByName(model, dim, name)`
`client.query`	`.submitStatement({sql})` · `.getStatement(id)` · `.getStatementResult(id)` · `.submitSemanticRest({query})` · `.submitSemanticSQL({sql})` · `.getMetric(name)` · `.getUsageMetrics()`
`client.perspectives`	`.list()` · `.get(slug)` · `.getResult(slug)` · `.create(slug, body)` · `.update(slug, body)` · `.delete(slug)` · `.checkAvailability(slug)`
`client.notifications`	`.list()`
`client.followers`	`.follow()` · `.unfollow()` · `.getFollowStatus()` · `.list()` · `.getAnalytics()`

**Example — query and fetch results** ```typescript const stmt = await client.query.submitStatement({ sql: "SELECT country, COUNT(*) AS users FROM users GROUP BY 1" }); const done = new Set(["SUCCESS", "FAILED"]); let detail = await client.query.getStatement(stmt.id); while (!done.has(detail.status)) { await new Promise(r => setTimeout(r, 2000)); detail = await client.query.getStatement(stmt.id); } const result = await client.query.getStatementResult(stmt.id); console.log(result.cols); // ["country", "users"] result.rows.forEach(r => console.log(r)); ``` **Error handling** ```typescript import { VulcanAPIError } from "vulcan-sdk"; try { const plan = await client.activity.getPlan("bad-id"); } catch (e) { if (e instanceof VulcanAPIError) console.log(e.statusCode, e.detail); } ``` Supports **AbortSignal** on every method for cancellation. Requires Node.js ≥ 18, TypeScript ≥ 5.0. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://v2.dataos.info/concepts/foundations/activation/apis/getting-started/sdks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.