Skip to main content
DELETE
/
v1
/
experiment
/
{experiment_id}
Delete experiment
curl --request DELETE \
  --url https://api.braintrust.dev/v1/experiment/{experiment_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.braintrust.dev/v1/experiment/{experiment_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.braintrust.dev/v1/experiment/{experiment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.braintrust.dev/v1/experiment/{experiment_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.braintrust.dev/v1/experiment/{experiment_id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://api.braintrust.dev/v1/experiment/{experiment_id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.braintrust.dev/v1/experiment/{experiment_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "public": true,
  "description": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "repo_info": {
    "commit": "<string>",
    "branch": "<string>",
    "tag": "<string>",
    "dirty": true,
    "author_name": "<string>",
    "author_email": "<string>",
    "commit_message": "<string>",
    "commit_time": "<string>",
    "git_diff": "<string>"
  },
  "commit": "<string>",
  "base_exp_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deleted_at": "2023-11-07T05:31:56Z",
  "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dataset_version": "<string>",
  "internal_metadata": {
    "dataset_filter": {}
  },
  "parameters_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parameters_version": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "tags": [
    "<string>"
  ]
}
"<string>"
"<string>"
"<string>"
"<string>"
"<string>"

Authorizations

Authorization
string
header
required

Most Braintrust endpoints are authenticated by providing your API key as a header Authorization: Bearer [api_key] to your HTTP request. You can create an API key in the Braintrust organization settings page.

Path Parameters

experiment_id
string<uuid>
required

Experiment id

Response

Returns the deleted experiment object

id
string<uuid>
required

Unique identifier for the experiment

project_id
string<uuid>
required

Unique identifier for the project that the experiment belongs under

name
string
required

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

public
boolean
required

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

description
string | null

Textual description of the experiment

created
string<date-time> | null

Date of experiment creation

repo_info
object | null

Metadata about the state of the repo when the experiment was created

commit
string | null

Commit, taken directly from repo_info.commit

base_exp_id
string<uuid> | null

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

deleted_at
string<date-time> | null

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

dataset_id
string<uuid> | null

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

dataset_version
string | null

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.

internal_metadata
object | null

Braintrust-controlled metadata about the experiment.

parameters_id
string<uuid> | null

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

parameters_version
string | null

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

user_id
string<uuid> | null

Identifies the user who created the experiment

metadata
object | null

User-controlled metadata about the experiment

tags
string[] | null

A list of tags for the experiment