Api V 2 Experiments Partial Update

PATCH

https://api.respan.ai/api/v2/experiments/

PATCH

/api/v2/experiments/

$ curl -X PATCH https://api.respan.ai/api/v2/experiments/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Updated

1 {
2   "dataset_name": "string",
3   "model": "string",
4   "created_at": "2024-01-15T09:30:00Z",
5   "tags": [
6     {
7       "id": "string",
8       "name": "string",
9       "color": "string",
10       "created_at": "2024-01-15T09:30:00Z",
11       "updated_at": "2024-01-15T09:30:00Z"
12     }
13   ],
14   "prompt_name": "string",
15   "evaluator_names": [
16     "string"
17   ],
18   "evaluator_scores": [
19     {}
20   ],
21   "id": "string",
22   "name": "string",
23   "dataset": "string",
24   "workflow_count": 1,
25   "status": "draft",
26   "progress": 1.1,
27   "started_at": "2024-01-15T09:30:00Z",
28   "completed_at": "2024-01-15T09:30:00Z",
29   "description": "string",
30   "is_starred": true
31 }

PATCH handler with superadmin lock and field protection.

Checks:

Object lock (is_managed=True -> non-superadmins can’t modify)
Field protection (non-superadmins can’t modify specific fields)

Authentication

AuthorizationBearer

JWT access token or Respan API key

Request

This endpoint expects an object.

idstringOptional1-255 characters

namestringOptional<=255 characters

datasetstring or nullOptional>=1 character

workflow_countintegerOptional-2147483648-2147483647

statusenumOptional

draft - Draft
pending - Pending
paused - Paused
running - Running
waiting_for_annotations - Waiting For Annotations
completed - Completed
failed - Failed

progressdoubleOptional

started_atdatetime or nullOptional

completed_atdatetime or nullOptional

descriptionstringOptional

is_starredbooleanOptional

Response

dataset_namestring or nullRead-only

modelstring or nullRead-only

created_atdatetimeRead-only

tagslist of objectsRead-only

prompt_namestring or nullRead-only

evaluator_nameslist of stringsRead-only

evaluator_scoreslist of maps from strings to anyRead-only

idstring<=255 characters

namestring<=255 characters

datasetstring or null

workflow_countinteger-2147483648-2147483647

statusenum

draft - Draft
pending - Pending
paused - Paused
running - Running
waiting_for_annotations - Waiting For Annotations
completed - Completed
failed - Failed

progressdouble

started_atdatetime or null

completed_atdatetime or null

descriptionstring

is_starredboolean