Product

AI Studios

View as Markdown

This guide explains how to work with AI Studio-related APIs in AISquare.

Overview

AI Studio endpoints provide access to:

  • Publication-level data
  • Experiences and resources
  • Creators and collaborators
  • Engagement and metrics
  • User-specific data

All endpoints are scoped to a publication, identified by a unique URL.

Working with a publication

Most AI Studio endpoints require a publication identifier.

Request body

1{
2  "url": "ai-research-studio"
3}

Notes

  • url refers to the publication custom URL
  • Required for most POST-based endpoints
  • Used to scope results to a specific AI Studio

Experience resources (flattened)

Retrieve experience resources in a flattened format.

Endpoint

POST /api/v1/aistudios/experiences/flattened/

Query parameters

ParameterDescription
categoryFilter by category ID
category_nameFilter by category name
searchSearch content
typeAI_EXPERT, AI_NOTE, QUEST
orderingSorting
pagePage number
page_sizeResults per page

Response

  • Paginated list of resources
  • Each item represents one resource
  • Includes experience, resource, creator, and metrics data

Community pulse

Retrieve trending resources for a publication.

Endpoint

POST /api/v1/aistudios/community-pulse/

Query parameters

ParameterDescription
limitNumber of resources (default 5, max 10)

Response

  • List of trending resources
  • Includes pulse descriptions for each item

Continue where left off

Retrieve recently viewed resources for the user.

Endpoint

POST /api/v1/aistudios/continue-where-left-off/

Query parameters

ParameterDescription
limitNumber of resources (default 5, max 10)
pagePage number
page_sizeResults per page

Response

  • Paginated list of recently viewed resources
  • Includes experience, resource, and interaction details

Creator profiles

Retrieve detailed creator and co-creator profiles.

Endpoint

POST /api/v1/aistudios/creator-profiles/

Response

  • Publication details
  • Creator profile
  • Co-creator profiles

Co-creators

Retrieve co-creators with minimal user details.

Endpoint

POST /api/v1/aistudios/co-creators/

Query parameters

ParameterDescription
searchSearch by username or name
pagePage number
page_sizeResults per page

Retrieve tags ranked by content usage.

Endpoint

POST /api/v1/aistudios/popular-tags/

Query parameters

ParameterDescription
searchSearch tags
pagePage number
page_sizeResults per page

Response

  • Paginated list of tags
  • Includes content_count

Professional history

Retrieve work experience history for a user.

Endpoint

POST /api/v1/aistudios/professional-history/{username}/

Path parameters

ParameterDescription
usernameUser identifier

Response

  • List of work experiences
  • Includes role, company, dates, and description

Expertise focus

Retrieve distribution of experience categories for a user.

Endpoint

POST /api/v1/aistudios/expertise-focus/{username}/

Path parameters

ParameterDescription
usernameUser identifier

Response

  • Category names with counts

Metrics

Retrieve analytics for a publication.

Owner metrics

POST /api/v1/aistudios/metrics/
  • Restricted to owner or co-creator

Public impact

POST /api/v1/aistudios/public-impact/
  • Available to authenticated users

Permissions

Validate access to a publication.

Endpoint

POST /api/v1/aistudios/permission/

Behavior

  • Validates access
  • May set workspace context
  • Returns status based on access

Notes

  • Most endpoints require authentication
  • Most endpoints require url in request body
  • Responses are typically paginated
  • Data is scoped to a publication