Getting Started

Introduction

This guide walks you through the essential steps to start using Aimable. By the end, you will have made your first API call and understand the basic workflow for integrating Aimable into your application.

Prerequisites

Before you begin, make sure you have:

• An Aimable account (sign up at the Aimable dashboard)
• An API key generated from your account settings
• A working development environment with curl or an HTTP client library
• Node.js 18+ or Python 3.9+ if using an SDK

Quick Start

1. Set your API key

Store your API key as an environment variable:

export AIMABLE_API_KEY="your-api-key-here"

2. Make your first request

Send a simple orchestration request to verify your setup:

curl -X POST https://api.aimable.ai/v1/orchestrate \
  -H "Authorization: Bearer $AIMABLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "default",
    "messages": [
      { "role": "user", "content": "Hello, Aimable!" }
    ]
  }'

You should receive a JSON response containing the model output, usage metadata, and tracing information.

3. Explore the response

The response includes:

• output — The generated content from the selected model
• usage — Token counts, latency, and cost breakdown
• trace_id — A unique identifier for this request, useful for debugging and audit

Next Steps

• Read the Integration guide to learn about authentication, error handling, and advanced request options
• Visit the Support section if you run into any issues
• Check the Beta page to understand current platform limitations