Get Deployment
curl --request GET \
--url https://api.enkryptai.com/deployments/get-deployment \
--header 'X-Enkrypt-Deployment: <x-enkrypt-deployment>' \
--header 'apikey: <api-key>'import requests
url = "https://api.enkryptai.com/deployments/get-deployment"
headers = {
"X-Enkrypt-Deployment": "<x-enkrypt-deployment>",
"apikey": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Enkrypt-Deployment': '<x-enkrypt-deployment>', apikey: '<api-key>'}
};
fetch('https://api.enkryptai.com/deployments/get-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/get-deployment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Enkrypt-Deployment: <x-enkrypt-deployment>",
"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"
"net/http"
"io"
)
func main() {
url := "https://api.enkryptai.com/deployments/get-deployment"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Enkrypt-Deployment", "<x-enkrypt-deployment>")
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.enkryptai.com/deployments/get-deployment")
.header("X-Enkrypt-Deployment", "<x-enkrypt-deployment>")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enkryptai.com/deployments/get-deployment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Enkrypt-Deployment"] = '<x-enkrypt-deployment>'
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
Get Deployment
GET
/
deployments
/
get-deployment
Get Deployment
curl --request GET \
--url https://api.enkryptai.com/deployments/get-deployment \
--header 'X-Enkrypt-Deployment: <x-enkrypt-deployment>' \
--header 'apikey: <api-key>'import requests
url = "https://api.enkryptai.com/deployments/get-deployment"
headers = {
"X-Enkrypt-Deployment": "<x-enkrypt-deployment>",
"apikey": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Enkrypt-Deployment': '<x-enkrypt-deployment>', apikey: '<api-key>'}
};
fetch('https://api.enkryptai.com/deployments/get-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/get-deployment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Enkrypt-Deployment: <x-enkrypt-deployment>",
"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"
"net/http"
"io"
)
func main() {
url := "https://api.enkryptai.com/deployments/get-deployment"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Enkrypt-Deployment", "<x-enkrypt-deployment>")
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.enkryptai.com/deployments/get-deployment")
.header("X-Enkrypt-Deployment", "<x-enkrypt-deployment>")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enkryptai.com/deployments/get-deployment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Enkrypt-Deployment"] = '<x-enkrypt-deployment>'
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
Headers
The deployment saved name. E.g. test-deployment-1
Example:
"test-deployment"
Refresh the cache if data is stale
Example:
false
Response
200 - application/json
Successful Response
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
Example:
1234567890
Example:
"2024-10-15T17:22:47.872389+00:00"
Example:
"2024-10-15T17:22:47.872389+00:00"
Example:
"default"
โI

