Skip to content
DaneshyarDocs
Sign in
  • Introduction
  • Quickstart
  • API keys
  • Authentication
  • Apps, workspaces, resources
  • Ingestion
  • Chat and sessions
  • Citations
  • Skills
  • Conventions
  • Workspaces
  • Resources
  • Chat
  • Skills
  • Errors
  • Customer support assistant
  • Internal knowledge base
  • Documentation chatbot
  • Embedded widgetOn the roadmap: Soon
  • TypeScript SDKOn the roadmap: Soon
  1. Docs
  2. Integrations
  3. TypeScript SDK

TypeScript SDK

On the roadmap: Soon

A typed client for this API. Not available yet.

Status

There is no TypeScript SDK yet. No package is published, and nothing in this repository implements one.

Everything the SDK would wrap is available today over plain HTTP, and the samples throughout this documentation use nothing but the built-in fetch. If you need a typed client now, the fastest path is to write a thin wrapper around the endpoints in this reference — the surface is small enough that generating one from the OpenAPI schema is also reasonable.

ConventionsThe response envelope, pagination, content types and identifiers — true of every endpoint.ErrorsTwo error shapes, six status codes, and how to handle each.

Planned shape

The intended shape, if it helps you structure your own wrapper in the meantime: a single client factory holding the key, one namespace per resource, and typed responses that unwrap the envelope so callers never touch data themselves.

It would also normalise the two error bodies into one typed error, carry a timeout and a retry policy for 5xx only, and accept an AbortSignal — the four things every hand-written wrapper ends up needing.

What's blocking it

Nothing technical is blocking it; it simply has not been built. The REST API this documents is stable enough to build a client against today, and this page will be replaced with real documentation when one exists.

PreviousEmbedded widget

On this page

  • Status
  • Planned shape
  • What's blocking it

Every example on this site runs against the live API. If one doesn't, tell us — that's a bug in the docs.

ServicesAboutTalk to us