npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@textql/sdk

v1.4.61

Published

Official TypeScript SDK for the TextQL API.

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

gtomitsukagtomitsukahm8192hm8192asanatiasanatirodney992rodney992

Keywords

Readme

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

Agents

ApiOAuth

Apps

  • heartbeat - Keeps the viewed app's compute worker alive; first view spawns and pre-warms it (dashboard viewer-TTL parity).
  • 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 - Read-only table/column list for the app's private DuckDB (app_db).
  • getDBTablePreview - A bounded row preview of one app_db table (SELECT ... LIMIT n).
  • getMemberState - Per-member app state: one JSON blob per (app, member) so apps remember settings/progress. Member always resolved server-side from auth context; per-member persistence, so viewers with read access can save their own state.
  • getAppVersion - GetAppVersion
  • getAppViewStats - View analytics: reads the engagement views recorded on app page load.
  • getMembersWithApps - GetMembersWithApps
  • invokeComputeFunction - Executes a declared compute function on a pooled sandbox worker; gated, org-scoped, rate-limited.
  • listActivitySince - Cross-member live activity: rows from every member of the app after a seq, each carrying member_id + display_name (resolved server-side; never email).
  • listUploads - Lists the invoking viewer's uploads for this app. May recover legacy Library pointers on first use.
  • listVersions - Version history: git-backed, one version per save (plus legacy publish-era snapshots); authors can list and restore.
  • list - ListApps
  • listMyMemberActivity - ListMyAppMemberActivity
  • moveAppToFolder - Moves an app into a library folder (or to root when folder_id is empty).
  • presenceHeartbeat - Presence heartbeat: sets a short-TTL Valkey key for the member and nudges the app's stream. Presence never touches Postgres and never exposes emails.
  • recordMemberActivity - Append-only per-member activity log. Listing is own rows only; no cross-member reads in this release.
  • refresh - Re-fetches data sources, rebuilds the document with a fresh snapshot, re-uploads.
  • removeUpload - Removes only this viewer's app association, never the dataset itself.
  • restoreAppVersion - RestoreAppVersion
  • setMemberState - SetAppMemberState
  • setFavorite - 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.
  • update - UpdateApp
  • verifyRender - 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.

AuditLogs

Chats

Connectors

Dashboards

Datasets

Harnesses

  • list - ListHarnesses

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.