Sivi User Management API
Note: User Management API is available for users with Superpower plan. Please refer the Sivi pricing plan.
The Sivi User Management API provides powerful user management capabilities for businesses. It offers a cost-effective way to integrate your end-user accounts with your workflows. This helps you abstract user details from Sivi.
User Management API Features
- User Management: Create, update, and manage users
- RESTful API: Simple, standards-compliant API design
- 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 User Management API provides access to all low-level Sivi user management capabilities.
Note: End-user's usage credits will be debited from the master user's credits. Once the master user's credits is exhausted, all the end-users will not be able to generate designs or content until the next billing cycle. API's will start throwing error with 429 status code.
User Endpoints
- Login User: Login user to Sivi
- Set Credit Limit: Set credit limit for user
- Delete User: Delete user
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
Getting Started
To get started with the User Management 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: They have exclusively endpoints. And require an Enterprise account API key.
POST enterprise/<API_ENDPOINT>