One gateway. Every product. Infinite possibilities.
Complete REST & GraphQL API documentation for all 36 Amoza products — powered by aHub, the unified API gateway.
Get started in 3 steps
Get Your API Key
Planned: request an API key from the developer portal once the Amoza AI Platform is productized (2028–29). Today, contact the founder.
Authenticate
Use Bearer Token authentication with your API key in the Authorization header for all requests.
Make Your First Request
Call any endpoint with your key. Start with GET /v1/aplanner/forecasts to retrieve a demand forecast.
Authentication
API Key
Server-to-server, testing, scripts
OAuth 2.0
User-context apps, third-party integrations
JWT Tokens
Session-based access, web applications
HMAC Signature
Webhook verification
OAuth 2.0 Flow
Security Best Practices
Never expose keys
Use environment variables, never commit to source control
Use HTTPS only
All API calls must use HTTPS
Rotate keys
Rotate API keys every 90 days
Scope permissions
Use least-privilege principle for OAuth scopes
Monitor usage
Review API usage logs for anomalies
REST API endpoints
All APIs follow RESTful conventions with JSON request/response bodies. Base URL: https://api.amoza.ai/v1
MAKE
/v1/make/aPlanner, aMonitor, aOps, aQuality, aYield, aMake
MOVE
/v1/move/aFulfill, aShip, aRoute, aStock, aReturn, aTrack
SELL
/v1/sell/aShop, aPrice, aSearch, aMarket, aConvert, aSocial
DELIGHT
/v1/delight/aCare, aLoyalty, aInsight, aPersona, aConnect, aVoice
AI
/v1/ai/aCore, aFlow, aExecutor, aData
Platform
/v1/platform/Auth, Users, Organizations, Billing
Common Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
per_page | integer | Items per page (default: 25, max: 100) |
sort | string | Sort field (e.g., created_at, -updated_at) |
filter | object | Filter parameters (product-specific) |
fields | string | Comma-separated fields to include |
expand | string | Related resources to embed |
GraphQL API
Flexible queries for when you need exactly the data you want — nothing more, nothing less. Endpoint: https://api.amoza.ai/graphql
Schema Introspection
Self-documenting — explore the full schema in the playground
Subscriptions
Real-time updates via WebSocket — watch for changes as they happen
Batching
Combine multiple queries in a single request
Fragments
Reuse query components across different queries
Caching
Response caching with ETags and Cache-Control headers
Webhooks
Subscribe to real-time events — get notified when things happen across the Amoza platform.
forecast.generated, schedule.updated, schedule.published, quality.defect_detected, yield.threshold_alert
Example: New forecast ready for review
order.placed, fulfillment.started, shipment.created, shipment.delivered, return.initiated
Example: Order shipped to customer
product.created, price.updated, cart.abandoned, checkout.completed, review.submitted
Example: New order completed
ticket.created, feedback.received, nps.response, journey.milestone, loyalty.tier_changed
Example: Customer feedback submitted
user.created, data.sync.completed, alert.triggered, integration.error
Example: Data sync completed
Webhook Security
HMAC Signature
Every webhook is signed — verify with your webhook secret
Retry Logic
Automatic retry with exponential backoff (5 attempts)
Dead Letter Queue
Failed webhooks stored for 7 days — replay anytime
IP Allowlist
Optional IP allowlisting for added security
Event Filtering
Subscribe to specific events — don't get overwhelmed
Rate limits — planned
| Tier | Limit | Burst | Cost |
|---|---|---|---|
| Free | 1,000 calls/day | 10 calls/sec | $0 |
| Pro | 100,000 calls/day | 50 calls/sec | Usage-based |
| Enterprise | Unlimited | Custom | Custom pricing |
Rate Limit Headers
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1708300800 Versioning policy
Current Version
v1
Version in URL
https://api.amoza.ai/v1/...
Breaking Changes
Major version bump (v1 to v2) — minimum 12 months notice
Non-Breaking Changes
Added fields, new endpoints — no version change
Deprecation
Deprecated endpoints marked in docs; 6-month sunset period
Changelog
Published at /developers/changelog
Error handling
| Code | Status | Description | Action |
|---|---|---|---|
200 | OK | Request successful | -- |
201 | Created | Resource created | -- |
400 | Bad Request | Invalid parameters | Check request body |
401 | Unauthorized | Invalid or missing API key | Verify authentication |
403 | Forbidden | Insufficient permissions | Check scopes |
404 | Not Found | Resource doesn't exist | Verify resource ID |
429 | Too Many Requests | Rate limit exceeded | Backoff and retry |
500 | Server Error | Internal error | Contact support |
Sandbox — planned
An interactive sandbox pre-loaded with sample data is planned with the developer portal (2028–29).
Pre-loaded Data
Sample products, orders, customers, forecasts — ready to query
No Production Impact
Sandbox is completely isolated from production
Code Generation
Try an endpoint and get code in Python, JavaScript, Java, Go, C#
Save & Share
Save your API experiments and share with team members
Auto-Reset
Sandbox data resets every 24 hours to clean state
Ready to integrate?
The API is on the roadmap with the Amoza AI Platform (2028–29). Talk to the founder about integration plans for the 2027 aPlanner pilot.