Red Team API Documentation
Red Team APIs
- GETRedteam Health
- POSTModel Health
- POSTModel Health of saved model
- POSTAdd Task
- POSTAdd Task with saved model
- PATCHCancel Task
- GETGet Task
- GETGet Task Status
- GETGet Task Results Summary
- GETGet Task Results Summary of a specific test type
- GETGet Task Results Details
- GETGet Task Results Details of a specific test type
- GETGet List of Tasks
Red Team APIs
Model Health
POST
/
redteam
/
model-health
curl --request POST \
--url https://api.enkryptai.com/redteam/model-health \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"target_model_configuration": {
"model_name": "meta-llama/Llama-2-13b-chat-hf",
"testing_for": "Copilot",
"model_type": "text_2_text",
"model_version": "v1",
"model_source": "https://together.ai",
"model_provider": "together",
"model_endpoint_url": "https://api.together.xyz/v1/chat/completions",
"model_api_key": "ABCDE12345678900",
"system_prompt": "",
"conversation_template": "",
"rate_per_min": 20
}
}'{
"status": "healthy",
"error": "<string>"
}Authorizations
Body
application/json
Example:
"meta-llama/Llama-2-13b-chat-hf"
Example:
"https://api.together.xyz/v1/chat/completions"
Available options:
Copilot, LLM, Chatbot Example:
"Copilot"
Available options:
text_2_text Example:
"text_2_text"
Example:
"v1"
Example:
"https://together.ai"
Available options:
openai, together, huggingface, groq, azure_openai, anthropic, cohere, bedrock, gemini, ai21, fireworks, alibaba, portkey, deepseek, mistral, llama, openai_compatible Example:
"together"
Example:
"ABCDE12345678900"
Example:
""
Example:
""
< 100 won't enable async. > 100 will enable async mode. > 200 we can run boosted async (all tests in parallel). Default 20.
Example:
20
curl --request POST \
--url https://api.enkryptai.com/redteam/model-health \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"target_model_configuration": {
"model_name": "meta-llama/Llama-2-13b-chat-hf",
"testing_for": "Copilot",
"model_type": "text_2_text",
"model_version": "v1",
"model_source": "https://together.ai",
"model_provider": "together",
"model_endpoint_url": "https://api.together.xyz/v1/chat/completions",
"model_api_key": "ABCDE12345678900",
"system_prompt": "",
"conversation_template": "",
"rate_per_min": 20
}
}'{
"status": "healthy",
"error": "<string>"
}