Skip to content
Last updated

Getting Started

Welcome to Freddy! This guide will help you get up and running with the Freddy AI platform quickly and efficiently.

Prerequisites

Before you begin, make sure you have:

  • A Freddy account (sign up at chat.aitronos.com)
  • Basic understanding of REST APIs
  • Your preferred development environment set up

Step 1: Get Your API Key

  1. Log in to chat.aitronos.com
  2. Navigate to Settings → API Keys
  3. Click "Create New API Key"
  4. Copy and store your API key securely

Important: Your API key starts with ak_ and should be kept secure.

Step 2: Base URL

All API requests should be made to:

https://api.aitronos.com/v1/

Step 3: Authentication

Include your API key in every request using the X-API-Key header:

curl -H "X-API-Key: ak_your_api_key_here" \
  -H "Content-Type: application/json" \
  https://api.aitronos.com/v1/models

Install the Python SDK: pip install aitronos-sdk

Step 4: Your First Request

Let's make your first API call to list available AI models:

from aitronos import Aitronos

client = Aitronos(api_key="ak_your_api_key_here")
models = client.models.list_models(organization_id="org_your_org_id")
print(models)

cURL

curl -X GET "https://api.aitronos.com/v1/models" \
  -H "X-API-Key: ak_your_api_key_here"

Python

import requests

api_key = "ak_your_api_key_here"
headers = {"X-API-Key": api_key}

response = requests.get(
    "https://api.aitronos.com/v1/models",
    headers=headers,
)
print(response.json())

JavaScript

const apiKey = "ak_your_api_key_here";

const response = await fetch("https://api.aitronos.com/v1/models", {
  headers: { "X-API-Key": apiKey },
});
const data = await response.json();
console.log(data);

Step 5: Generate Your First AI Response

Now let's create an AI response:

Python SDK

from aitronos import Aitronos

client = Aitronos(api_key="ak_your_api_key_here")

result = client.responses.create_response(
    organization_id="org_your_org_id",
    model="gpt-4o",
    inputs=[{"role": "user", "content": "Hello, Freddy! How can you help me?"}],
)
print(result.response[0]["text"])

cURL

curl -X POST "https://api.aitronos.com/v1/model/response" \
  -H "X-API-Key: ak_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_id": "org_your_org_id",
    "model": "gpt-4o",
    "inputs": [{"role": "user", "content": "Hello, Freddy! How can you help me?"}]
  }'

Next Steps