AI Assistant

The AI Assistant uses artificial intelligence to help you design your API schema from natural language descriptions.

How It Works

1. Describe your schema in plain English
2. AI generates collections, properties, and relationships
3. Review the generated schema
4. Publish to your API with one click

Getting Started

Choose how to begin:

Option	Description
Use Existing Schema	Load your current schema and modify with AI
Create New Schema	Start fresh with a blank canvas

Writing Prompts

Be specific about what you need:

Create a blog with posts, comments, and authors.
Each post has one author, each author can have many posts.
Posts should have title, content, publishedDate, and isPublished.

The more detail you provide, the better the results.

Prompt Tips

• Name entities clearly — "users", "orders", "products"
• Describe relationships — "each order belongs to one user"
• Specify properties — "products have name, price, and description"
• Include data types — "price should be a number"

Schema Preview

View generated schemas in two ways:

View	Description
Graphic	Interactive diagram showing collections and relationships
Source	Raw JSON schema structure

Versioning

The AI tracks your conversation history:

• Each prompt creates a new schema version
• Switch between versions without losing work
• Compare different approaches

Publishing

Apply the generated schema:

1. Select the version you want
2. Click Publish
3. Confirm in the dialog

warning

Publishing replaces your entire API schema. Review carefully before publishing.

Iterative Refinement

Continue the conversation to refine your schema:

Add a status field to posts

Create a categories collection and link it to posts

Make incremental changes rather than big rewrites for best results.

Limitations

What AI Assistant can do:

• Generate collections and properties
• Create lookup relationships
• Infer data types from descriptions

What you'll configure manually:

• Access control rules
• Views and queries
• Advanced validation rules