***

title: API Reference
subtitle: Complete reference for the AISquare Studio API
slug: api-reference
-------------------

The AISquare Studio API provides programmatic access to the full AISquare platform — AI Studios, experiences, collections, community, analytics, and more.

***

## Base URL

All API endpoints are available under:

```
https://api.aisquare.com/api/v1/
```

***

## Authentication

AISquare supports two authentication methods:

| Method         | Header / Location  | Description                               |
| -------------- | ------------------ | ----------------------------------------- |
| **API Key**    | `X-API-KEY` header | Server-to-server and partner integrations |
| **Cookie JWT** | `access` cookie    | Browser-based sessions                    |

For most integrations, use the API key:

```
X-API-KEY: <your_api_key>
```

See [Authentication](/docs/getting-started/authentication) for detailed setup instructions.

***

## API groups

The API is organized into the following groups:

| Group             | Description                                                   |
| ----------------- | ------------------------------------------------------------- |
| **AI Studios**    | Publication data, experiences, creators, metrics, permissions |
| **Activity**      | User activity tracking and history                            |
| **Bookings**      | Cal.com scheduling integration                                |
| **Collections**   | Create and manage curated experience groups                   |
| **Community**     | Contributors, events, and public discovery                    |
| **Content Vault** | RAG document management and Google Drive integration          |
| **Enterprises**   | Enterprise domain management and OIDC SSO                     |
| **Experiences**   | Create, manage, publish, and generate AI experiences          |
| **GTM Studio**    | Go-to-market discovery, outreach, and video generation        |
| **IAM**           | User accounts, profiles, authentication, social login         |
| **Invites**       | Workspace invitation management                               |
| **Memberships**   | Workspace membership management                               |
| **Metrics**       | Resource engagement metrics and user interaction tracking     |
| **Notifications** | User notification management                                  |
| **Payments**      | Subscription plans and Stripe integration                     |
| **Platforms**     | Platform configuration and redirects                          |
| **Player**        | Gamification: ELO, leaderboards, game stats                   |
| **Podcasts**      | Podcast creation, generation, and management                  |
| **Problems**      | Quest-based challenges and problem generation                 |
| **Publications**  | Publication CRUD, blogs, collaborators, settings              |

***

## Common patterns

### Pagination

Most list endpoints support pagination:

| Parameter   | Description      |
| ----------- | ---------------- |
| `page`      | Page number      |
| `page_size` | Results per page |

Paginated responses include:

```json
{
  "count": 100,
  "next": "https://api.aisquare.com/api/v1/.../&page=2",
  "previous": null,
  "results": []
}
```

### Filtering and sorting

Many endpoints support query parameters for filtering and sorting:

| Parameter  | Description                                            |
| ---------- | ------------------------------------------------------ |
| `search`   | Free text search                                       |
| `ordering` | Sort field (`trending`, `newest`, `popular`)           |
| `type`     | Resource type filter (`AI_EXPERT`, `AI_NOTE`, `QUEST`) |

### Publication scoping

Most AI Studio endpoints require a publication URL in the request body:

```json
{
  "url": "your-studio-url"
}
```

***

## Status codes

| Status | Meaning                               |
| ------ | ------------------------------------- |
| `200`  | Success                               |
| `201`  | Resource created                      |
| `204`  | Resource deleted                      |
| `400`  | Invalid request or missing parameters |
| `401`  | Authentication required               |
| `403`  | Access forbidden                      |
| `404`  | Not found or access denied            |
| `500`  | Internal server error                 |

See [Errors](/docs/reference/errors) for detailed error handling guidance.