DataRobot API resources > API reference documentation > REST API > Predictions > Real-time predictions

Real-time predictions¶

Use the endpoints described below to manage predictions information.

GET /api/v2/predictionServers/¶

List prediction servers available for a user.

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.

Example responses¶

200 Response

{
  "properties": {
    "count": {
      "description": "Number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "List of prediction servers.",
      "items": {
        "properties": {
          "batchPredictions": {
            "description": "Batch Prediction status for this instance",
            "properties": {
              "processing": {
                "description": "Number of jobs processing",
                "minimum": 0,
                "type": "integer"
              },
              "queued": {
                "description": "Number of jobs queued",
                "minimum": 0,
                "type": "integer"
              }
            },
            "required": [
              "processing",
              "queued"
            ],
            "type": "object"
          },
          "datarobot-key": {
            "description": "The `datarobot-key` header used in requests to this prediction server.",
            "type": [
              "string",
              "null"
            ]
          },
          "id": {
            "description": "ID of the prediction server.",
            "type": [
              "string",
              "null"
            ]
          },
          "url": {
            "description": "URL of the prediction server.",
            "type": "string"
          }
        },
        "required": [
          "batchPredictions",
          "datarobot-key",
          "id",
          "url"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "next": {
      "description": "URL pointing to the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "URL pointing to the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "data",
    "next",
    "previous"
  ],
  "type": "object"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	PredictionServerListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas¶

BatchPredictionStatus

{
  "description": "Batch Prediction status for this instance",
  "properties": {
    "processing": {
      "description": "Number of jobs processing",
      "minimum": 0,
      "type": "integer"
    },
    "queued": {
      "description": "Number of jobs queued",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "processing",
    "queued"
  ],
  "type": "object"
}

Batch Prediction status for this instance

Properties¶

Name	Type	Required	Restrictions	Description
processing	integer	true	minimum: 0	Number of jobs processing
queued	integer	true	minimum: 0	Number of jobs queued

PredictionServerListResponse

{
  "properties": {
    "count": {
      "description": "Number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "List of prediction servers.",
      "items": {
        "properties": {
          "batchPredictions": {
            "description": "Batch Prediction status for this instance",
            "properties": {
              "processing": {
                "description": "Number of jobs processing",
                "minimum": 0,
                "type": "integer"
              },
              "queued": {
                "description": "Number of jobs queued",
                "minimum": 0,
                "type": "integer"
              }
            },
            "required": [
              "processing",
              "queued"
            ],
            "type": "object"
          },
          "datarobot-key": {
            "description": "The `datarobot-key` header used in requests to this prediction server.",
            "type": [
              "string",
              "null"
            ]
          },
          "id": {
            "description": "ID of the prediction server.",
            "type": [
              "string",
              "null"
            ]
          },
          "url": {
            "description": "URL of the prediction server.",
            "type": "string"
          }
        },
        "required": [
          "batchPredictions",
          "datarobot-key",
          "id",
          "url"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "next": {
      "description": "URL pointing to the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "URL pointing to the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "data",
    "next",
    "previous"
  ],
  "type": "object"
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[PredictionServerResponse]	true	List of prediction servers.
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).

PredictionServerResponse

{
  "properties": {
    "batchPredictions": {
      "description": "Batch Prediction status for this instance",
      "properties": {
        "processing": {
          "description": "Number of jobs processing",
          "minimum": 0,
          "type": "integer"
        },
        "queued": {
          "description": "Number of jobs queued",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "processing",
        "queued"
      ],
      "type": "object"
    },
    "datarobot-key": {
      "description": "The `datarobot-key` header used in requests to this prediction server.",
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "description": "ID of the prediction server.",
      "type": [
        "string",
        "null"
      ]
    },
    "url": {
      "description": "URL of the prediction server.",
      "type": "string"
    }
  },
  "required": [
    "batchPredictions",
    "datarobot-key",
    "id",
    "url"
  ],
  "type": "object"
}

Properties¶

Name	Type	Required	Description
batchPredictions	BatchPredictionStatus	true	Batch Prediction status for this instance
datarobot-key	string,null	true	The `datarobot-key` header used in requests to this prediction server.
id	string,null	true	ID of the prediction server.
url	string	true	URL of the prediction server.