Skip to content

Latest commit

 

History

51 Commits

Folders and files

Repository files navigation

Sivi AI Developer Documentation - Complete API & SDK Guide for AI Design Generation

Welcome to the official Sivi AI Developer Documentation - your comprehensive resource for integrating AI-powered design generation into your applications. This documentation covers everything developers need to build with Sivi's advanced generative AI design APIs and UI SDKs.

What is Sivi AI for Developers?

Sivi AI provides powerful AI-driven design generation APIs that transform text prompts and content into professional, editable, multi-layered vector designs. Unlike traditional AI image generators, Sivi creates programmatically accessible designs with separate layers for text, images, logos, shapes, and colors - perfect for developer integration.

Key Developer Features:

  • RESTful APIs for programmatic design generation
  • JavaScript UI SDK for rapid frontend integration
  • Multi-layered vector designs (not just images)
  • Brand-consistent API responses using custom assets
  • Enterprise-grade user management and authentication
  • Webhook support for asynchronous processing
  • Cross-platform compatibility for web, mobile, and server applications

API Documentation Overview

🚀 Sivi Core API - Programmatic Design Generation

Complete RESTful API suite for server-side design generation and management:

Design Generation APIs

  • Designs from Prompt - Generate designs using natural language prompts
  • Designs from Content - Create designs from structured content and assets
  • Content from Prompt - Extract structured content from text prompts
  • Design Variants - Generate multiple variations of existing designs
  • Request Status - Monitor asynchronous design generation jobs

User Management APIs

  • User Authentication - Login and session management
  • Brand Management - Set and extract brand assets programmatically
  • User Plan Management - Handle subscription and credit management
  • User Lifecycle - Create, update, deactivate, and reactivate users

Enterprise APIs

  • Bulk Operations - Handle large-scale design generation
  • Advanced Authentication - Enterprise SSO and security features
  • Custom Branding - White-label API integration

🎨 Sivi UI SDK - Frontend Integration Components

Ready-to-use JavaScript SDK for rapid frontend development:

Core SDK Features

  • Installation & Configuration - Quick setup for web applications
  • Authentication Integration - Seamless user authentication
  • Widget Functions & Events - Interactive design generation components
  • Sample Usage Examples - Production-ready code samples

Superuser Features

  • Enterprise Onboarding - Advanced user management
  • Superuser Authentication - Administrative access controls
  • Brand Setup Management - Programmatic brand configuration
  • Advanced Widget Configuration - Custom UI component settings

Integration Approaches

When to Use Sivi Core API

Perfect for developers who need:

  • Backend Integration - Server-side design generation
  • Custom Workflows - Build unique design generation experiences
  • Programmatic Control - Automated design creation processes
  • Cross-Platform Development - Use across web, mobile, and desktop
  • Enterprise Integration - Integrate with existing business systems

Example Use Cases:

  • Automated social media content generation
  • E-commerce product design automation
  • Marketing campaign asset creation
  • White-label design platform development

When to Use Sivi UI SDK

Ideal for developers who want:

  • Rapid Development - Pre-built UI components
  • Frontend Focus - Client-side design generation
  • Consistent UX - Standardized design interfaces
  • Minimal Backend - Reduce server-side complexity
  • Quick Prototyping - Fast proof-of-concept development

Example Use Cases:

  • SaaS application design features
  • Content management system integration
  • Marketing tool enhancement
  • Design collaboration platforms

API Architecture & Design Patterns

Design Generation vs. Image Generation APIs

Sivi Design Generation API Traditional AI Image APIs
Multi-layered vector responses Single-layer raster images
Editable JSON design structure Static image files
Brand-consistent asset handling Distorted logo/text rendering
Programmatic element control Limited post-generation editing
Custom dimensions support Fixed aspect ratio constraints

API Response Structure

Sivi APIs return structured design data enabling:

  • Layer Management - Individual element manipulation
  • Asset References - Organized brand asset usage
  • Styling Information - Colors, fonts, and positioning data
  • Export Options - Multiple format generation (SVG, PNG, PDF)
  • Metadata - Design analytics and generation insights

Developer Resources

Authentication & Security

  • OAuth 2.0 implementation
  • API key management
  • Rate limiting and usage quotas
  • Enterprise security features
  • CORS configuration

API Reference

  • Complete endpoint documentation
  • Request/response schemas
  • Error handling guides
  • Rate limiting information
  • Webhook configuration

SDK Documentation

  • Installation guides
  • Configuration options
  • Event handling
  • Custom styling
  • Performance optimization

Code Examples

  • Production-ready samples
  • Integration patterns
  • Best practices
  • Error handling
  • Performance tips

Developer Topics

This documentation provides comprehensive guidance for:

API Integration:

  • AI design generation API
  • Generative AI for developers
  • Design automation API
  • Vector design generation
  • Multi-layer design API

SDK Development:

  • JavaScript design SDK
  • Frontend design integration
  • React design components
  • Vue.js design widgets
  • Angular design modules

Enterprise Features:

  • Enterprise design API
  • White-label design platform
  • Bulk design generation
  • Brand management API
  • User management system

Technical Implementation:

  • RESTful design API
  • Webhook integration
  • Asynchronous design processing
  • Cross-platform design SDK
  • Programmatic brand management

Development Resources

  • API Playground: Test endpoints interactively
  • SDK Examples: Production-ready code samples
  • Swagger Documentation: Complete API reference
  • Developer Community: Connect with other developers

Support & Community

  • Developer Support: support@sivi.ai
  • API Documentation: Complete technical reference
  • GitHub Examples: Open-source integration samples
  • Developer Community: Forums and discussions
  • Enterprise Support: Dedicated technical assistance


Build the future of design with AI. Integrate Sivi's powerful design generation APIs and SDKs into your applications today.

Releases

Packages

Contributors

Languages