​
Deployments API Documentation

Welcome to the Deployments API documentation. This guide provides comprehensive information to help you integrate and utilize our APIs for easily saving and managing deployments in Enkrypt.

​
Purpose

The Deployments API is designed to help you save LLM endpoints in Enkrypt enabling you to configure input and ouput guardrails. By leveraging our proxy API, you can protect your language models from adversarial attacks and ensure that your AI deployments are secure.

​
Quickstart for usage

Please check AI Proxy Quickstart of how to use the EnkryptAI deployment we created with OpenAI SDK. It takes care of proxying correctly to the model saved in the deployment and applying the input, output guardrails set in the deployment. AI Proxy Quickstart

​
Offered APIs

Our API suite includes the following endpoints:
  • add-deployment: This endpoint allows you to save a new deployment for future use.
  • get-deployment: This endpoint retrieves a saved deployment.
    • Option to refresh the cache if current data is outdated.
  • modify-deployment: This endpoint enables you to update a saved deployment.
  • delete-deployment: This endpoint allows you to delete a saved deployment.
  • list-deployments: This endpoint lists all saved deployments.
  • get-allowed-config: This endpoint retrieves the allowed configurations available for input and output guardrails for deployments.

​
Obtaining an API Key

To get started with the Deployments API, you need to obtain an API key. Follow these steps:
  1. Login: Access your account at app.enkryptai.com.
  2. Get API Key: Navigate to the API section to get your unique API key.
  3. Authentication: Use this API key in the authorization headers of your leaderboard API calls.
By following these steps, you can seamlessly integrate the Deployments API into your enterprise applications. We are committed to helping you maintain the highest standards of safety in your language deployments. Should you have any questions or require further assistance, our support team is readily available to assist you. Let’s ensure safer AI together!