Skip to content

Oaktis Documentation

🔗 Try Oaktis → https://oaktis.com

Welcome to the official documentation for Oaktis - AI-powered image & video generation platform.

What is Oaktis?

Oaktis is a powerful API platform that enables developers to create images and videos using advanced AI models. Simply provide a text prompt, and Oaktis generates high-quality visual content for your applications.

Key Features

  • 🎬 Video Generation - Create AI-powered videos from text descriptions
  • 🖼️ Image Generation - Generate images with state-of-the-art AI models
  • ⚡ Fast & Scalable - Built for production workloads
  • 🔧 Multiple SDKs - JavaScript, Python, CLI, and Docker support
  • 📝 Type-Safe - Full TypeScript and Python type definitions
  • 🌐 RESTful API - Simple HTTP API for any language

Quick Start

JavaScript/TypeScript

npm install @ververv/oaktis-sdk

import { OaktisClient } from '@ververv/oaktis-sdk';

const client = new OaktisClient({ apiKey: 'your-api-key' });

// Generate a video
const job = await client.video.generate({
  prompt: 'a cat surfing on ocean waves',
  duration: 5,
  resolution: '1080p'
});

console.log('Video URL:', job.videoUrl);

Python

pip install oaktis

from oaktis import OaktisClient, VideoGenerateParams

client = OaktisClient(api_key="your-api-key")

# Generate a video
job = await client.video.generate(
    VideoGenerateParams(
        prompt="a cat surfing on ocean waves",
        duration=5,
        resolution="1080p"
    )
)

print(f"Video URL: {job.video_url}")

CLI

npm install -g oaktis-cli

# Generate a video
oaktis video "a cat surfing on ocean waves" --duration 5 --resolution 1080p

Docker

docker pull oaktis/cli:latest

docker run -e OAKTIS_API_KEY=your-api-key \
  oaktis/cli video "a cat surfing"

Getting Your API Key

To use Oaktis, you'll need an API key. Get started at:

👉 oaktis.com

SDK Packages

Package Platform Installation
@ververv/oaktis-sdk npm npm install @ververv/oaktis-sdk
oaktis PyPI pip install oaktis
oaktis-cli npm npm install -g oaktis-cli
oaktis/cli Docker docker pull oaktis/cli

Examples

Video Generation

// Basic video generation
const job = await client.video.generate({
  prompt: 'a mountain landscape at sunset'
});

// Advanced options
const job = await client.video.generate({
  prompt: 'a futuristic city with flying cars',
  duration: 10,
  resolution: '4k'
});

Image Generation

// Generate a single image
const job = await client.image.generate({
  prompt: 'abstract geometric art',
  size: '1024x1024'
});

// Generate multiple images
const job = await client.image.generate({
  prompt: 'serene beach at sunset',
  size: '1024x1024',
  n: 3
});

Next Steps

Community & Support

License

All Oaktis SDKs are open source under the MIT License.