The QAIRU OS API programming interface (hereinafter, the API) provides external information systems with read-only access to the data of the Qazaq AI Research University information system and with access to the models of the Alem.Cloud platform.
This guide establishes the procedure for obtaining access to the API, the authorization methods, the composition of modules, the request and response formats, the procedure for storing and processing requests, and the limits in force.
The following terms are used in this guide:
- API token is a secret access key issued by the university administration to an external information system; it defines the list of available modules and the limits in force;
- application is an external platform registered by the university administration for student sign-in with a QAIRU account (“Sign in with QAIRU”);
- access token is a token issued to an application on behalf of a student under the OAuth 2.0 protocol after the student’s consent;
- module is a part of the information system to which a token grants access;
- data module is a module that provides read-only access to the data of the information system;
- ALEM module is the module that provides access to the language, embedding, reranking and speech recognition models of the Alem.Cloud platform.
1.1. Base address
Requests to the API are sent over HTTPS. The request address consists of the base address and the operation path:
https://api.bbx.kz/os/v1In this guide operation paths are given relative to the API domain, for example /os/v1/me. Requests and responses are transmitted in UTF-8 encoding.
Requests to the API and responses to them are stored and processed in accordance with the procedure set out in the “Storage and processing of requests” section.