Skip to content
BranchesTags

Repository files navigation

TextQL TypeScript SDK

The official, type-safe TypeScript client for the TextQL API.

npm License: Apache 2.0 Built by Speakeasy

Summary

Use @textql/sdk to access TextQL agents, apps, chats, connectors, dashboards, datasets, and the rest of the public API from Node.js, Bun, or modern edge runtimes. The SDK includes generated request and response types, authentication, retries, error handling, and per-operation examples.

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @textql/sdk

PNPM

pnpm add @textql/sdk

Bun

bun add @textql/sdk

Yarn

yarn add @textql/sdk

Note

This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("@textql/sdk") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Textql } from "@textql/sdk";

const textql = new Textql({
  apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});

async function run() {
  const result = await textql.agents.create({
    body: {},
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
apiKey apiKey API key TEXTQL_API_KEY

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:

import { Textql } from "@textql/sdk";

const textql = new Textql({
  apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});

async function run() {
  const result = await textql.agents.create({
    body: {},
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

Agents

Apps

  • heartbeat - AppHeartbeat
  • createApp - CreateApp
  • deleteApp - DeleteApp
  • duplicate - Duplicates an app the caller can view into a new app they own, named "Copy of ". Copies code/files/data sources/compute functions/ schedule; never carries over the source's data snapshot.
  • get - GetApp
  • getDBSchema - Replaces the calling member's entire ordering; capped server-side.
  • getDBTablePreview - View analytics: reads the engagement views recorded on app page load.
  • getMemberState - Per-member notification subscription to an app ("watch this app").
  • getAppVersion - Overwrites the published tree's pinned _runtime/ana-1.js with the platform's current copy so host-driven affordances (comment hit-testing) work on older documents; never touches authored content or data. repinned=false for legacy pre-tree documents.
  • getAppViewStats - Keeps the viewed app's compute worker alive; first view spawns and pre-warms it (dashboard viewer-TTL parity).
  • getMembersWithApps - GetMembersWithApps
  • invokeComputeFunction - InvokeAppComputeFunction
  • listActivitySince - Favorite/unfavorite a library item (app or dashboard) for the calling member. Per-member, per-org; favorited=false hard-deletes the row. Covers both primitives since the merged library page pins apps and dashboards through one client.
  • listVersions - Renders the live artifact in the production sandbox and returns browser diagnostics. This is synchronous so callers can verify an app before sharing its URL.
  • list - ListApps
  • listMyMemberActivity - Watcher management: app owners/editors and org admins list the app's subscribers and add/remove members (Upsert/Delete with member_id).
  • moveAppToFolder - MoveAppToFolder
  • presenceHeartbeat - Ordering overlay for the sidebar Bookmarks section: one position list per member covering favorites and thread bookmarks (':' keys). Membership truth stays in library_favorite / chat bookmarks; this persists only the drag-and-drop order.
  • recordMemberActivity - RecordAppMemberActivity
  • refresh - Moves an app into a library folder (or to root when folder_id is empty).
  • restoreAppVersion - Version history: git-backed, one version per save (plus legacy publish-era snapshots); authors can list and restore.
  • setMemberState - SetAppMemberState
  • setFavorite - Executes a declared compute function on a pooled sandbox worker; gated, org-scoped, rate-limited.
  • update - UpdateApp
  • verifyRender - Re-fetches data sources, rebuilds the document with a fresh snapshot, re-uploads.

AuditLogs

Chats

Connectors

Dashboards

Datasets

Mcp

MetricsExports

Observability

Ontology

Playbooks

Powerbi

Rbac

Sandbox

SandboxAdmin

  • getSandbox - GetSandbox
  • listSandboxEgress - Outbound HTTP(S) calls a sandbox made (the egress ledger). Durable — reads the recorded table, so it works for stopped sandboxes too.
  • listExecutions - ListSandboxExecutions
  • listSandboxFiles - Live filesystem of a running sandbox. Both are NO-OP (read-only) and only return data while the worker is alive; available=false otherwise.
  • listSandboxSpend - Per-lease compute usage for a sandbox, computed from lease durations × the compute rate. Durable (reads the lease table), so it works for stopped sandboxes. This is usage (ACUs), not the invoiced dollar amount.
  • list - ListSandboxes
  • readFile - ReadSandboxFile
  • restartSandbox - Restart a stopped/reaped sandbox by re-acquiring a worker for the same sandbox_id, preserving the original owner. Same scoping as StopSandbox (owner, or sandbox:write_private for org-wide).
  • stop - StopSandbox

SandboxCapabilities

Scim

Secrets

Settings

Slack

Tableau

Teams

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Textql } from "@textql/sdk";

const textql = new Textql({
  apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});

async function run() {
  const result = await textql.agents.create({
    body: {},
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Textql } from "@textql/sdk";

const textql = new Textql({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});

async function run() {
  const result = await textql.agents.create({
    body: {},
  });

  console.log(result);
}

run();

Error Handling

TextqlError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
error.message string Error message
error.statusCode number HTTP response status code eg 404
error.headers Headers HTTP response headers
error.body string HTTP body. Can be empty string if no body is returned.
error.rawResponse Response Raw HTTP response

Example

import { Textql } from "@textql/sdk";
import * as errors from "@textql/sdk/models/errors";

const textql = new Textql({
  apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});

async function run() {
  try {
    const result = await textql.agents.create({
      body: {},
    });

    console.log(result);
  } catch (error) {
    if (error instanceof errors.TextqlError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

  • TextqlError: The base class for HTTP error responses.
Less common errors (6)

Network errors:

Inherit from TextqlError:

  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Textql } from "@textql/sdk";

const textql = new Textql({
  serverURL: "https://app.textql.com/rpc/public",
  apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});

async function run() {
  const result = await textql.agents.create({
    body: {},
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { Textql } from "@textql/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@textql/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Textql({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Textql } from "@textql/sdk";

const sdk = new Textql({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable TEXTQL_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

About

TextQL TypeScript SDK

docs.textql.com/api-reference/sdk/typescript

Topics

agentdata-analysisdata-visualizationtypescript

Resources

Readme

Contributing

Contributing
Activity
Custom properties

Stars

3 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Used by

Contributors

Languages