Skip to main content
PATCH
/
v1
/
organization
/
{organization_id}
Partially update organization
curl --request PATCH \
  --url https://api.braintrust.dev/v1/organization/{organization_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "api_url": "<string>",
  "is_universal_api": true,
  "is_dataplane_private": true,
  "proxy_url": "<string>",
  "realtime_url": "<string>"
}
'
import requests

url = "https://api.braintrust.dev/v1/organization/{organization_id}"

payload = {
    "name": "<string>",
    "api_url": "<string>",
    "is_universal_api": True,
    "is_dataplane_private": True,
    "proxy_url": "<string>",
    "realtime_url": "<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>',
    api_url: '<string>',
    is_universal_api: true,
    is_dataplane_private: true,
    proxy_url: '<string>',
    realtime_url: '<string>'
  })
};

fetch('https://api.braintrust.dev/v1/organization/{organization_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/organization/{organization_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>',
    'api_url' => '<string>',
    'is_universal_api' => true,
    'is_dataplane_private' => true,
    'proxy_url' => '<string>',
    'realtime_url' => '<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/organization/{organization_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"api_url\": \"<string>\",\n  \"is_universal_api\": true,\n  \"is_dataplane_private\": true,\n  \"proxy_url\": \"<string>\",\n  \"realtime_url\": \"<string>\"\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/organization/{organization_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"api_url\": \"<string>\",\n  \"is_universal_api\": true,\n  \"is_dataplane_private\": true,\n  \"proxy_url\": \"<string>\",\n  \"realtime_url\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.braintrust.dev/v1/organization/{organization_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  \"api_url\": \"<string>\",\n  \"is_universal_api\": true,\n  \"is_dataplane_private\": true,\n  \"proxy_url\": \"<string>\",\n  \"realtime_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "api_url": "<string>",
  "is_universal_api": true,
  "is_dataplane_private": true,
  "proxy_url": "<string>",
  "realtime_url": "<string>",
  "created": "2023-11-07T05:31:56Z"
}
"<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

​
organization_id
string<uuid>
required

Organization id

Body

application/json

Fields to update

​
name
string | null

Name of the organization

​
api_url
string | null
​
is_universal_api
boolean | null
​
is_dataplane_private
boolean | null
​
proxy_url
string | null
​
realtime_url
string | null
​
image_rendering_mode
enum<string> | null

Controls how images are rendered in the UI: 'auto' loads images automatically, 'click_to_load' shows a placeholder until clicked, 'blocked' prevents image loading entirely

Available options:
auto,
click_to_load,
blocked,
null

Response

Returns the organization object

​
id
string<uuid>
required

Unique identifier for the organization

​
name
string
required

Name of the organization

​
api_url
string | null
​
is_universal_api
boolean | null
​
is_dataplane_private
boolean | null
​
proxy_url
string | null
​
realtime_url
string | null
​
created
string<date-time> | null

Date of organization creation

​
image_rendering_mode
enum<string> | null

Controls how images are rendered in the UI: 'auto' loads images automatically, 'click_to_load' shows a placeholder until clicked, 'blocked' prevents image loading entirely

Available options:
auto,
click_to_load,
blocked,
null