Presets

The Presets API provides comprehensive endpoints for managing presets in the Onlive system. These endpoints allow you to create, retrieve, update, and delete presets, as well as manage related multimedia assets.

🔐 Authentication

All Presets API endpoints require authentication using the ONLIVESITE authentication scheme. Include the following header in all requests:

Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

📌 Available Endpoints

Preset Management

• Create Preset - Create a new preset configuration
• Get Preset - Retrieve specific preset details
• List Presets - Get a paginated list of presets with filtering options
• Update Preset - Modify an existing preset's information
• Delete Preset - Remove a preset configuration

💡 Common Use Cases

• Creating standardized preset configurations for your organization
• Managing preset multimedia assets
• Organizing presets with products and effects
• Preset search and filtering
• Integrating presets with other Onlive services

For detailed information about specific operations, please refer to the individual endpoint documentation sections.

API requests are subject to rate limiting to ensure optimal performance. Please contact our support team for your specific rate limits.

🔄 Preset Lifecycle

Presets go through the following lifecycle in the Onlive system:

1. Creation: A new preset is created with required configuration
2. Configuration: Assets, products, and effects are associated with the preset
3. Usage: The preset is used by applications and services
4. Updates: Configuration and associations are updated as needed
5. Deletion: When no longer needed, the preset can be deleted

🔌 Integration with Other Services

Presets can be integrated with other Onlive services in various ways:

• Multimedia Integration: Associate multimedia assets for consistent configurations
• Product Catalog: Link presets with specific products for coordinated experiences
• Effects Application: Apply visual effects to enhance the presentation
• Template Usage: Use presets as templates for creating new configurations

🔐 Security Considerations

• All API endpoints require proper authentication
• Operations are restricted based on organization membership and user permissions
• Presets are isolated between organizations, ensuring data security
• Resource limits may be applied based on your organization's plan

🧰 Development Tips

• Use the API to create and manage presets programmatically
• Consider preset dependencies when updating or deleting
• Create presets with clear naming conventions for easier management
• Leverage the search functionality to find relevant presets quickly

Errors

Common error responses:

Status Code	Description
400	Bad Request - Invalid input parameters
401	Unauthorized - Missing or invalid authentication
404	Not Found - Requested resource does not exist
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error - Something went wrong