Partially update project
curl --request PATCH \
--url https://api.braintrust.dev/v1/project/{project_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"user_id": "<string>",
"settings": {
"comparison_key": "<string>",
"baseline_experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"spanFieldOrder": [
{
"object_type": "<string>",
"column_id": "<string>",
"position": "<string>",
"layout": "full"
}
],
"remote_eval_sources": [
{
"url": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"disable_realtime_queries": true,
"default_preprocessor": {
"type": "function",
"id": "<string>",
"version": "<string>"
}
}
}
'import requests
url = "https://api.braintrust.dev/v1/project/{project_id}"
payload = {
"name": "<string>",
"description": "<string>",
"user_id": "<string>",
"settings": {
"comparison_key": "<string>",
"baseline_experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"spanFieldOrder": [
{
"object_type": "<string>",
"column_id": "<string>",
"position": "<string>",
"layout": "full"
}
],
"remote_eval_sources": [
{
"url": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"disable_realtime_queries": True,
"default_preprocessor": {
"type": "function",
"id": "<string>",
"version": "<string>"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
user_id: '<string>',
settings: {
comparison_key: '<string>',
baseline_experiment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
spanFieldOrder: [
{
object_type: '<string>',
column_id: '<string>',
position: '<string>',
layout: 'full'
}
],
remote_eval_sources: [{url: '<string>', name: '<string>', description: '<string>'}],
disable_realtime_queries: true,
default_preprocessor: {type: 'function', id: '<string>', version: '<string>'}
}
})
};
fetch('https://api.braintrust.dev/v1/project/{project_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/project/{project_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'user_id' => '<string>',
'settings' => [
'comparison_key' => '<string>',
'baseline_experiment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'spanFieldOrder' => [
[
'object_type' => '<string>',
'column_id' => '<string>',
'position' => '<string>',
'layout' => 'full'
]
],
'remote_eval_sources' => [
[
'url' => '<string>',
'name' => '<string>',
'description' => '<string>'
]
],
'disable_realtime_queries' => true,
'default_preprocessor' => [
'type' => 'function',
'id' => '<string>',
'version' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.braintrust.dev/v1/project/{project_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"user_id\": \"<string>\",\n \"settings\": {\n \"comparison_key\": \"<string>\",\n \"baseline_experiment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"spanFieldOrder\": [\n {\n \"object_type\": \"<string>\",\n \"column_id\": \"<string>\",\n \"position\": \"<string>\",\n \"layout\": \"full\"\n }\n ],\n \"remote_eval_sources\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"disable_realtime_queries\": true,\n \"default_preprocessor\": {\n \"type\": \"function\",\n \"id\": \"<string>\",\n \"version\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.braintrust.dev/v1/project/{project_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"user_id\": \"<string>\",\n \"settings\": {\n \"comparison_key\": \"<string>\",\n \"baseline_experiment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"spanFieldOrder\": [\n {\n \"object_type\": \"<string>\",\n \"column_id\": \"<string>\",\n \"position\": \"<string>\",\n \"layout\": \"full\"\n }\n ],\n \"remote_eval_sources\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"disable_realtime_queries\": true,\n \"default_preprocessor\": {\n \"type\": \"function\",\n \"id\": \"<string>\",\n \"version\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.braintrust.dev/v1/project/{project_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"user_id\": \"<string>\",\n \"settings\": {\n \"comparison_key\": \"<string>\",\n \"baseline_experiment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"spanFieldOrder\": [\n {\n \"object_type\": \"<string>\",\n \"column_id\": \"<string>\",\n \"position\": \"<string>\",\n \"layout\": \"full\"\n }\n ],\n \"remote_eval_sources\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"disable_realtime_queries\": true,\n \"default_preprocessor\": {\n \"type\": \"function\",\n \"id\": \"<string>\",\n \"version\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"created": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settings": {
"comparison_key": "<string>",
"baseline_experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"spanFieldOrder": [
{
"object_type": "<string>",
"column_id": "<string>",
"position": "<string>",
"layout": "full"
}
],
"remote_eval_sources": [
{
"url": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"disable_realtime_queries": true,
"default_preprocessor": {
"type": "function",
"id": "<string>",
"version": "<string>"
}
}
}"<string>""<string>""<string>""<string>""<string>"Projects
Partially update project
Partially update a project 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
/
project
/
{project_id}
Partially update project
curl --request PATCH \
--url https://api.braintrust.dev/v1/project/{project_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"user_id": "<string>",
"settings": {
"comparison_key": "<string>",
"baseline_experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"spanFieldOrder": [
{
"object_type": "<string>",
"column_id": "<string>",
"position": "<string>",
"layout": "full"
}
],
"remote_eval_sources": [
{
"url": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"disable_realtime_queries": true,
"default_preprocessor": {
"type": "function",
"id": "<string>",
"version": "<string>"
}
}
}
'import requests
url = "https://api.braintrust.dev/v1/project/{project_id}"
payload = {
"name": "<string>",
"description": "<string>",
"user_id": "<string>",
"settings": {
"comparison_key": "<string>",
"baseline_experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"spanFieldOrder": [
{
"object_type": "<string>",
"column_id": "<string>",
"position": "<string>",
"layout": "full"
}
],
"remote_eval_sources": [
{
"url": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"disable_realtime_queries": True,
"default_preprocessor": {
"type": "function",
"id": "<string>",
"version": "<string>"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
user_id: '<string>',
settings: {
comparison_key: '<string>',
baseline_experiment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
spanFieldOrder: [
{
object_type: '<string>',
column_id: '<string>',
position: '<string>',
layout: 'full'
}
],
remote_eval_sources: [{url: '<string>', name: '<string>', description: '<string>'}],
disable_realtime_queries: true,
default_preprocessor: {type: 'function', id: '<string>', version: '<string>'}
}
})
};
fetch('https://api.braintrust.dev/v1/project/{project_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/project/{project_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'user_id' => '<string>',
'settings' => [
'comparison_key' => '<string>',
'baseline_experiment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'spanFieldOrder' => [
[
'object_type' => '<string>',
'column_id' => '<string>',
'position' => '<string>',
'layout' => 'full'
]
],
'remote_eval_sources' => [
[
'url' => '<string>',
'name' => '<string>',
'description' => '<string>'
]
],
'disable_realtime_queries' => true,
'default_preprocessor' => [
'type' => 'function',
'id' => '<string>',
'version' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.braintrust.dev/v1/project/{project_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"user_id\": \"<string>\",\n \"settings\": {\n \"comparison_key\": \"<string>\",\n \"baseline_experiment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"spanFieldOrder\": [\n {\n \"object_type\": \"<string>\",\n \"column_id\": \"<string>\",\n \"position\": \"<string>\",\n \"layout\": \"full\"\n }\n ],\n \"remote_eval_sources\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"disable_realtime_queries\": true,\n \"default_preprocessor\": {\n \"type\": \"function\",\n \"id\": \"<string>\",\n \"version\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.braintrust.dev/v1/project/{project_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"user_id\": \"<string>\",\n \"settings\": {\n \"comparison_key\": \"<string>\",\n \"baseline_experiment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"spanFieldOrder\": [\n {\n \"object_type\": \"<string>\",\n \"column_id\": \"<string>\",\n \"position\": \"<string>\",\n \"layout\": \"full\"\n }\n ],\n \"remote_eval_sources\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"disable_realtime_queries\": true,\n \"default_preprocessor\": {\n \"type\": \"function\",\n \"id\": \"<string>\",\n \"version\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.braintrust.dev/v1/project/{project_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"user_id\": \"<string>\",\n \"settings\": {\n \"comparison_key\": \"<string>\",\n \"baseline_experiment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"spanFieldOrder\": [\n {\n \"object_type\": \"<string>\",\n \"column_id\": \"<string>\",\n \"position\": \"<string>\",\n \"layout\": \"full\"\n }\n ],\n \"remote_eval_sources\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"disable_realtime_queries\": true,\n \"default_preprocessor\": {\n \"type\": \"function\",\n \"id\": \"<string>\",\n \"version\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"created": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settings": {
"comparison_key": "<string>",
"baseline_experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"spanFieldOrder": [
{
"object_type": "<string>",
"column_id": "<string>",
"position": "<string>",
"layout": "full"
}
],
"remote_eval_sources": [
{
"url": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"disable_realtime_queries": true,
"default_preprocessor": {
"type": "function",
"id": "<string>",
"version": "<string>"
}
}
}"<string>""<string>""<string>""<string>""<string>"Authorizations
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
Project id
Body
application/json
Fields to update
Response
Returns the project object
Unique identifier for the project
Unique id for the organization that the project belongs under
Name of the project
Textual description of the project
Date of project creation
Date of project deletion, or null if the project is still active
Identifies the user who created the project
Show child attributes
Show child attributes
Was this page helpful?
⌘I