Create a new evaluation

POST

/api/v2/agents/{agent_id}/evaluations

Create a new evaluation.

Path Parameters:

agent_id: ID of the agent to create the evaluation for

Request Body:
JSON object containing the evaluation details

Returns:
JSON response with object containing created evaluation

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///api/v2/agents//evaluations' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "agent_id": 0,
    "dataset_ids": [
        0
    ],
    "metric_ids": [
        0
    ],
    "prefix_prompt": "string",
    "model_deployment": "string",
    "custom_instructions": {
        "property1": null,
        "property2": null
    },
    "source_enabled": false,
    "evaluation_name": "string"
}'

Response Example

201 - Success

{
    "success": true,
    "message": "Evaluation created successfully",
    "data": {
        "id": 213,
        "agent": 3,
        "final_scores": {},
        "status": "pending",
        "created_on": "2025-01-21T20:59:15.608Z"
    }
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Evaluation successfully created

Body

🔴500Server Error

Retrieve all evaluations or filter by dataset

Delete a set of evaluations or a specific evaluation