Developer Toolkit

Official TypeScript SDK

An isomorphic, zero-dependency client library providing end-to-end type safety, automatic session identity persistence, intelligent retry backoff, and full autocomplete across browser, Node.js, and Next.js runtimes.

Installation

Add playground-api to your application with your favorite package manager:

terminal

npm install playground-api

Browser CDN Alternative: You can also load the client bundle directly via script tag from https://playground.nileslabs.com/api/v1/downloads/playground-api.js which exposes window.PlaygroundClient.

Client Initialization & Session Management

Initialize the client according to your application environment:

client.ts

import { PlaygroundClient } from 'playground-api';

// Browser client automatically forwards session cookies

const client = new PlaygroundClient({

baseUrl: 'https://playground.nileslabs.com/api/v1',

credentials: 'include', // Preserves mutations across user browser refreshes

});

// Fetch posts with type-safe query parameters

const { data, pagination } = await client.posts.list({

page: 1,

limit: 10,

sort: 'id',

order: 'desc',

});

console.log('Posts:', data);

console.log('Total available:', pagination.total);

Typed Resource Operations

Every standard API resource is exposed as a strongly typed submodule on the client:

posts-operations.ts

// 1. List with search, filtering, and pagination

const posts = await client.posts.list({

q: 'technology',

userId: 1,

page: 1,

limit: 5,

});

// 2. Fetch relational comments for a post

const comments = await client.posts.getComments(posts.data[0].id);

// 3. Create a stateful blog post

const created = await client.posts.create({

title: 'Shipping with Playground API',

body: 'Full-stack testing with zero backend friction.',

userId: 1,

});

// 4. Update and Delete

await client.posts.patch(created.id, { title: 'Updated Title' });

await client.posts.delete(created.id);

Error Handling & Validation Details

Failed HTTP calls throw typed PlaygroundApiError exceptions with status codes, error identifiers, and field-level validation details:

error-handling.ts

import { PlaygroundClient, PlaygroundApiError } from 'playground-api';

const client = new PlaygroundClient({ baseUrl: 'https://playground.nileslabs.com/api/v1' });

try {

await client.posts.get(999999);

} catch (error) {

if (error instanceof PlaygroundApiError) {

console.error('HTTP Status:', error.status); // 404

console.error('Error Code:', error.code); // 'RESOURCE_NOT_FOUND'

console.error('API Message:', error.message); // 'Post with id 999999 does not exist'

console.error('Validation Errors:', error.details); // Field-level error array if 422

} else {

console.error('Unexpected network failure:', error);

}

Need cURL, Python, or Go code instead?

Generate copy-pasteable request snippets in your language of choice.

View Code Generators

PreviousAtomic Sandbox Reset

NextMulti-Language Generators