SDKs

The Amigo SDK provides a comprehensive interface to interact with Amigo's API in Python and TypeScript. Our SDKs abstract the complexities of authentication, request formatting, response parsing, and error handling, enabling developers to focus on building AI-powered applications.

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.8+

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, ensuring API compatibility.

• Streaming Support — Real-time conversation events with built-in NDJSON parsing

• Error Handling — Comprehensive 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

• Streaming Responses — Handle real-time events

• User Management — Create and manage users

• Regional Endpoints — Configure regional deployments

Production Examples

Explore comprehensive examples demonstrating 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

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

• Type-safe implementations

• Modern async patterns

• Production error handling

• Real-world application contexts

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.