Core API
The Amigo Core API provides programmatic access to all platform capabilities. This section covers essential API endpoints and operations.
Overview
The Core API is a RESTful API that enables developers to integrate Amigo's conversational AI platform into their applications. All endpoints return JSON responses and support standard HTTP methods (GET, POST, PUT, DELETE). The API is versioned (/v1/) to ensure backward compatibility.
Key capabilities:
User Management — Create and manage users, customize preferences
Service Discovery — List available AI services and configurations
Tool Management — Version and deploy custom tools for agents
Conversations — Create, interact with, and manage AI conversations
Real-time Streaming — WebSocket support for live voice and events
All operations are organization-scoped and require authentication. For complete endpoint specifications, see the API Reference.
API Categories
User Management
Users — Create and manage users, access profiles and settings
User Models — Manage user preferences and personalization
Service Management
Services — Discover and manage services, configure integrations
Tools
Tools — Create, publish, version, deprecate, and list tools
Conversations
The core of the Amigo platform for managing AI-powered conversations:
Initialize new conversations
Send messages and receive responses
Real-time event streaming
Manage conversation states
Voice-enabled conversations
Low-latency streaming via WebSocket
Interleave external events and audio
Retrieve messages and interactions
Authentication
All API requests require authentication. See the Authentication Guide for details.
Base URLs
US
https://api.amigo.ai/v1
EU
https://api-eu-central-1.amigo.ai/v1
AU
https://api-ap-southeast-2.amigo.ai/v1
Last updated
Was this helpful?