evaluations

Update Status

Update the status of an evaluation run.

Can only be used to update the status of an evaluation run that uses external or human evaluators. The evaluation must currently have status 'running' if switching to completed, or it must have status 'completed' if switching back to 'running'.

patch/evaluations/{id}/status

Request

  • Base URL: https://api.humanloop.com/v4
  • URL: https://api.humanloop.com/v4/evaluations/{id}/status
  • Auth: API key in header X-API-KEY

Path parameters

idstring required

String ID of evaluation run. Starts with ev_.

Request body

status'pending' | 'running' | 'completed' | 'cancelled' required

Status of an evaluation.

Response

Successful Response

idstring required

Unique ID for the evaluation. Starts with ev_.

status'pending' | 'running' | 'completed' | 'cancelled' required

Status of an evaluation.

created_atstring date-time required
updated_atstring date-time required
dataset_version_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.