AlleAI TypeScript/JavaScript SDK

A TypeScript/JavaScript SDK for interacting with the AlleAI platform, providing seamless access to state-of-the-art AI models for image generation, audio processing, and video creation. Built with full TypeScript support while maintaining complete JavaScript (CommonJS) compatibility.

Features

• Full TypeScript Support – Includes comprehensive type definitions with IntelliSense and autocomplete for a smooth developer experience.
• Chat Completions API – Generate conversational responses using multiple AI models such as GPT-4o, O4-Mini, and Claude 3 Sonnet.
• Image Generation & Editing API – Create and manipulate high-quality images powered by models like DALL·E 3, Grok-2, and others.
• Audio API – Multi-model support for:
  • Text-to-Speech (TTS) – Convert text to natural-sounding audio.
  • Speech-to-Text (STT) – Transcribe spoken words into text.
  • Audio Generation – Produce unique audio content using generative AI.
• Video Generation API – Generate AI-powered videos with custom parameters, using different video models.
• JavaScript & TypeScript Compatible – Fully works in both CommonJS and ESM environments.

Installation

npm install alle-ai-sdk

Quick Start

Environment Setup

echo "ALLEAI_API_KEY=your_api_key_here" > .env

Initialize Client

TypeScript:

import { AlleAIClient } from 'alle-ai-sdk';
import dotenv from 'dotenv';

dotenv.config();

const alleai = new AlleAIClient({
  apiKey: process.env.ALLEAI_API_KEY
});

JavaScript (CommonJS):

const AlleAIClient = require('alle-ai-sdk');
require('dotenv').config();

const alleai = new AlleAIClient({
  apiKey: process.env.ALLEAI_API_KEY
});

Usage Examples

Chat Methods

Chat Completions

TypeScript:

import { AlleAIClient } from 'alle-ai-sdk';

async function runChat() {
  const alleai = new AlleAIClient({
    apiKey: process.env.ALLEAI_API_KEY
  });
  
  const chat = await alleai.chat.completions({
    models: ["gpt-4o", "yi-large", "gpt-3-5-turbo"],
    messages: [
      {
        system: [{
          type: "text",
          text: "You are a helpful assistant."
        }]
      },
      {
        user: [{
          type: "text",
          text: "What is photosynthesis?"
        }]
      }
    ],
    temperature: 0.7,
    max_tokens: 2000,
    frequency_penalty: 0.2,
    presence_penalty: 0.3,
    stream: false
  });
  console.log(chat);
}

runChat();

JavaScript (CommonJS):

const { AlleAIClient } = require('alle-ai-sdk');

async function runChat() {
  const alleai = new AlleAIClient({
    apiKey: process.env.ALLEAI_API_KEY
  });
  
  const chat = await alleai.chat.completions({
    models: ["gpt-4o", "yi-large", "gpt-3-5-turbo"],
    messages: [
      {
        system: [{
          type: "text",
          text: "You are a helpful assistant."
        }]
      },
      {
        user: [{
          type: "text",
          text: "What is photosynthesis?"
        }]
      }
    ],
    temperature: 0.7,
    max_tokens: 2000,
    frequency_penalty: 0.2,
    presence_penalty: 0.3,
    stream: false
  });
  console.log(chat);
}

runChat();

Model Combination

TypeScript:

import { AlleAIClient } from 'alle-ai-sdk';

async function runCombination() {
  const alleai = new AlleAIClient({
    apiKey: process.env.ALLEAI_API_KEY
  });
  
  const result = await alleai.chat.combination({
    models: ["gpt-4o", "llama-3-1-8b-instruct"],
    messages: [
      {
        system: [{
          type: "text",
          text: "You are a helpful assistant that provides comprehensive answers."
        }]
      },
      {
        user: [{
          type: "text",
          text: "Compare quantum computing with classical computing"
        }]
      }
    ],
    temperature: 0.7,
    max_tokens: 2000
  });
  
  console.log(result);
}

runCombination();

JavaScript (CommonJS):

const { AlleAIClient } = require('alle-ai-sdk');

async function runCombination() {
  const alleai = new AlleAIClient({
    apiKey: process.env.ALLEAI_API_KEY
  });
  
  const result = await alleai.chat.combination({
    models: ["gpt-4o", "llama-3-1-8b-instruct"],
    messages: [
      {
        system: [{
          type: "text",
          text: "You are a helpful assistant that provides comprehensive answers."
        }]
      },
      {
        user: [{
          type: "text",
          text: "Compare quantum computing with classical computing"
        }]
      }
    ],
    temperature: 0.7,
    max_tokens: 2000
  });
  
  console.log(result);
}

runCombination();

Model Comparison

TypeScript:

import { AlleAIClient } from 'alle-ai-sdk';

async function runComparison() {
  const alleai = new AlleAIClient({
    apiKey: process.env.ALLEAI_API_KEY
  });
  
  const comparison = await alleai.chat.comparison({
    models: ["gpt-4o-mini", "yi-large"],
    messages: [
      {
        system: [{
          type: "text",
          text: "You are a helpful assistant."
        }]
      },
      {
        user: [{
          type: "text",
          text: "Compare the approaches to async programming in Python and JavaScript."
        }]
      }
    ],
    comparison: [
      {
        type: "text",
        models: ["gpt-4o-mini", "yi-large"]
      }
    ],
    temperature: 0.7,
    max_tokens: 2000
  });
  
  console.log(comparison);
}

runComparison();

JavaScript (CommonJS):

const { AlleAIClient } = require('alle-ai-sdk');

async function runComparison() {
  const alleai = new AlleAIClient({
    apiKey: process.env.ALLEAI_API_KEY
  });
  
  const comparison = await alleai.chat.comparison({
    models: ["gpt-4o-mini", "yi-large"],
    messages: [
      {
        system: [{
          type: "text",
          text: "You are a helpful assistant."
        }]
      },
      {
        user: [{
          type: "text",
          text: "Compare the approaches to async programming in Python and JavaScript."
        }]
      }
    ],
    comparison: [
      {
        type: "text",
        models: ["gpt-4o-mini", "yi-large"]
      }
    ],
    temperature: 0.7,
    max_tokens: 2000
  });
  
  console.log(comparison);
}

runComparison();

Web-Enhanced Search

TypeScript:

import { AlleAIClient } from 'alle-ai-sdk';

async function runWebSearch() {
  const alleai = new AlleAIClient({
    apiKey: process.env.ALLEAI_API_KEY
  });
  
  const searchResponse = await alleai.chat.search({
    models: ["gpt-4o", "gpt-3-5-turbo"],
    messages: [
      {
        system: [{
          type: "text",
          text: "You are a helpful assistant with access to current information."
        }]
      },
      {
        user: [{
          type: "text",
          text: "What are the latest developments in quantum computing as of 2024?"
        }]
      }
    ],
    temperature: 0.7,
    max_tokens: 2000,
    response_format: { type: "text" }
  });
  
  console.log(searchResponse);
}

runWebSearch();

JavaScript (CommonJS):

const { AlleAIClient } = require('alle-ai-sdk');

async function runWebSearch() {
  const alleai = new AlleAIClient({
    apiKey: process.env.ALLEAI_API_KEY
  });
  
  const searchResponse = await alleai.chat.search({
    models: ["gpt-4o", "gpt-3-5-turbo"],
    messages: [
      {
        system: [{
          type: "text",
          text: "You are a helpful assistant with access to current information."
        }]
      },
      {
        user: [{
          type: "text",
          text: "What are the latest developments in quantum computing as of 2024?"
        }]
      }
    ],
    temperature: 0.7,
    max_tokens: 2000,
    response_format: { type: "text" }
  });
  
  console.log(searchResponse);
}

runWebSearch();

Image Generation

TypeScript:

import { AlleAIClient } from 'alle-ai-sdk';

async function generateImage() {
  const alleai = new AlleAIClient({
    apiKey: process.env.ALLEAI_API_KEY
  });

  const image = await alleai.image.generate({
    models: ["dall-e-3", "grok-2-image"],
    prompt: "futuristic city, flying cars, robotic pedestrians",
    width: 1024,
    height: 1024,
    style_preset: "digital-art",
    n: 1,
    seed: 8
  });
  console.log(image);
}

generateImage();

JavaScript (CommonJS):

const {AlleAIClient} = require('alle-ai-sdk');

async function generateImage() {
  const alleai = new AlleAIClient({
    apiKey: process.env.ALLEAI_API_KEY
  });

  const image = await alleai.image.generate({
    models: ["dall-e-3", "grok-2-image"],
    prompt: "futuristic city, flying cars, robotic pedestrians",
    width: 1024,
    height: 1024,
    style_preset: "digital-art",
    n: 1,
    seed: 8
  });
  console.log(image);
}

generateImage();

Image Editing

async function editImage() {
  const editedImage = await alleai.image.edit({
    models: ["dall-e-3"],
    prompt: "Add a lake in the foreground",
    image_file: "./input.jpg"
  });
  console.log(editedImage);
}

editImage();

Text-to-Speech

async function textToSpeech() {
  const speech = await alleai.audio.tts({
    models: ["elevenlabs-multilingual-v2", "gpt-4o-mini-tts"],
    prompt: "Hello! You're listening to a test of a text-to-speech model...",
    voice: "nova",
    model_specific_params: {
      "gpt-4o-mini-tts": {
        voice: "alternative-voice"
      }
    }
  });
  console.log(speech);
}

textToSpeech();

Speech-to-Text

async function speechToText() {
  const transcription = await alleai.audio.stt({
    models: ["whisper-v3"],
    audio_file: "./audio.mp3"
  });
  console.log(transcription);
}

speechToText();

Video Generation

async function generateVideo() {
  const video = await alleai.video.generate({
    models: ["nova-reel", "veo-2"],
    prompt: "robotic arm assembling a car in a futuristic factory",
    duration: 6,
    aspect_ratio: "16:9",
    fps: 24,
    dimension: "1280x720",
    resolution: "720p",
    seed: 8
  });
  console.log(video);
}

generateVideo();

Video Status Check

async function checkVideoStatus() {
  const status = await alleai.video.get_video_status("your-request-id");
  console.log(status);
}

checkVideoStatus();

Error Handling

async function handleError() {
  try {
    const result = await alleai.image.generate({
      models: ["dall-e-3"],
      prompt: "A beautiful sunset"
    });
    console.log(result);
  } catch (error) {
    if (error instanceof ValidationError) {
      console.error("Validation error:", error.message);
    } else {
      console.error("Other error:", error.message);
    }
  }
}

handleError();

Requirements

• Node.js 14 or higher
• Valid Alle-AI API key
• dotenv package for environment variable management

Support

For technical support and inquiries:

• Open an issue in our GitHub repository
• Contact our support team at contact@alle-ai.com

License

This project is licensed under the MIT License - see the LICENSE file for details.