Overview Use Cases Connectors Authentication Getting Started with the Python SDK API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors dataset deployment createDeployment createDeploymentAlert createDeploymentToken createRealtimeMonitor deleteDeployment deleteDeploymentToken deleteRealtimeMonitor describeDeployment describeRealtimeMonitor getApiEndpoint getModelTrainingTypesForDeployment getPredictionLogsRecords listDeploymentAlerts listDeploymentTokens listDeployments listRealtimeMonitors removeDeploymentFeatureGroupExportOutput renameDeployment setAutoDeployment setDefaultPredictionArguments setDeploymentFeatureGroupExportDatabaseConnectorOutput setDeploymentFeatureGroupExportFileConnectorOutput setDeploymentFeatureGroupVersion setDeploymentModelVersion setDeploymentPredictionOperatorVersion startDeployment stopDeployment updateDeployment updateRealtimeMonitor deployment_conversations docstore document_retrievers documentation eda external_app feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard holdout_analysis llm_apps model model_monitoring module natural_language_explanation organization pipelines predict prediction_operator project python_function refresh secrets streaming streaming_connectors upload webhooks API Classes API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

Method

stopDeployment POST

Copy POST

Stops the specified deployment.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	deploymentId	str	Unique string identifier of the deployment to be stopped.

Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY	TYPE	DESCRIPTION
success	Boolean	true if the call succeeded, false if there was an error

Exceptions:

TYPE	WHEN
DataNotFoundError	`deploymentId` is not found.

Language: