Welcome

Official developer documentation for the Amigo AI platform. This guide provides comprehensive resources for integrating AI-powered conversational agents into your enterprise systems.

Platform Overview

Amigo is an enterprise AI platform for deploying intelligent conversational agents. The platform combines advanced language models with robust APIs to enable personalized, context-aware AI interactions.

New to Amigo? For a comprehensive understanding of Amigo's architecture and design philosophy, see our Conceptual Documentation. This developer guide focuses on API implementation and SDK usage.

System Architecture

Documentation Structure

Section	Description
Getting Started	Core concepts, authentication, and regional configuration
SDKs	Official Python and TypeScript/JavaScript SDKs
Core API	Complete API reference for all platform features
Data Access	Data access for analytics and integrations
Webhooks	Real-time event delivery and management
Permissions	Role-based access control and security
Best Practices	Operational guidance: version sets, unknown inbound users, PHI isolation

Quick Start

Prerequisites

1. Obtain API credentials from your Amigo representative

2. Install an SDK: Python or TypeScript

3. Configure authentication using the Authentication Guide

4. Set your regional endpoint per Regions & Endpoints

5. Run the Hello World example from our tutorial

Example Implementation

// TypeScript Example
import { AmigoClient } from '@amigo-ai/sdk';

const client = new AmigoClient({
  apiKey: process.env.AMIGO_API_KEY!,
  apiKeyId: process.env.AMIGO_API_KEY_ID!,
  userId: process.env.AMIGO_USER_ID!,
  orgId: process.env.AMIGO_ORGANIZATION_ID!
});

// Create and interact with a conversation
const conversation = await client.conversations.createConversation({
  service_id: 'your-service-id',
  service_version_set_name: 'release'
});

const response = await client.conversations.interactWithConversation(
  conversation.conversation_id,
  "Hello, Amigo!"
);

See SDKs documentation for Python examples and detailed usage.

Platform Capabilities

Feature	Description
Intelligent Agents	AI agents customized for your business requirements
Real-time Streaming	WebSocket support for streaming responses
Personalization	Adaptive user models for individualized experiences
Voice Support	Native voice interaction and real-time audio
Enterprise Scale	Production-ready with security and compliance
Analytics	Comprehensive conversation metrics and insights

Support & Resources

Resource	Description
API Reference	Interactive API Documentation
Support	Contact your account executive or agent engineer via Slack
SDK Issues	Python / TypeScript