Red Team API Documentation
Red Team APIs
- GETRedteam Health
- POSTModel Health
- POSTModel Health of saved model
- POSTAdd Task
- POSTAdd Task with saved model
- POSTAdd Custom Task
- POSTAdd Custom 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
Copy
Ask AI
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": "mistralai/Mistral-7B-Instruct-v0.1",
"testing_for": "Copilot",
"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": "",
"rate_per_min": 20,
"input_modalities": [
"text"
],
"output_modalities": [
"text"
],
"tools": [
{
"name": "web_search",
"description": "The tool web search is used to search the web for information related to finance."
}
]
}
}'
Copy
Ask AI
{
"status": "healthy",
"message": "Model health check completed successfully",
"data": {
"query": "What is the capital of India?",
"response": "The capital of India is New Delhi."
},
"error": "Error while checking model health"
}
Authorizations
Body
application/json
Response
200 - application/json
Successful Response
The response is of type object
.
Copy
Ask AI
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": "mistralai/Mistral-7B-Instruct-v0.1",
"testing_for": "Copilot",
"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": "",
"rate_per_min": 20,
"input_modalities": [
"text"
],
"output_modalities": [
"text"
],
"tools": [
{
"name": "web_search",
"description": "The tool web search is used to search the web for information related to finance."
}
]
}
}'
Copy
Ask AI
{
"status": "healthy",
"message": "Model health check completed successfully",
"data": {
"query": "What is the capital of India?",
"response": "The capital of India is New Delhi."
},
"error": "Error while checking model health"
}
Assistant
Responses are generated using AI and may contain mistakes.