Skip to main content
This guide walks you through setting up the Aletyx AI Assistant in the Aletyx Playground: subscribing, creating your API key, and connecting it to the editor. By the end, you’ll be chatting with the assistant about a decision model.
What you need
  • An email address and a payment card. The subscription starts with a 14-day free trial - your card is saved but not charged today, and you can cancel anytime before the trial ends without being charged.
  • A browser open at playground.aletyx.ai.

Setup

1

Open the Aletyx Playground

Go to playground.aletyx.ai. From the home screen you can create a new Decision, Decision Table, or Workflow, import existing files, or open a ready-made example with Try sample. To follow along, click Try sample under Decision.The Aletyx Playground home screen, with Create and Import options
2

Open a decision model in the editor

The sample opens a Loan Pre-Qualification DMN model in the decision editor. Notice the floating Aletyx AI button at the bottom-right of the canvas - that’s where the assistant lives.The decision editor showing the sample model and the floating Aletyx AI button
3

Click Aletyx AI - the assistant is disabled at first

Click the Aletyx AI button. The assistant panel opens and shows AI Assistant disabled: you can add an API key in Settings → AI Assistant, or subscribe first. Since you don’t have a key yet, click Subscribe.The Aletyx AI Assistant panel showing it is disabled, with Open Settings and Subscribe optionsThe Loan Pre-Qualification sample you’re looking at is a DMN model that automates loan pre-qualification: it evaluates whether an applicant qualifies for a requested loan product based on their financial profile and creditworthiness. It takes three inputs - Applicant Data (personal and financial information such as income, expenses, and debts), Requested Product (loan type, amount, rate, and term), and the applicant’s FICO Credit Score.From those inputs it works through three intermediate decisions: a Credit Score Rating that maps the FICO score to a category from Excellent to Bad, a Front End Ratio that checks housing affordability (monthly PITI payment vs. income, acceptable up to 28%), and a Back End Ratio that checks the overall debt burden (debt-to-income, acceptable up to 36%). A final decision table combines them - a Poor or Bad credit rating or an insufficient ratio means Not Qualified - and outputs the qualification status along with a reason explaining the decision.
4

Start your trial

The Get Started with Aletyx AI Assistant checkout opens at my.aletyx.ai/ai-assistant. Enter your name, email, and payment method, pick your country, tick I agree to the Terms of Service and Privacy Policy, and click Start trial. There’s no charge today - the card is only captured for after the trial.The Get Started with Aletyx AI Assistant checkout form
5

Wait for the checkout to complete and open the welcome email

The checkout confirms each stage as it finishes: Account Creation, Activating Account, and Payment Processing. When you see You’re all set!, check your email inbox for a link to access your dashboard.The checkout confirmation showing account creation, activation, and payment completedYou’ll receive a Welcome to Aletyx AI Assistant email confirming your account was created. Click Log In to Dashboard to open My Aletyx.The welcome email with the Log In to Dashboard button
6

Sign in with a magic link

My Aletyx signs you in with a magic link - no password needed. Click Send Magic Link, then open the link from your inbox. The link expires after first use or 15 minutes.The My Aletyx sign-in screen with the Send Magic Link button
7

Open your dashboard

Your My Aletyx dashboard greets you with Get started in 2 steps: create an API key, then add it to the editor. Click Open API Keys to jump straight to the API Keys page.The My Aletyx dashboard home with the Get started in 2 steps card
8

Create the API key

The AI Assistant section is where you manage your plan, credit, API keys, and invoices. On the API Keys tab, click + New API Key.The API Keys tab, empty, with the + New API Key buttonIn the Create API Key dialog, give the key an optional description (for example, “Playground AI Assistant”) and choose whether it expires - No expiration is fine for personal use. Click Create API Key.The Create API Key dialog with a description and no expiration
9

Copy the key - it's shown in full only once

The new key appears with an API Key created! banner. Copy it now - it won’t be shown again in full. If you lose it, revoke it from this list and create a new one.The API key created banner with the full key ready to copy
Keep your API key secretThe API key authenticates you individually - anyone who has it can use the assistant on your account and spend your credit. Don’t save it unprotected in plaintext (notes, code, shared documents, or chat). If you need to store it, use a password manager or secrets vault, and if a key is ever exposed, revoke it from the API Keys list and create a new one.
10

Paste the key into the Playground settings

Back in the Playground, click the gear icon (top-right) and open the AI Assistant tab in Settings. Paste the key into the API Key field - it’s validated automatically, and the status shows API key is valid. The key is stored in your browser only and sent with each AI request.The Playground Settings AI Assistant tab showing a valid API key
11

Start chatting with the assistant

Close Settings and click the Aletyx AI button again. The assistant is now active - ask it something about your model, like “Explain this decision model in plain language,” or describe a change you want and review its suggestion.The Aletyx AI Assistant explaining the Loan Pre-Qualification model in chat
Your API key stays in your browserThe key is saved in your browser on this computer only - it isn’t shared with other people or devices. If you switch computers, paste it again. To turn the assistant off on a computer, clear the API Key field in Settings.

Next steps

  • Ask the assistant to build or change a model by describing it - naming the fields, values, and conditions you want gives much better results than a vague request.
  • Manage your plan, credit, and invoices anytime at my.aletyx.ai.

References