API Reference
Subscriptions API
The namespace to which the pipeline and model in the subscription belong.
The name of the pipeline associated with the subscription.
OK
Bad Request
Internal Server Error
An unexpected error response.
GET /api/v1/pipeline/subscriptions HTTP/1.1
Host:
Accept: */*
{
"subscriptions": [
{
"subscriptionId": "text",
"modelName": "text",
"featuresMetadata": [
{
"numeric": {
"name": "Age"
},
"categorical": {
"name": "Marital Status",
"categories": [
"Married",
"Single",
"Divorced"
]
},
"categoricalProbaTensor": {
"name": "Marital Status",
"categories": [
"Married",
"Single",
"Divorced"
]
}
}
],
"namespace": "text",
"pipelineName": "text"
}
]
}The namespace to which the pipeline and model belong.
my-namespaceThe name of the pipeline to which the model belongs.
my-pipelineThe name of the model.
my-modelOK
Bad Request
Conflict
Internal Server Error
An unexpected error response.
POST /api/v1/pipeline/model/subscribe HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 309
{
"namespace": "my-namespace",
"pipelineName": "my-pipeline",
"modelName": "my-model",
"featuresMetadata": [
{
"numeric": {
"name": "Age"
},
"categorical": {
"name": "Marital Status",
"categories": [
"Married",
"Single",
"Divorced"
]
},
"categoricalProbaTensor": {
"name": "Marital Status",
"categories": [
"Married",
"Single",
"Divorced"
]
}
}
]
}{
"subscriptionId": "text"
}The unique identifier of the subscription.
OK
Bad Request
Internal Server Error
An unexpected error response.
DELETE /api/v1/pipeline/model/unsubscribe?subscriptionId=text HTTP/1.1
Host:
Accept: */*
{}Feedback API
The namespace to which the pipeline and model belong.
seldon-systemThe name of the pipeline to which the model belongs.
my-pipelineThe name of the model.
my-modelThe prediction request ID, could represent a batch or not.
1234The request index in the batch, if applicable. Defaults to 0.
0OK
Bad Request
Forbidden
Internal Server Error
An unexpected error response.
POST /api/v1/pipeline/model/feedback HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 197
{
"namespace": "seldon-system",
"pipelineName": "my-pipeline",
"modelName": "my-model",
"requestId": "1234",
"batchId": "0",
"feedback": {
"classificationFeedback": {
"value": 1
},
"regressionFeedback": {
"value": 1
}
}
}{
"feedbackId": "text"
}Metrics API
Classification Metrics
The namespace to which the pipeline and model belong.
The name of the pipeline to which the model belongs.
The name of the model.
The start datetime of the metrics to retrieve (inclusive), in ISO 8601 format.
The end datetime of the metrics to retrieve (exclusive), in ISO 8601 format.
The size of each bucket within the time window, e.g., 10s, 2h45m, 1h. If left empty, a single bucket covering the entire time window will be returned.
OK
Bad Request
Internal Server Error
An unexpected error response.
GET /api/v1/metrics/pipeline/classification?namespace=text&pipelineName=text&modelName=text&startTime=2025-12-03T01%3A37%3A52.733Z&endTime=2025-12-03T01%3A37%3A52.733Z HTTP/1.1
Host:
Accept: */*
{
"metrics": [
{
"confusionMatrix": {
"categories": [
"text"
],
"values": [
1
],
"computedConfusionValues": [
{
"truePositiveCount": 1,
"trueNegativeCount": 1,
"falsePositiveCount": 1,
"falseNegativeCount": 1
}
]
},
"accuracy": 1,
"recall": 1,
"precision": 1,
"specificity": 1,
"f1": 1,
"endTime": "2025-12-03T01:37:52.733Z"
}
]
}Regression Metrics
The namespace to which the pipeline and model belong.
The name of the pipeline to which the model belongs.
The name of the model.
The start datetime of the metrics to retrieve (inclusive), in ISO 8601 format.
The end datetime of the metrics to retrieve (exclusive), in ISO 8601 format.
The size of each bucket within the time window, e.g., 10s, 2h45m, 1h. If left empty, a single bucket covering the entire time window will be returned.
OK
Bad Request
Internal Server Error
An unexpected error response.
GET /api/v1/metrics/pipeline/regression?namespace=text&pipelineName=text&modelName=text&startTime=2025-12-03T01%3A37%3A52.733Z&endTime=2025-12-03T01%3A37%3A52.733Z HTTP/1.1
Host:
Accept: */*
{
"metrics": [
{
"meanSquaredError": 1,
"rootMeanSquaredError": 1,
"meanAbsoluteError": 1,
"endTime": "2025-12-03T01:37:52.733Z"
}
]
}Last updated
Was this helpful?