DOCSEARCHbyAlgolia
Submit Docs

Sivi Developer Documentation

website·Indexed 34 days ago

https://developer.sivi.ai

Documentation for Sivi, an AI designer for generating product banners, ads, and visual content. Includes guides for the Sivi UI SDK for React integration and the Sivi API, featuring Core API for design generation and brand management, and the User Management API for superuser and enterprise account control.

Tokens
41.4K
Snippets
188
Records
265
Agent score
55%

What's inside Sivi

  1. Overview of Sivi UI SDK capabilities

    The Sivi UI SDK is a JavaScript-based toolkit providing pre-built UI components and widgets to integrate Sivi's AI design generation capabilities directly into web applications. It allows users to access AI-powered design tools without leaving the host platform and provides a faster implementation path than traditional API-based integrations.

  2. Overview of Sivi Design Generation

    Sivi is an AI-driven design generation platform that creates editable, multi-layered vector designs rather than flat raster images. Unlike standard AI image generation, Sivi produces designs where every element (typography, layout, colors, and shapes) can be individually edited, rearranged, or restyled. It supports any dimension and ensures pixel-perfect rendering without the imperfections typically found in AI-generated fonts or photos.

  3. Overview of Sivi Core API capabilities

    The Sivi Core API allows developers to integrate AI-driven design generation into applications. Key capabilities include generating professional designs from text prompts or structured content, supporting multiple digital design formats, and providing structured JSON responses. Access to the Core API requires a Power plan; however, an API Sandbox is available for testing.

  5. Overview of Sivi Enterprise API features

    The Sivi Enterprise API is available exclusively for users on the Enterprise plan. It provides advanced design generation capabilities and the following enterprise-specific benefits:

    • Higher Rate Limits: Increased API call quotas for generating more designs.
    • Priority Processing: Faster job processing via dedicated resources.
    • White-labeled Output: Ability to remove Sivi branding from generated designs.
    • Advanced Analytics: Detailed usage reporting and insights.
    • Advanced Customization: Deeper control over design generation parameters.
    • Custom Integrations: Support for custom enterprise-level integrations.
    • Dedicated Support: Direct access to the technical support team, including a priority Slack support channel.

  6. Available Industry IDs for brand personas

    The following IDs are valid values for the industry parameter in the Sivi API:

    • accounting_finance: Accounting & Finance
    • advertising: Advertising
    • agriculture: Agriculture
    • architecture: Architecture
    • art_design: Art & Design
    • automotive: Automotive
    • aviation: Aviation
    • banking: Banking
    • bar_nightclub: Bar & Nightclub
    • beauty_cosmetics: Beauty & Cosmetics
    • books_literature: Books & Literature
    • business_consulting: Business & Consulting
    • childcare: Childcare
    • cleaning_maintenance: Cleaning & Maintenance
    • clothing: Clothing
    • communications: Communications
    • community_non_profit: Community & Non-profit
    • computer_electronics: Computer & Electronics
    • construction: Construction
    • dating: Dating
    • design: Design
    • drinks: Drinks
    • economics: Economics
    • education: Education
    • engineering: Engineering
    • entertainment: Entertainment
    • entrepreneurship: Entrepreneurship
    • environment: Environment
    • events: Events
    • fashion: Fashion
    • fitness_wellness: Fitness & wellness
    • floral: Floral
    • food: Food
    • footwear: Footwear
    • gambling: Gambling
    • games: Games
    • health: Health
    • hobbies_recreation: Hobbies & Recreation
    • home_garden: Home & Garden
    • industrial: Industrial
    • internet: Internet
    • law: Law
    • management: Management
    • marketing: Marketing
    • medical_pharmaceutical: Medical & Pharmaceutical
    • movies: Movies
    • music: Music
    • news: News
    • nursing: Nursing
    • pets_animals: Pets & Animals
    • photography: Photography
    • political: Political
    • real_estate: Real estate
    • real_estate_mortgage: Real Estate & Mortgage
    • religious: Religious
    • restaurant_cuisine: Restaurant & Cuisine
    • retail: Retail
    • science: Science
    • security: Security
    • shopping: Shopping
    • small_business: Small business
    • sports: Sports
    • technology: Technology
    • toys: Toys
    • travel_hotel: Travel & Hotel
    • wedding: Wedding

  7. Compare Sivi UI SDK authentication methods

    The Sivi UI SDK supports two primary authentication approaches:

    1. Standard UI SDK Authentication: The default flow where users are redirected to Sivi's login page to authenticate.
    2. Superuser Based Authentication: A frictionless, programmatic machine-to-machine authentication flow that removes the need for end-users to create Sivi accounts or provide personal information to Sivi.

  8. Access the Sivi UI SDK Global Namespace

    When the Sivi UI SDK script loads, it creates a global SIVI object attached to the browser's window object. This object serves as the entry point for all methods used to interact with the widget.
    // Access the SIVI namespace
const siviSDK = window.SIVI;

  10. Understand the Sivi UI SDK superuser authentication and data flow

    In a superuser integration, the Sivi UI SDK uses a machine-to-machine authentication flow to eliminate the need for users to create separate Sivi accounts. The flow operates as follows:

    1. Token Request: The web application requests authentication tokens.
    2. Server-Side Exchange: The application server uses the Sivi API Key to request tokens for the users from the Sivi App Server.
    3. Validation: The Sivi App Server validates the request and returns authentication tokens to the web application.
    4. Widget Initialization: The web application provides these tokens to the Sivi Widget, which then manages token refreshing.
    5. Design Generation: Once authenticated, the Sivi Widget allows users to send design generation requests (prompts and content) directly to the Sivi App Server.

  11. Best practices for managing Sivi API quotas

    To avoid service interruptions and 429 errors, implement the following strategies:

    • Retry Logic: Use exponential backoff when encountering 429 responses.
    • Usage Monitoring: Actively track API consumption.
    • Request Optimization: Batch operations where possible to reduce the total number of API calls.
    • Caching: Cache design outputs to prevent redundant requests for the same content.