Introduction

Welcome to the AI Squared API documentation! You can use our API to access all the features of the AI Squared platform.

​

Authentication

The AI Squared API uses a JWT-based authentication mechanism. To access the API, you need a valid JWT token which should be included in the header of your requests. This ensures that your interactions with the API are secure and authenticated.

--header 'Authorization: Bearer <YOUR_JWT_TOKEN>'

​

API Endpoints

The AI Squared API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

​

Base URL

The base URL for all API requests is https://api.squared.ai/api/v1/

​

API Reference

The API reference contains a list of all the endpoints available in the AI Squared API. You can also use the navigation bar on the left to browse through the different endpoints.

​

Pagination

Requests that return multiple items will be paginated to 100 items by default. You can specify further pages with the page parameter. You can also set a custom page size up to 100 with the page_size parameter.

https://api.squared.ai/api/v1/models?page=2&page_size=50

​

Rate Limiting

The AI Squared API is rate limited to 100 requests per minute. If you exceed this limit, you will receive a 429 Too Many Requests response.

​

Errors

The AI Squared API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided, and codes in the 5xx range indicate an error with AI Squared’s servers.