This SDK provides a convenient TypeScript interface for interacting with the Dedalus REST API, targeting developers building server-side applications or complex client-side integrations. It simplifies API calls, handles data serialization, and offers robust features for managing requests and responses, thereby accelerating development and improving code maintainability.

How It Works

The library acts as a typed client for the Dedalus REST API, generated using Stainless. It abstracts away HTTP request details, providing methods that map directly to API endpoints. Key features include support for streaming responses via Server-Sent Events (SSE), flexible handling of file uploads through various input types, and comprehensive TypeScript definitions for all request parameters and response fields, ensuring type safety.

Quick Start & Requirements

• Install: npm install dedalus-labs
• Prerequisites: TypeScript >= 4.9. Supported runtimes include Node.js 20 LTS+, Deno v1.28.0+, Bun 1.0+, modern web browsers, Cloudflare Workers, and Vercel Edge Runtime. Jest 28+ with the "node" environment is supported; "jsdom" is not.
• Documentation: REST API docs at docs.dedaluslabs.ai, library API at api.md.

Highlighted Details

• Full TypeScript definitions for request parameters and response fields enhance type safety and developer experience.
• Flexible file upload handling supports fs.ReadStream, File objects, fetch Responses, and a toFile helper utility.
• Built-in support for streaming responses via Server-Sent Events (SSE) for real-time data processing.
• Automatic request retries (default 2x with exponential backoff) for transient network or server errors.
• Configurable request timeouts (default 1 minute) and retry mechanisms.
• Advanced usage options include making undocumented requests, customizing the fetch client, and configuring proxy support for Node.js, Bun, and Deno.

Maintenance & Community

No specific details regarding contributors, sponsorships, or community channels (like Discord/Slack) were found in the provided README.

Licensing & Compatibility

The license type is not explicitly stated in the provided README. Compatibility for commercial use or closed-source linking is therefore undetermined without further information.

Limitations & Caveats

React Native is explicitly not supported. Jest testing environments using "jsdom" are also not supported. The lack of explicit licensing information presents a significant caveat for adoption decisions.