Getting Started

Prerequisites, core documentation links, and quick start paths for both Classic and Platform APIs.

Welcome to the Amigo Developer Guide. This section covers the essentials for building on the Amigo platform.

Getting started covers both APIs. Core concepts and authentication patterns are shared, though the examples here use the Classic API. For Platform API setup, see Platform API Authentication.

Prerequisites

Before you begin Make sure you have your organization ID and initial credentials from your Amigo representative.

Getting Started Guide

Core Documentation

Essential Reading

1. Core Concepts The fundamental building blocks: Users, Services, Conversations, and Interactions.

2. Authentication Set up API keys and secure authentication for your applications.

3. Regions & Endpoints Configure the correct regional endpoint for your organization.

Quick Start

Key Resources

Resource	Description
API Reference	Complete API documentation
SDKs	Official Python and TypeScript SDKs
Examples	Code samples and tutorials
OpenAPI Schema	Complete API specification