Skip to main content
GET
/
customers
/
{DEPLOYMENT_ID}
/
ai
/
deployments
GET Deployments
import requests

url = "https://api.lucidworks.com/customers/{DEPLOYMENT_ID}/ai/deployments"

payload = {}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)
[
  {
    "id": "<string>",
    "modelId": "<string>",
    "region": "<string>",
    "config": {
      "parameter_1": "<string>",
      "parameter_2": "<string>"
    },
    "minReplicas": 1,
    "maxReplicas": 1,
    "state": "<string>",
    "deployedAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>"
  }
]

Path Parameters

​
DEPLOYMENT_ID
string
required

Unique identifier generated when the model is deployed.

Body

application/json

GET https:/api.lucidworks.com/customers/{CUSTOMER_ID}/ai/deployments

Response

200 - application/json

OK

​
id
string

The identifier for the custom model. The value is the universally unique identified (UUID) that is the primary key for the model.

​
modelId
string

The identifier for the deployed custom model. The value is the universally unique identified (UUID) reference the foreign keys for the model.

​
region
string

The geographic region specified when the custom model is deployed.

​
config
deploymentConfig · object

The configuration parameters for model deployment passed to the workflow as a raw JSON blob. Multiple parameters can be defined and passed.

​
minReplicas
integer
default:1

The minimum value of Seldon replicas for the model.

Required range: x >= 1
​
maxReplicas
integer
default:1

The maximum value of Seldon replicas for the model.

Required range: x >= 1
​
state
string

This field specifies the current status of the custom model deployment. Value options include:

  • DEPLOYING -The model is in the process of being deployed.

  • DEPLOYED - The model is deployed and available for predictions.

  • DEPLOY_FAILED - The model failed to deploy.

  • DELETING - The model deployment is being deleted. The custom_model_deployment record is also deleted if the deployment is successfully deleted.

  • DELETE_FAILED - The model deployment deletion failed. The model is still deployed and available for predictions.

​
deployedAt
string<date-time>

The date and time the deployment occurred.

​
createdBy
string

The user who created the deployment.