Create 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",
"policy_violation",
"bias",
"sponge_attack"
]
},
"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",
"policy_violation",
"bias",
"adherence",
"relevancy"
]
}
}
'import requests
url = "https://api.enkryptai.com/deployments/add-deployment"
payload = {
"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", "policy_violation", "bias", "sponge_attack"]
},
"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", "policy_violation", "bias", "adherence", "relevancy"]
}
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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',
'policy_violation',
'bias',
'sponge_attack'
]
},
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',
'policy_violation',
'bias',
'adherence',
'relevancy'
]
}
})
};
fetch('https://api.enkryptai.com/deployments/add-deployment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.enkryptai.com/deployments/add-deployment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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',
'policy_violation',
'bias',
'sponge_attack'
]
],
'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',
'policy_violation',
'bias',
'adherence',
'relevancy'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.enkryptai.com/deployments/add-deployment"
payload := strings.NewReader("{\n \"name\": \"test-deployment\",\n \"model_saved_name\": \"Test Model\",\n \"model_version\": \"v1\",\n \"input_guardrails_policy\": {\n \"policy_name\": \"test-input\",\n \"enabled\": true,\n \"additional_config\": {\n \"pii_redaction\": true\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"sponge_attack\"\n ]\n },\n \"output_guardrails_policy\": {\n \"policy_name\": \"test-output\",\n \"enabled\": true,\n \"additional_config\": {\n \"hallucination\": false,\n \"adherence\": false,\n \"relevancy\": false\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"adherence\",\n \"relevancy\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.enkryptai.com/deployments/add-deployment")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"test-deployment\",\n \"model_saved_name\": \"Test Model\",\n \"model_version\": \"v1\",\n \"input_guardrails_policy\": {\n \"policy_name\": \"test-input\",\n \"enabled\": true,\n \"additional_config\": {\n \"pii_redaction\": true\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"sponge_attack\"\n ]\n },\n \"output_guardrails_policy\": {\n \"policy_name\": \"test-output\",\n \"enabled\": true,\n \"additional_config\": {\n \"hallucination\": false,\n \"adherence\": false,\n \"relevancy\": false\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"adherence\",\n \"relevancy\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enkryptai.com/deployments/add-deployment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"test-deployment\",\n \"model_saved_name\": \"Test Model\",\n \"model_version\": \"v1\",\n \"input_guardrails_policy\": {\n \"policy_name\": \"test-input\",\n \"enabled\": true,\n \"additional_config\": {\n \"pii_redaction\": true\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"sponge_attack\"\n ]\n },\n \"output_guardrails_policy\": {\n \"policy_name\": \"test-output\",\n \"enabled\": true,\n \"additional_config\": {\n \"hallucination\": false,\n \"adherence\": false,\n \"relevancy\": false\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"adherence\",\n \"relevancy\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"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",
"policy_violation",
"bias",
"sponge_attack"
],
"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",
"policy_violation",
"bias",
"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"
}
}๐ Deployments API
Create Deployment
POST
/
deployments
/
add-deployment
Create 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",
"policy_violation",
"bias",
"sponge_attack"
]
},
"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",
"policy_violation",
"bias",
"adherence",
"relevancy"
]
}
}
'import requests
url = "https://api.enkryptai.com/deployments/add-deployment"
payload = {
"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", "policy_violation", "bias", "sponge_attack"]
},
"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", "policy_violation", "bias", "adherence", "relevancy"]
}
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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',
'policy_violation',
'bias',
'sponge_attack'
]
},
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',
'policy_violation',
'bias',
'adherence',
'relevancy'
]
}
})
};
fetch('https://api.enkryptai.com/deployments/add-deployment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.enkryptai.com/deployments/add-deployment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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',
'policy_violation',
'bias',
'sponge_attack'
]
],
'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',
'policy_violation',
'bias',
'adherence',
'relevancy'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.enkryptai.com/deployments/add-deployment"
payload := strings.NewReader("{\n \"name\": \"test-deployment\",\n \"model_saved_name\": \"Test Model\",\n \"model_version\": \"v1\",\n \"input_guardrails_policy\": {\n \"policy_name\": \"test-input\",\n \"enabled\": true,\n \"additional_config\": {\n \"pii_redaction\": true\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"sponge_attack\"\n ]\n },\n \"output_guardrails_policy\": {\n \"policy_name\": \"test-output\",\n \"enabled\": true,\n \"additional_config\": {\n \"hallucination\": false,\n \"adherence\": false,\n \"relevancy\": false\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"adherence\",\n \"relevancy\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.enkryptai.com/deployments/add-deployment")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"test-deployment\",\n \"model_saved_name\": \"Test Model\",\n \"model_version\": \"v1\",\n \"input_guardrails_policy\": {\n \"policy_name\": \"test-input\",\n \"enabled\": true,\n \"additional_config\": {\n \"pii_redaction\": true\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"sponge_attack\"\n ]\n },\n \"output_guardrails_policy\": {\n \"policy_name\": \"test-output\",\n \"enabled\": true,\n \"additional_config\": {\n \"hallucination\": false,\n \"adherence\": false,\n \"relevancy\": false\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"adherence\",\n \"relevancy\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enkryptai.com/deployments/add-deployment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"test-deployment\",\n \"model_saved_name\": \"Test Model\",\n \"model_version\": \"v1\",\n \"input_guardrails_policy\": {\n \"policy_name\": \"test-input\",\n \"enabled\": true,\n \"additional_config\": {\n \"pii_redaction\": true\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"sponge_attack\"\n ]\n },\n \"output_guardrails_policy\": {\n \"policy_name\": \"test-output\",\n \"enabled\": true,\n \"additional_config\": {\n \"hallucination\": false,\n \"adherence\": false,\n \"relevancy\": false\n },\n \"block\": [\n \"topic_detector\",\n \"nsfw\",\n \"toxicity\",\n \"pii\",\n \"injection_attack\",\n \"keyword_detector\",\n \"policy_violation\",\n \"bias\",\n \"adherence\",\n \"relevancy\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"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",
"policy_violation",
"bias",
"sponge_attack"
],
"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",
"policy_violation",
"bias",
"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
Name of the deployment
Example:
"test-deployment"
Name of the saved model to use
Example:
"Test Model"
Version of the model to use
Example:
"v1"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
200 - application/json
Successful Response
Example:
"Deployment details added successfully"
Show child attributes
Show child attributes
Example:
{
"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",
"policy_violation",
"bias",
"sponge_attack"
],
"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",
"policy_violation",
"bias",
"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"
}
โI

