SDKs

Official Python and TypeScript SDKs for the Classic API with streaming, auth, and error handling.

These SDK pages cover the Classic API SDKs in Python and TypeScript. The SDKs take care of authentication, request formatting, response parsing, and error handling so you can focus on building AI-powered applications.

Classic API only. These SDKs wrap the Classic API at api.amigo.ai. For the Platform API (api.platform.amigo.ai), use the Platform SDK for TypeScript or direct HTTP while additional first-party Platform SDKs are added.

Available SDKs

Python SDK

The official Python SDK for the Amigo API, supporting both synchronous and asynchronous operations.

Property	Value
Package	amigo_sdk
Repository	github.com/amigo-ai/amigo-python-sdk
Registry	PyPI
Python Version	3.11+

TypeScript SDK

The official TypeScript/JavaScript SDK for the Amigo API, with full type safety and modern async/await patterns.

Property	Value
Package	@amigo-ai/sdk
Repository	github.com/amigo-ai/amigo-typescript-sdk
Registry	npm
Node.js Version	18+

Key Features

Both SDKs provide:

Auto-generated types. Types are generated from the latest Amigo OpenAPI schema, so they stay in sync with the API.

• Streaming support. Real-time conversation events with built-in NDJSON parsing.

• Error handling. Typed error handling for all API responses.

• Authentication. Automated API key-based authentication and token management.

• Configuration. Environment variable support with flexible configuration options.

• Resource coverage. Complete access to Amigo API resources (conversations, users, services, organizations).

API Compatibility

Version compatibility. SDKs auto-generate types from the latest OpenAPI schema. Only the latest published SDK version is guaranteed to match the current API. Older versions may lack new endpoints or fields.

Getting Started

Quick Start

1. Installation. Set up the SDK in your project.

2. Configuration. Configure authentication and client options.

3. Hello World. Create your first conversation.

4. Error Handling. Handle errors and edge cases.

Advanced

Production Examples

The SDK repositories include working examples that demonstrate production-ready patterns.

Python Examples

Repository: github.com/amigo-ai/amigo-python-sdk/examples

• Project structure best practices

• Environment configuration

• Error handling patterns

• Async/await implementations

TypeScript Examples

Support & Resources

Resource	Link
Python SDK Issues	GitHub Issues
TypeScript SDK Issues	GitHub Issues
Enterprise Support	Contact support through the Amigo dashboard
API Reference	OpenAPI Schema

License

Both SDKs are licensed under the MIT License.