BRbraintrustdata
Experiments

Partially update experiment

Changed on

Partially update an experiment object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.

patch/v1/experiment/{experiment_id}

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Path parameters

experiment_idstring uuid required

Experiment id

Request body

namestring nullable

Name of the experiment. Within a project, experiment names are unique

descriptionstring nullable

Textual description of the experiment

base_exp_idstring uuid nullable

Id of default base experiment to compare against when viewing this experiment

dataset_idstring uuid nullable

Identifier of the linked dataset, or null if the experiment is not linked to a dataset

dataset_versionstring nullable

Version number of the linked dataset the experiment was run against. This can be used to reproduce the experiment after the dataset has been modified.

parameters_idstring uuid nullable

Identifier of the linked saved parameters object, or null if the experiment is not linked to saved parameters

parameters_versionstring nullable

Version number of the linked saved parameters object the experiment was run against.

publicboolean nullable

Whether or not the experiment is public. Public experiments can be viewed by anybody inside or outside the organization

metadataobject nullable

User-controlled metadata about the experiment

tagsstring[] nullable

A list of tags for the experiment

Response

Returns the experiment object

idstring uuid required

Unique identifier for the experiment

project_idstring uuid required

Unique identifier for the project that the experiment belongs under

namestring required

Name of the experiment. Within a project, experiment names are unique

descriptionstring nullable

Textual description of the experiment

createdstring date-time nullable

Date of experiment creation

commitstring nullable

Commit, taken directly from repo_info.commit

base_exp_idstring uuid nullable

Id of default base experiment to compare against when viewing this experiment

deleted_atstring date-time nullable

Date of experiment deletion, or null if the experiment is still active

dataset_idstring uuid nullable

Identifier of the linked dataset, or null if the experiment is not linked to a dataset

dataset_versionstring nullable

Version number of the linked dataset the experiment was run against. This can be used to reproduce the experiment after the dataset has been modified.

parameters_idstring uuid nullable

Identifier of the linked saved parameters object, or null if the experiment is not linked to saved parameters

parameters_versionstring nullable

Version number of the linked saved parameters object the experiment was run against.

publicboolean required

Whether or not the experiment is public. Public experiments can be viewed by anybody inside or outside the organization

user_idstring uuid nullable

Identifies the user who created the experiment

metadataobject nullable

User-controlled metadata about the experiment

tagsstring[] nullable

A list of tags for the experiment

Changes

  • 8f5039399f77Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property became not nullable

  • d51a7016439cRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status