Skip to main content

Overview: Sivi API

Welcome to the Sivi Gen-2 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​

Coming Soon.

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

Rate Limiting​

Please contact support for information about rate limits for your specific plan.

Terms of Service​

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

Support​

For support inquiries, contact: support@sivi.ai