Skip to main content

TypeScript SDK

The Prompting Company TypeScript SDK provides developers with seamless access to agentic markdown documentation data stored on our platform. Whether you’re building AI-powered applications, documentation sites, or content management systems, our SDK makes it easy to integrate our rich documentation data into your projects.

What You Can Do

With The Prompting Company TypeScript SDK, you can:
  • Access Documentation Data: Retrieve agentic markdown documentation from your organization’s data store
  • Query by Organization: Scope your requests to specific organizations using organization slugs
  • Filter by Product: Access documentation for specific products using product slugs
  • Simple Configuration: Easy setup with just organization and product slugs
  • TypeScript Support: Enjoy full type safety and autocompletion in your development environment

Key Features

Type Safety

Built with TypeScript for complete type safety and excellent developer experience.

Simple Configuration

Easy setup with just organization and product slugs - no API keys needed.

Rich Data Access

Access comprehensive agentic markdown documentation with full metadata.

Next.js Optimized

Designed to work seamlessly with Next.js applications and React components.

Prerequisites

Before you begin, you’ll need:
  • A Node.js environment (version 18 or higher)
  • An account with The Prompting Company
  • Your organization slug and product slug(s)

Next Steps

Ready to get started? Follow our step-by-step guide:

Installation & Setup

Install the SDK and configure your development environment.

Quick Start Guide

Build your first integration in minutes with our quick start guide.