Seldon Deploy’s REST API
Seldon Deploy’s REST API is considered experimental.
The following endpoints could change at any time and breaking changes are
Seldon Deploy’s REST API allows you to interact with your machine learning
deployments through programmatically.
The API endpoints are versioned to avoid clashes between different versions of
The current version of the API is
v1alpha1, which means that breaking changes
are still highly likely to happen.
Once the current version graduates to stable, it will be renamed to
Note that this versioning schema is similar to the one followed in Kubernetes.
All requests to the Seldon Deploy API must be authenticated.
Therefore, before using the API you must obtain an authentication token.
This authentication token can then be used to authenticate requests by setting
Authorization header with the following format:
Authorization: Bearer $TOKEN
The Seldon Deploy API leverages OpenID to authenticate and authorize users.
Thus, this authentication token can be issued and managed by an OIDC provider.
Note that the process to issue a new authentication token may change depending
on your architecture and your OIDC provider.
As an example, let’s assume a set up where Keycloak is configured as an OIDC
provider and there is an OpenID client named
With the above in place, you could obtain an authorization token to access the
API using plain
RESULT=$(curl -k -s --data $_payload $_authEndpoint)
TOKEN=$(echo $RESULT | sed 's/.*id_token":"//g' | sed 's/".*//g')
Once we have obtained this token, we can then use it to authorize our requests
to the Seldon Deploy API.
For example, to list all our machine learning deployments we could do:
curl -k -X GET \
-H "Authorization: Bearer $TOKEN"
Reference for version
v1alpha1 of the API.