Skip to main content

Create with AI

Create with AI generates a complete starting schema for a new API from a plain-language description — collections, properties, data types, and the relationships between them.

Available at creation time only

AI schema generation is part of the API creation flow — it's there to get you started. Once your API is created, it no longer appears in the portal; you evolve the schema with the Schema Editor (Collections, Views, Queries) or the JSON Definition.

Generating a Schema​

  1. From your tenant's APIs page, click Create with AI
  2. Describe your API in plain language:
A blog with posts, comments, and authors.
Each post has one author and many comments.
Posts have title, content, publishedDate, and isPublished.
  1. Review the generated draft — the API name, description, and every collection with its properties
  2. Refine it by continuing the conversation
  3. Click Create to publish the schema as your new API

What It Generates​

  • Collections with typed properties (string, text, integer, decimal, boolean, date, date-time, guid, object, blob)
  • Relationships — lookup properties referencing other collections, including the built-in user, role, and userRole collections (e.g. a post's author referencing user)
  • File attachments — images, documents and other uploads modeled as blob properties

Every collection automatically gets an id — you never define one yourself.

Refining Before You Create​

Keep the conversation going until the draft matches what you need:

Add a categories collection and link it to posts.
Make email required and unique on authors.

Small, incremental instructions give the best results.

After Creation​

From here on, all schema changes happen in the portal:

  • Schema Editor — collections, properties, views, and queries
  • JSON Definition — edit the schema as JSON
  • Data Explorer — browse and edit your data

Limitations​

Create with AI generates collections, properties, and lookup relationships. It does not configure:

  • Access control rules
  • Views or queries
  • Functions
  • Advanced validation

Set those up in the portal after your API is created.

Last updated on