Skip to main content

Overview: Sivi API

Welcome to the Sivi API documentation. Sivi is an AI designer that helps you generate product banners, ads, and other visual content according to your brand guidelines.

Base URLs​

The API is available in both staging and production environments:

  • Staging: https://connect.sivi.ai/api/staging/v2
  • Production: https://connect.sivi.ai/api/prod/v2

Authentication​

The API supports two authentication methods:

1. API Key Authentication​

Include your API key in the request header:

sivi-api-key: your-api-key-here

2. OAuth2 Client Credentials​

Enterprise Plan.

Response Format​

All responses are returned in JSON format with the following structure:

{
  "status": 200,
  "body": {
    // Response data
  }
}

Common Status Codes​

CodeDescription
200Successful operation
401Authentication failed
422Invalid input
500Server internal error

Core API​

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

Core API for more details.

User Management API​

User Management API is available for users with Superpower plan. Please refer the Sivi pricing plan

User Management API for more details.

Terms of Service​

By using the Sivi API, you agree to the Terms of Service.

Support​

For support inquiries, contact: support@sivi.ai