Sivi Core API

Note: Core API is available for users with Power plan. API Sandbox available for testing. Please refer the Sivi pricing plan

The Sivi Core API provides powerful design generation capabilities for developers, startups, and businesses. It offers a cost-effective way to integrate Sivi's AI-driven design generation into your applications and workflows.

Core API Features

• Design Generation: Create professional designs using text prompts or structured content
• Multiple Design Types: Support for various design formats across digital platforms
• RESTful API: Simple, standards-compliant API design
• Webhook Support: Receive notifications when design jobs complete
• JSON Responses: Clean, structured response data
• Transparent Pricing: Pay only for what you use
• Developer Resources: SDKs, code samples, and comprehensive documentation
• Community Support: Access to community resources and help

API Documentation

The Core API provides access to all low-level Sivi design generation capabilities.

Core Endpoints

• Designs from Prompt: Generate designs using natural language prompts
• Designs from Content: Generate designs using structured content
• Content from Prompt: Create content suggestions using natural language prompts
• Get Design Variants: Retrieving design variants from your account
• Request Status: Monitor the status of design generation requests

Common Reference

• Introduction to Sivi API: Overview of the Sivi API platform and capabilities
• Design Types & Dimensions: Complete reference of supported design formats and dimensions
• Supported Languages: Complete list of supported languages for all API endpoints
• Asset Types: Complete list of supported asset types and options for all API endpoints
• Content Block Types: Complete list of supported text content block types for all API endpoints
• Brand Persona Details: Complete list of supported brand persona parameters

Testing

Try testing Core API with below links:

• Core API: Interactive testing for Core API

Getting Started

To get started with the Core API, sign up for a Sivi account and generate your API key.

Authentication

All API requests require authentication using your API key. Include your API key in all requests:

sivi-api-key: YOUR_API_KEY

Enterprise API

For higher rate limits, consider upgrading to the Enterprise Plan

Note: Enterprise APIs have exclusively endpoints. And require an Enterprise account API key.

POST enterprise/<API_ENDPOINT>

Additionally. Enterprise API can call these apis on behalf of your end-users with an additional parameter

"abstractUserId": "281743-2322-34i44sd3-dkfjgdkjf292"

| abstractUserId | string | No | Unique identifier for the user to generate design. If provided, designs will be generated for the specified user. If not provided, designs will be generated for the authenticated API_KEY user. |