1. Documentation
2. 2024.1 (Latest) 2024.0 10.3 10.2 10.1 10.0 9.10 9.9 9.8 9.7 9.6 9.5 9.4 9.3 9.2 9.1 9.0 8.2 8.1 8.0 7.6
3. Hub
4. Api
5. REST API

REST API

Altair AI Hub offers a REST API to manage it programmatically. In order to use the API, you are required to be authenticated and authorized via JSON Web Token (JWT).

Create a JWT using Keycloak

There are different ways to create a JWT with keycloak, one of which is using curl and a public client, e.g. the Rapidminer AI Hub Frontend:

curl -L -X POST 'http://<keycloak_host>:<keycloak_port>/auth/realms/<realm_name>/protocol/openid-connect/token' \ -H 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'client_id=<public_client_id>' \ --data-urlencode 'grant_type=password' \ --data-urlencode 'scope=openid' \ --data-urlencode 'username=<user_name>' \ --data-urlencode 'password=<password>'

Altair AI Hub API

The REST API documentation of Altair AI Hub is available as OpenApi 3.0 specification and is published on SwaggerHub.

For all further requests to the API you need to have

• the HTTP method of your request (GET, POST, PUT, PATCH or DELETE),
• the content-type header attribute,
• the authorization header attribute which includes the idToken from the token service and is prefixed with Bearer (e.g. Authorization: Bearer <tokenContent>),
• the Altair AI Hub url and
• the route you like to make a request to.

curl -H "Content-Type: application/json" -H "Authorization: Bearer $idToken" $RMServerHost/api/v1/queues