Sign in
Eval runs

Update an eval suite's settings

Partial update — omitted fields are left as they are. environmentIds is tri-state: a non-empty array sets/replaces, null clears (reverting the suite to legacy config), and [] is rejected rather than silently treated as a clear. Responds with the full updated suite.

patch/projects/{projectId}/eval-suites/{suiteId}

Path parameters

projectIdstring required

ID of the hosted project that contains the server.

suiteIdstring required

Eval suite ID, as returned by POST /eval-runs.

Request body

namestring
descriptionstring
environmentIdsstring[] nullable

Tri-state: a non-empty array sets/replaces the attachments, null CLEARS them (reverting the suite to legacy config), and [] is REJECTED rather than silently read as a clear.

expectedRevisionNumberinteger

The suite's revisionNumber as you last read it. Supplying it makes this edit a compare-and-set: a suite changed since then is refused with 409 having written nothing. Omit for last-write-wins.

Response

The updated suite.

idstring required
declaredIdstring

The suite's declared file identity (suite.id in a suite file). Present on file-owned suites; absent on UI-authored suites, which have no declared id and cannot be claimed by eval run --file.

namestring nullable
descriptionstring nullable
projectIdstring nullable
environmentIdsstring[]

Attached project environments, in attach order.

revisionNumberinteger nullable

How many committed edits this suite has had, or null on a deployment that does not record revisions. Send it back as expectedRevisionNumber on a PATCH to make that edit a compare-and-set.

createdAtnumber nullable

Epoch milliseconds.

updatedAtnumber nullable

Changes