AISquare
Getting Started

Core Concepts

The entities behind the AISquare API and how they fit together, so the responses make sense.

A handful of entities show up across every endpoint. Learn them once and the API stops being a list of routes and starts being a model you can reason about.

AI Studio

An AI Studio is the container for AI content and the experiences built on it. It is the workspace where content is created, users interact with it, and engagement is tracked. Each studio has a unique url (its publication_custom_url), for example ai-research-studio, which is how you address it in requests.

Publication

A Publication is the entity behind a studio. It holds the metadata (name, logo, description), the visibility setting (public, private, or team), and the associated users (the creator and any co-creators). In most of the API, "publication" and "AI Studio" mean the same thing.

Experience and Resource

These two are easy to conflate, so keep the distinction sharp:

  • An Experience is a container: a topic, workflow, or module, such as "Advanced Machine Learning Models."
  • A Resource is an item inside an experience: the actual content.

One experience holds many resources. Resources come in a few types:

TypeDescription
AI_EXPERTInteractive expert systems
AI_NOTEInformational or educational content
QUESTTask-based or challenge-driven content
PODCASTAudio content

Flattened responses

Some endpoints return data in a flattened shape: one row per resource, with the parent experience repeated on each row. It looks redundant, and that is the point. A frontend can render the rows as a flat list with no extra joining. The Quickstart call uses this shape.

Creator and co-creators

Every studio has one creator, the owner who manages content and settings, and any number of co-creators, collaborators who can edit, review, or contribute. Each co-creator carries a role (such as editor or reviewer) and a status (invited or accepted). See working with creators for the API.

Metrics

AISquare tracks engagement across experiences and resources: views, likes, shares, bookmarks, and comments. These power ranking (trending and popular ordering), analytics, and personalization, and they appear on items in list responses.

Collections

A Collection is a curated, ordered group of experiences. Use collections to build learning paths or group related content. Like publications, they carry a visibility setting (public, private, team, or org).

Activity

AISquare records user activity across the platform: interactions, content engagement, and progress over time. This history is what feeds personalization and recommendations.

Permissions

Access to content depends on three things together: the publication's visibility, the user's role (creator, co-creator, or member), and their authentication status. Some endpoints additionally require workspace membership or owner access. See Permissions for the rules.

How it fits together

AI Studio (Publication)
 |-- Experiences
 |     '-- Resources (AI Expert, Note, Quest, Podcast)
 |-- Creator and co-creators
 |-- Collections (group experiences)
 '-- Metrics and Activity

Next steps

On this page