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:

For most integrations, use the API key:

X-API-KEY: <your_api_key>

See Authentication for detailed setup instructions.

API groups

The API is organized into the following groups:

Common patterns

Pagination

Most list endpoints support pagination:

Paginated responses include:

1
{
2
  "count": 100,
3
  "next": "https://api.aisquare.com/api/v1/.../&page=2",
4
  "previous": null,
5
  "results": []
6
}

Filtering and sorting

Many endpoints support query parameters for filtering and sorting:

Publication scoping

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

1
{
2
  "url": "your-studio-url"
3
}

Status codes

See Errors for detailed error handling guidance.