> 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/references/interfaces/apis/getting-started/sdks/typescript-sdk.md). # TypeScript SDK The TypeScript SDK wraps the Data Product API with a typed client built on native `fetch`. It builds the base URL for you. It also sets `Accept: application/json` on every request. {% file src="/files/dQ3wyas1OUK0NSbHodZh" %} ### Install ```bash npm install vulcan-sdk-0.1.0.tgz ``` ### Create a client ```typescript import { VulcanClient } from "vulcan-sdk"; const client = new VulcanClient({ fqdn: "example.dataos.io", dpName: "b2b_saas", accessToken: "", tenant: "public", }); ``` Base URL: ``` https://{fqdn}/vulcan/tenants/{tenant}/data-products/{tenant}-{dpName}/api/v1 ``` ### Available clients

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()`

### Query example ```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); 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); } ``` ### Notes * Uses native `fetch` with zero runtime dependencies. * Supports Node.js 18+. * Supports TypeScript 5.0+. * Supports `AbortSignal` on every method. --- # 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/references/interfaces/apis/getting-started/sdks/typescript-sdk.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.