API & Integrations
API & Integrations
Client SDK Design
Design an ergonomic client SDK for an API.
01
Shape your prompt
8 fields02
Your prompt
785 charactersThe raw prompt, unchanged.
Still needed: API the SDK wraps, Capabilities to expose — the preview updates as you type.
Output21 lines · 785 chars
You are an SDK design expert. Design a client SDK for the "". ## Capabilities ## Targets - Languages: TypeScript/JS, Python - Auth handled by the SDK: API key ## Design principles - Idiomatic surface per language with discoverable, typed methods. - A consistent error model that distinguishes client, auth, and server errors. - Async/promise-based calls with cancellation support. - Built-in retries with backoff and automatic rate-limit handling. - Pagination helpers, configurable timeouts, and pluggable transport/logging. ## Deliverables 1. The public API surface (signatures) for the primary language. 2. Error handling, retry, and pagination conventions. 3. A quick-start usage example and packaging/versioning plan. Proceed with well-reasoned defaults; ask only if blocked.