Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Data Plane Health API
version: '2.0'
contact:
name: Seldon Technologies Ltd.
url: https://www.seldon.io/
email: hello@seldon.io
description: REST protocol to interact with inference servers.
license:
name: Business Source License 1.1
servers: []
tags:
- name: health
paths:
/v2/health/live:
get:
summary: Server Live
responses:
'200':
description: OK
operationId: server-live
description: The “server live” API indicates if the inference server is able to receive and respond to metadata and inference requests. The “server live” API can be used directly to implement the Kubernetes `livenessProbe`.
tags:
- health
/v2/health/ready:
get:
summary: Server Ready
tags:
- health
responses:
'200':
description: OK
operationId: server-ready
description: The “server ready” health API indicates if all the models are ready for inferencing. The “server ready” health API can be used directly to implement the Kubernetes readinessProbe.
/v2/models/{model_name}/versions/{model_version}/ready:
parameters:
- schema:
type: string
name: model_name
in: path
required: true
- schema:
type: string
name: model_version
in: path
required: true
get:
summary: Model Ready
tags:
- health
responses:
'200':
description: OK
operationId: model-version-ready
description: The “model ready” health API indicates if a specific model is ready for inferencing. The model name and (optionally) version must be available in the URL. If a version is not provided the server may choose a version based on its own policies.
/v2/models/{model_name}/ready:
parameters:
- schema:
type: string
name: model_name
in: path
required: true
get:
summary: Model Ready
tags:
- health
responses:
'200':
description: OK
operationId: model-ready
description: The “model ready” health API indicates if a specific model is ready for inferencing. The model name and (optionally) version must be available in the URL. If a version is not provided the server may choose a version based on its own policies.