Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
experiments

Api V 2 Experiments Partial Update

PATCH handler with superadmin lock and field protection.

Checks:

  1. Object lock (is_managed=True -> non-superadmins can't modify)
  2. Field protection (non-superadmins can't modify specific fields)
patch/api/v2/experiments/

Headers

Authorizationstring required

JWT access token or Respan API key

Request body

idstring
namestring
datasetstring nullable
workflow_countinteger
status'draft' | 'pending' | 'paused' | 'running' | 'waiting_for_annotations' | 'completed' | 'failed'
  • draft - Draft
  • pending - Pending
  • paused - Paused
  • running - Running
  • waiting_for_annotations - Waiting For Annotations
  • completed - Completed
  • failed - Failed
progressnumber double
started_atstring date-time nullable
completed_atstring date-time nullable
descriptionstring
is_starredboolean

Response

idstring
namestring
datasetstring nullable
dataset_namestring nullable required
modelstring nullable required
workflow_countinteger
status'draft' | 'pending' | 'paused' | 'running' | 'waiting_for_annotations' | 'completed' | 'failed'
  • draft - Draft
  • pending - Pending
  • paused - Paused
  • running - Running
  • waiting_for_annotations - Waiting For Annotations
  • completed - Completed
  • failed - Failed
progressnumber double
created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
descriptionstring
is_starredboolean
prompt_namestring nullable required
evaluator_namesstring[] required
evaluator_scoresobject[] required