\n\nTyped from the committed Classic OpenAPI snapshot, shipped as ESM and CommonJS, and used by existing org-scoped integrations on the original Amigo backend at `api.amigo.ai`.\n\n## Classic Backend Context\n\n`@amigo-ai/sdk` targets the original org-scoped Amigo backend. Existing deployments still use this surface for conversations, services, organizations, users, agents, context graphs, webhooks, and streaming events.\n\n\n\n## Product Status\n\n`@amigo-ai/sdk` remains the supported TypeScript client for the Classic API.\n\nThe Platform API is where new workspace-scoped capabilities land first, but the Classic API is not being switched off abruptly. Amigo will publish a migration path, compatibility notes, and upgrade guidance before asking customers to move production workloads.\n\n## Choose The Right SDK\n\n| If you need | Start here |\n| ------------------------------------------------------------ | ------------------------------------------------------------------------------------- |\n| Existing org-scoped integrations on `api.amigo.ai` | `@amigo-ai/sdk` |\n| New workspace-scoped integrations on `api.platform.amigo.ai` | [`@amigo-ai/platform-sdk`](https://github.com/amigo-ai/amigo-platform-typescript-sdk) |\n\n## Documentation\n\n| Need | Best entry point |\n| --------------------------------------- | ------------------------------------------------------------------------------------------- |\n| Product overview and deployment context | [docs.amigo.ai](https://docs.amigo.ai/) |\n| Integration guidance and developer docs | [Developer Guide](https://docs.amigo.ai/developer-guide/classic-api/sdks) |\n| Generated API reference | [amigo-ai.github.io/amigo-typescript-sdk](https://amigo-ai.github.io/amigo-typescript-sdk/) |\n| Runnable examples | [examples/](https://github.com/amigo-ai/amigo-typescript-sdk/tree/main/examples) |\n| Release history | [CHANGELOG.md](https://github.com/amigo-ai/amigo-typescript-sdk/blob/main/CHANGELOG.md) |\n\nThe docs site remains the primary reference. The repo-local examples stay close to the shipped package surface and are validated in CI.\n\n## Installation\n\n```bash\nnpm install @amigo-ai/sdk\n```\n\nBefore making requests, obtain Classic organization credentials and a user authorized to read the target resources. Keep API keys in server-side environment variables or a secret manager. The examples below read conversation data; they require access to an existing organization.\n\nFor the 2.0.0 generated-model changes, review the [current SDK upgrade guidance](https://docs.amigo.ai/api-reference/change-logs/sdk-ecosystem#september-2026-compatibility-releases) and recheck the package registry when choosing a version.\n\n## Quick Start\n\n```typescript\nimport { AmigoClient } from '@amigo-ai/sdk'\n\nconst client = new AmigoClient({\n apiKey: 'your-api-key',\n apiKeyId: 'your-api-key-id',\n userId: 'user-id',\n orgId: 'your-organization-id',\n})\n\nconst conversations = await client.conversations.getConversations({\n limit: 10,\n sort_by: ['-created_at'],\n})\n\nconsole.log(conversations.conversations.map(conversation => conversation.id))\n```\n\n## Configuration\n\n| Option | Type | Required | Description |\n| ---------- | -------------- | -------- | ------------------------------------------------------------- |\n| `apiKey` | `string` | Yes | API key from the Amigo dashboard |\n| `apiKeyId` | `string` | Yes | API key ID paired with `apiKey` |\n| `userId` | `string` | Yes | User ID on whose behalf the request is made |\n| `orgId` | `string` | Yes | Organization ID for the classic API |\n| `baseUrl` | `string` | No | Override the API base URL. Defaults to `https://api.amigo.ai` |\n| `retry` | `RetryOptions` | No | Retry policy overrides for transient HTTP failures |\n\n### Runtime Requirements\n\nThe SDK supports Node `18+` and is tested on active Node releases in CI. It relies on web-standard primitives such as `fetch`, `AbortController`, `URL`, and `TextEncoder`.\n\n## Generated Types\n\nThe package re-exports the generated OpenAPI types so application code can type directly against the API contract:\n\n```typescript\nimport type { components, operations, paths } from '@amigo-ai/sdk'\n\ntype Conversation = components['schemas']['ConversationInstance']\ntype GetConversationsQuery = operations['get-conversations']['parameters']['query']\n```\n\nPublic builds are generated from the committed [`specs/openapi-baseline.json`](./specs/openapi-baseline.json) snapshot in this repo so type output stays deterministic across machines and CI runs. When you need to refresh that snapshot, run:\n\n```bash\nnpm run openapi:sync\n```\n\n## Retries\n\nThe HTTP client retries transient failures with sensible defaults:\n\n- Max attempts: `3`\n- Backoff base: `250ms` with full jitter\n- Max delay per attempt: `30s`\n- Statuses: `408`, `429`, `500`, `502`, `503`, `504`\n- Methods: `GET`, plus `POST` on `429` when `Retry-After` is present\n\n## Error Handling\n\n```typescript\nimport { AmigoClient, AuthenticationError, NetworkError } from '@amigo-ai/sdk'\n\ntry {\n const client = new AmigoClient({\n apiKey: 'your-api-key',\n apiKeyId: 'your-api-key-id',\n userId: 'user-id',\n orgId: 'your-organization-id',\n })\n\n await client.organizations.getOrganization()\n} catch (error) {\n if (error instanceof AuthenticationError) {\n console.error('Authentication failed:', error.message)\n } else if (error instanceof NetworkError) {\n console.error('Network error:', error.message)\n } else {\n console.error('Unexpected error:', error)\n }\n}\n```\n\n## Support\n\nUse the [issue tracker](https://github.com/amigo-ai/amigo-typescript-sdk/issues) for bugs and feature requests. For responsible disclosure, see [SECURITY.md](https://github.com/amigo-ai/amigo-typescript-sdk/blob/main/SECURITY.md).\n","readmeFilename":"README.md"}
![\"Amigo](\"./assets/readme/amigo-banner.png\")
\n![\"npm](\"https://img.shields.io/npm/v/%40amigo-ai%2Fsdk?logo=npm\")
![\"CI\"](\"https://github.com/amigo-ai/amigo-typescript-sdk/actions/workflows/test.yml/badge.svg\"){kind=icon}
\n ![\"codecov\"](\"https://codecov.io/gh/amigo-ai/amigo-typescript-sdk/graph/badge.svg?token=PQU5JBU941\"){kind=icon}
\n ![\"MIT](\"https://img.shields.io/badge/License-MIT-blue.svg\"){kind=icon}
\n