PREDIS.AI EDITOR ===========================

PREDIS.AI EDITOR - ELEMENT DESCRIPTION
-----------------------------------------------------------------------
 PREDIS.AI EDITOR enables AI-generated creation and editing of branded social content, including ad videos and carousels.

STEP-BY-STEP SETUP
--------------------------------
 0) Register on Predis.ai and get your PREDIS APP ID and optionally your PREDIS SSO KEY to authenticate your automatically your users.

 1) In the Plugin Settings, enter your REDIS APP ID (& PREDIS SSO KEY) generated at the previous step.

 2) Add the PREDIS.AI EDITOR ELEMENT to the page on which the editor must be displayed.

 3) (Optional) If you have chosen to implement Single Sign-On (SSO), set in a workflow the PREDIS.AI - GENERATE SSO CREDENTIALS to generate the TOKEN required in OPEN POST CREATION & EDITING FLOW PREDIS.AI action.

 3) Integrate the logic into your application using the following PREDIS.AI EDITOR element's states and actions:

 FIELDS:
   BRAND INFORMATION
   - BRAND NAME: Name associated with the brand. This will show up on the UI In places where brand name is shown.
   - BRAND HASHTAGS: These hashtags will be appended to the AI generated caption. You can use it to add any text if needed.
   - BRAND LOGO URL: Logo associated with the brand. This will show up on the UI In places where brand name is shown.
   - BRAND WEBSITE: The Brand website will be shown on AI-generated creatives. This is shown only if the design has space for website text.
   - BRAND HANDLE: The Brand handle will be shown on AI-generated creatives. This is shown only if the design has space for the handle name text.
   - BRAND COLORS: The AI-generated creatives will be generated using these colors. Maximum 5 colors can be passed here as a list.
   EDITOR SETTINGS
   - SHOW ONBOARDING : Set to yes if you want users to experience the onboarding flow when they use the SDK for the 1st time.
   - WHITE LABEL LOGO : Set your logo URL to replace Predis.ai Logo in the SDK. This will take effect only with the Whitelabel SDK Addon available in the SDK pricing.
   - HIDE DOWNLOAD BUTTON : Set to yes to hide the Download button in the SDK library page and inside the editor. This is defaulted to false.
   - HIDE PUBLISH BUTTON : Set to yes to hide the Publish button in the SDK library page and inside the editor. This is defaulted to false.
   - CLOSE ON PUBLISH : Set to false to stop closing of SDK on clicking of publish button. This is used for cases where you want your users to close the SDK manually instead of doing it automatically. This is defaulted to true.


 EVENTS:
 - READY : Event triggered when a change to the edit session has been made. CURRENT EDIT DATA state is updated with the edit session data.
 - PUBLISH : Event triggered when the editor is loaded and ready. Triggered one.

 EXPOSED STATES:
 Use any element able to show/process the data of interest (such as a Group with a Text field) stored within the result of the following states of the PREDIS.AI EDITOR ELEMENT:
 - CAPTION : Caption of the generated asset. Populated upon PUBLISH event.
 - MEDIA TYPE : Media Type of the generated asset. Populated upon PUBLISH event.
 - THUMBNAIL URL : Thumbnail URL of the generated asset. Populated upon PUBLISH event.
 - MEDIA URL : Media URL of the generated asset. Populated upon PUBLISH event.
 
 ELEMENT ACTIONS - TRIGGERED IN WORKFLOW:
   - OPEN POST CREATION & EDITING FLOW
     Inputs Fields:
       - POST IDEA: Post idea to populate the Create Asset flow.
       ALLOWED MEDIA TYPE
       - SINGLE IMAGE : Set to yes to allow single image asset generation.
       - CAROUSEL : Set to yes to allow carousel asset generation.
       - VIDEO : Set to yes to allow video asset generation.
       BUSINESS DETAILS
       - BUSINESS DESCRIPTION : Brand's Business description.
       - BUSINESS PRODUCTS : Brand's products in list format.
       - BUSINESS AUDIENCE : Brand's Audience description.
       - BUSINESS BENEFITS : Brand's Benefits description.
       SINGLE SIGN-ON (SSO)
       - TOKEN: Enables you to implement SSO (Single Sign-On) for your users. In this case, must be set as result of PREDIS.AI - GENERATE SSO CREDENTIALS action.


5) Set-up the "SHOTSTACK - GET GENERATED ASSET" action in the workflow to retrieve the asset generated previously.
   Inputs Fields :
     - VERSION : Valid values: stage | v1
     - ASSET ID : The id of the asset file.
   Output Fields:
     - MESSAGE: Status message of the render.
     - ID: ID of the asset.


IMPLEMENTATION EXAMPLE
======================
Feel free to browse the app editor in the Service URL for an implementation example.

TROUBLESHOOTING
================
Any plugin-related error will be posted to the Logs tab, "Server logs" section of your App Editor.
 Make sure that "Plugin server side output" and "Plugin client side output" are selected in "Show Advanced".

> Server Logs Details: https://manual.bubble.io/core-resources/bubbles-interface/logs-tab#server-logs

PERFORMANCE CONSIDERATIONS
===========================
 N/A

QUESTIONS?
===========
Contact us at [email protected] for any additional features you would require or support questions.