Documentation / getting started

From install to first review.

1. Install the add-on

When a download is available, use Blender’s Preferences → Add-ons → Install from Disk and select the add-on ZIP. For an update, disable the older version and restart Blender first. Enable SYNAE, then open the SYNAE tab in the 3D Viewport sidebar.

2. Connect your account (optional)

Open SYNAE → Sign In with your SYNVFX account. The official Cloud connection is already configured. Click Test Connection to confirm availability; it makes no AI request and uses no credits. Local analysis is ready even when you are signed out.

3. Analyze your first scene

Describe your project and choose its stage. Click Analyze Scene. Standard analysis gives a bounded review; Deep adds topology and local asset checks. Read each finding’s explanation and tradeoffs. No account or network connection is required for local analysis.

4. Choose optional AI

Select SYNAE Cloud to use an enabled beta account. Acknowledge sharing, sign in and refresh Account / Usage. The official Cloud service is preconfigured. Test Connection checks it without using AI credits; API settings are available only under Advanced / Developer, with Restore Default for troubleshooting. You can instead select My OpenAI API Key, or keep AI Disabled.

5. Review before changing

View AI Context shows the structured facts to be sent. Quick Review, Deep AI Review, Optimize Scene, Troubleshoot, Quality Review, Production Review and Ask SYNAE are manual requests. Cloud AI is not yet available during this beta. Only a limited set of existing safe settings has an Apply action; other advice requires your judgment. Review every proposed change and use Undo Recommendation when appropriate.

Connection help

If Cloud cannot be reached, check your connection and retry Test Connection. Use the latest add-on build. An expired session needs a new sign-in; an exhausted allowance does not prevent local analysis. SYNAE Settings → Diagnostics → Copy Diagnostic Report copies service state without credentials or private paths. For custom staging or self-hosted development, Advanced / Developer contains the API address and Restore Default; changing it signs you out.

Credits and sessions

Cloud credits are checked by the service, not by the website. Review types can have different costs. Your account shows the authoritative remaining allowance. Website and Blender sessions stay in memory, so you sign in again after reloading or restarting. BYOK does not use Cloud credits.