Deployments API Documentation
Deployments APIs
Create Deployment
POST
/
deployments
/
add-deployment
curl --request POST \
--url https://api.enkryptai.com/deployments/add-deployment \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"name": "test-deployment",
"model_saved_name": "Test Model",
"model_version": "v1",
"input_guardrails_policy": {
"policy_name": "test-input",
"enabled": true,
"additional_config": {
"pii_redaction": true
},
"block": [
"topic_detector",
"nsfw",
"toxicity",
"pii",
"injection_attack",
"keyword_detector",
"system_prompt",
"policy_violation",
"bias",
"copyright_ip"
]
},
"output_guardrails_policy": {
"policy_name": "test-output",
"enabled": true,
"additional_config": {
"hallucination": false,
"adherence": false,
"relevancy": false
},
"block": [
"topic_detector",
"nsfw",
"toxicity",
"pii",
"injection_attack",
"keyword_detector",
"system_prompt",
"policy_violation",
"bias",
"copyright_ip",
"hallucination",
"adherence",
"relevancy"
]
}
}'
{
"message": "Deployment details added successfully",
"data": {
"name": "test-deployment",
"model_saved_name": "Test Model",
"model_version": "v1",
"input_guardrails_policy": {
"additional_config": {
"pii_redaction": true
},
"block": [
"topic_detector",
"nsfw",
"toxicity",
"pii",
"injection_attack",
"keyword_detector",
"system_prompt",
"policy_violation",
"bias",
"copyright_ip"
],
"policy_name": "test-input",
"enabled": true
},
"output_guardrails_policy": {
"additional_config": {
"relevancy": false,
"hallucination": false,
"adherence": false
},
"block": [
"topic_detector",
"nsfw",
"toxicity",
"pii",
"injection_attack",
"keyword_detector",
"system_prompt",
"policy_violation",
"bias",
"copyright_ip",
"hallucination",
"adherence",
"relevancy"
],
"policy_name": "test-output",
"enabled": true
},
"updated_at": "2024-12-23T04:43:59.005032+00:00",
"deployment_id": 1234567890,
"created_at": "2024-12-23T04:43:59.005032+00:00"
}
}
Authorizations
Body
application/json
Response
200 - application/json
Successful Response
The response is of type object
.
curl --request POST \
--url https://api.enkryptai.com/deployments/add-deployment \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"name": "test-deployment",
"model_saved_name": "Test Model",
"model_version": "v1",
"input_guardrails_policy": {
"policy_name": "test-input",
"enabled": true,
"additional_config": {
"pii_redaction": true
},
"block": [
"topic_detector",
"nsfw",
"toxicity",
"pii",
"injection_attack",
"keyword_detector",
"system_prompt",
"policy_violation",
"bias",
"copyright_ip"
]
},
"output_guardrails_policy": {
"policy_name": "test-output",
"enabled": true,
"additional_config": {
"hallucination": false,
"adherence": false,
"relevancy": false
},
"block": [
"topic_detector",
"nsfw",
"toxicity",
"pii",
"injection_attack",
"keyword_detector",
"system_prompt",
"policy_violation",
"bias",
"copyright_ip",
"hallucination",
"adherence",
"relevancy"
]
}
}'
{
"message": "Deployment details added successfully",
"data": {
"name": "test-deployment",
"model_saved_name": "Test Model",
"model_version": "v1",
"input_guardrails_policy": {
"additional_config": {
"pii_redaction": true
},
"block": [
"topic_detector",
"nsfw",
"toxicity",
"pii",
"injection_attack",
"keyword_detector",
"system_prompt",
"policy_violation",
"bias",
"copyright_ip"
],
"policy_name": "test-input",
"enabled": true
},
"output_guardrails_policy": {
"additional_config": {
"relevancy": false,
"hallucination": false,
"adherence": false
},
"block": [
"topic_detector",
"nsfw",
"toxicity",
"pii",
"injection_attack",
"keyword_detector",
"system_prompt",
"policy_violation",
"bias",
"copyright_ip",
"hallucination",
"adherence",
"relevancy"
],
"policy_name": "test-output",
"enabled": true
},
"updated_at": "2024-12-23T04:43:59.005032+00:00",
"deployment_id": 1234567890,
"created_at": "2024-12-23T04:43:59.005032+00:00"
}
}
Assistant
Responses are generated using AI and may contain mistakes.