experiments

Update an experiment by ID

Changed on

Partially update an experiment's name, description, and/or metadata. Only the fields included in the request body are changed; omitted fields are left as-is. Patching an ephemeral experiment refreshes its last-update timestamp, which extends the window before it is swept away.

patch/v1/experiments/{experiment_id}

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

experiment_idstring required

Request body

namestring nullable

New name for the experiment (null is rejected; name is required)

descriptionstring nullable

New description for the experiment (null clears the description)

metadataobject nullable

New metadata object for the experiment (replaces the existing metadata as a whole; null is rejected)

Response

Experiment updated successfully

Changes