🚀 Quick Start - Trial User

Welcome to Alesqui Intelligence! This guide will help you start using the platform in just a few minutes.

What is Alesqui Intelligence?

Alesqui Intelligence is an AI-powered platform that allows you to interact with your APIs using natural language. Instead of manually crafting API requests, you can simply ask questions like:

"Get the user profile for john@example.com"
"List all active orders from the last week"
"Update the status of order #12345 to 'shipped'"

The AI understands your intent, automatically selects the right API from your configured sources, and executes the request for you.

🎯 Who is the Trial For?

The trial version is perfect for:

Developers exploring how AI can simplify API interactions
QA Engineers testing APIs conversationally
Product Managers understanding API capabilities without technical knowledge
Anyone who wants to try the platform before deploying it on-premise

✨ Trial Features

During your 14-day trial, you'll have access to:

✅ Upload Swagger/OpenAPI and Postman collections
✅ Configure multiple APIs with authentication (API Key, Bearer, Basic, OAuth2)
✅ Chat with your APIs using natural language (AI selects the right API automatically)
✅ Configure Read-Only mode to restrict operations to GET requests only
✅ Report issues with AI responses to help improve the platform
✅ View reported issues and diagnostics

⚠️ Trial Limitations

Duration: 14 days from registration
Rate Limits: One registration per IP address per 24 hours
Data Persistence: Trial data may be cleared periodically
No SLA: Best-effort availability

💡 For production use, companies can deploy Alesqui Intelligence on their own servers. See Distribution Repository.

📝 Step-by-Step Registration

1. Create Your Trial Account

Go to https://alesqui.com
Click "Start Free Trial"
Enter your email address
Check your inbox for the activation email

2. Activate Your Account

Open the email from Alesqui Intelligence
Click the "Activate My Account" button
Set your password
You're in! 🎉

3. Log In

Go to the login page
Enter your email and password
You'll be redirected to the main dashboard

🔧 Configuring Your First API

Once logged in, follow these steps to configure an API:

Step 1: Upload Your API Specification

Navigate to "API Configuration" tab
Upload your Swagger/OpenAPI file (JSON or YAML)
- Enter a unique name for your API (e.g., "User Management API")
- Optionally, add a description
Click "Upload Swagger"

Step 2: (Optional) Add Postman Collection

If you have a Postman collection with additional details (auth, examples, etc.):

Upload your Postman collection (JSON)
Click "Upload Postman"
Or skip this step if you only have Swagger

Step 3: Unify API Data

The system will merge Swagger and Postman data intelligently:

Click "Unify API" to proceed.

Step 4: Configure Execution Settings

Set up how the API should be called:

Authentication

Choose the authentication type that matches your API:

None: No authentication required
API Key: Header or query parameter-based authentication
Bearer Token: JWT or OAuth2 bearer tokens
Basic Auth: Username and password authentication
OAuth2: Full OAuth2 flow support

💡 The form will dynamically show the required fields based on your selection.

Timeouts & Retries

Timeout: Maximum time to wait for API response (default: 30 seconds)
Max Retries: Number of retry attempts on failure (default: 3)

Base URL

The URL where your API is hosted (e.g., https://api.example.com)

🔒 Read-Only Mode

This is an important security feature:

Enabled ✅: The AI agent can only execute GET requests (read operations)

Safe for exploring data without risk of modifications
Recommended for trial users and testing environments
Prevents operations like create, update, or delete

Disabled ❌: The AI agent can execute all HTTP methods (GET, POST, PUT, DELETE, PATCH)

Required for full API interaction
Use with caution in production environments
Ensure proper API permissions are in place

⚠️ Example: If Read-Only is enabled, queries like "Create a new user" or "Delete order #123" will be rejected.

Click "Save Configuration & Finish" ✅

💬 Chatting with Your APIs

Now the fun part! Let's interact with your API using natural language.

1. Go to the Chat Tab

Navigate to "Chat with APIs" in the top menu.

2. Start Asking Questions

Just type your question naturally! You don't need to select which API to use — the AI agent will automatically:

✨ Analyze your question
🔍 Find the most appropriate API from all your configured sources
🎯 Select the right endpoint
🚀 Execute the request with proper authentication

Example Queries

Example 1: Simple GET Request

Get the list of all users

Example 2: Filtered Query

Show me users created in the last 30 days

Example 3: POST Request (Only if Read-Only mode is disabled)

Create a new user with email "jane.doe@example.com" and name "Jane Doe"

Example 4: Update Request (Only if Read-Only mode is disabled)

Update user with ID 42 to set their status to 'active'

Example 5: Cross-API Query

Get the profile for user john@example.com and their recent orders

_The AI will automatically call the User API and then the Orders API! _

3. View the Response

The AI will show you:

📋 Response data
🧠 AI reasoning (optional: shows how the AI interpreted your query)

🚨 Reporting Issues

If the AI agent gives you an unexpected response or doesn't understand your query correctly, you can report the issue:

How to Report

After receiving a response in the chat, click the "Report issue" button
Optionally, add a comment explaining the problem
Click "Submit Report"

Why Report Issues?

For Trial Users:

📊 Your reports help us improve the AI agent
🐛 We can identify patterns and fix bugs
💡 Real-world feedback helps refine the platform

For On-Premise (Corporate) Users:

🔧 IT teams can monitor reported issues to detect:
- API problems (wrong responses, authentication failures)
- Documentation gaps (incomplete or incorrect Swagger specs)
- Missing endpoints that need to be added
📈 Helps improve internal API quality over time

🔍 Diagnostics & Issue Tracking

The Diagnostics tab is where you can review all reported issues.

What You'll See

Navigate to "Diagnostics" in the top menu
View a list of all reported issues:
- User query that caused the problem
- AI response that was flagged
- Status (Open, Resolved)
- Timestamp of when it was reported
- Optional comment from the user

For Trial Users

You can see your own reported issues
Track if they've been addressed by the Alesqui team

For IT Teams (On-Premise)

See all issues reported by your company's users
Identify patterns (e.g., "The Payment API fails 80% of the time")
Export issue data for analysis

💡 Pro Tip: Regularly review diagnostics to improve your API documentation and configurations!

🛠️ Tips for Best Results

✅ DO:

Use clear, specific language ("Get user with ID 123" instead of "user 123")
Provide parameter values when needed ("email: john@example.com")
Check the Diagnostics tab to review any reported issues
Enable Read-Only mode when testing new APIs for the first time

❌ DON'T:

Use vague queries ("show me stuff")
Expect the AI to guess missing parameters (be explicit!)
Forget to configure authentication if your API requires it

🆘 Troubleshooting

Issue: "Authentication failed (401)"

Solution: Double-check your API credentials in the API configuration settings.

Issue: "Timeout error"

Solution: The API might be slow. Increase the timeout in configuration settings.

Issue: "Operation not allowed (Read-Only mode)"

Solution: You're trying to execute a POST/PUT/DELETE request, but Read-Only mode is enabled. Disable it in the API configuration if you have the necessary permissions.

Issue: "AI doesn't understand my query"

Solution: Rephrase your question more explicitly (e.g., "Get the user profile for ID 5"). If it still fails, report the issue!

Issue: "No API found for this request"

Solution: Make sure you've configured at least one API that matches your query. The AI needs a relevant API specification to work.

📧 Need Help?

If you encounter any issues during your trial:

Email: support@alesqui.com
Documentation: GitHub Repository

⏰ Trial Expiration

Your trial will expire 14 days after activation.

What happens when the trial ends?

You'll lose access to the web platform
Your configured APIs and chat history will be deleted
To continue using Alesqui Intelligence, your company can deploy it on-premise

👉 Interested in self-hosting? See Distribution Repository

🎓 Next Steps

Now that you've completed the quick start:

✅ Configure more APIs (the AI can work with multiple APIs simultaneously)
✅ Experiment with different query styles (compare simple vs. detailed queries)
✅ Report any issues you encounter (we'd love to hear from you!)
✅ Measure the impact (track how much time you save)
✅ Consider self-hosted deployment for production use

💡 Pro Tip: Make the most of your 14-day trial by testing with real APIs from your organization. This will give you the best sense of how Alesqui Intelligence can help your team!

🚀 Ready for Production?

If you're ready to deploy Alesqui Intelligence on your own infrastructure, visit the Distribution Repository for deployment guides and configuration examples.

Enjoy your trial! 🎉

If you have any questions, don't hesitate to reach out.

Documentation