Sign in

v1

latestOpenAPI 3.0.02026-07-268285163.6 KB
Evaluations

Restart an evaluation

Restarts an existing evaluation with optional new parameters (comment, custom instructions, or model)

post/evaluations/{evaluation_id}/restart

Path parameters

evaluation_idstring required

ID of the evaluation to restart

Request body

commentstring

Optional updated comment for the restarted evaluation

custom_instructionsstring

Optional updated custom instructions for the AI model

model_idstring

Optional new model ID to use for the restarted evaluation

Example request

{
  "comment": "Retry with updated parameters",
  "custom_instructions": "Be more concise in responses",
  "model_id": "507f191e810c19729de860ea"
}

Response

Evaluation successfully restarted

messagestring required

Success message

Example response

{
  "evaluation": {
    "_id": "698028cac782090c87b67617",
    "name": "Q1 Customer Service Evaluation",
    "data": [],
    "user_id": "5d4ae69ef5dc79b3d4ca5ad3",
    "skill": {
      "_id": "507f191e810c19729de860ec",
      "name": "Customer Service Bot"
    },
    "dataset": {
      "_id": "507f191e810c19729de860eb",
      "name": "Support Questions Dataset"
    },
    "model": {
      "_id": "507f191e810c19729de860ea",
      "name": "gpt-4",
      "model_name": "GPT-4 Turbo",
      "provider": "OpenAI"
    },
    "status": "in progress",
    "nb_questions": 25,
    "comment": "Testing new training data",
    "custom_instructions": "Focus on politeness and accuracy",
    "createdAt": "2026-02-02T04:32:10.958Z",
    "updatedAt": "2026-02-02T04:32:10.958Z"
  },
  "message": "Evaluation has been successfully created and is running"
}