Create project

curl --request POST \
  --url https://api.braintrust.dev/v1/project \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "org_name": "<string>"
}
'

import requests

url = "https://api.braintrust.dev/v1/project"

payload = {
    "name": "<string>",
    "description": "<string>",
    "org_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', description: '<string>', org_name: '<string>'})
};

fetch('https://api.braintrust.dev/v1/project', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'org_name' => '<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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"org_name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.braintrust.dev/v1/project")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"org_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.braintrust.dev/v1/project")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"org_name\": \"<string>\"\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,
    "monitor_charts_use_metrics_start": true,
    "default_preprocessor": {
      "type": "function",
      "id": "<string>",
      "version": "<string>"
    }
  }
}

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

POST

project

Create project

curl --request POST \
  --url https://api.braintrust.dev/v1/project \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "org_name": "<string>"
}
'

import requests

url = "https://api.braintrust.dev/v1/project"

payload = {
    "name": "<string>",
    "description": "<string>",
    "org_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', description: '<string>', org_name: '<string>'})
};

fetch('https://api.braintrust.dev/v1/project', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'org_name' => '<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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"org_name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.braintrust.dev/v1/project")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"org_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.braintrust.dev/v1/project")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"org_name\": \"<string>\"\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,
    "monitor_charts_use_metrics_start": true,
    "default_preprocessor": {
      "type": "function",
      "id": "<string>",
      "version": "<string>"
    }
  }
}

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

Only name is required.

Omit parent_external_id to create a root project; workspace_external_id is then required, and a missing or malformed value returns 404 rather than 400, because it is resolved through the same access check used to look up an existing workspace.
Set parent_external_id to create a sub-project instead. In that case workspace_external_id is ignored entirely: the new project always inherits the parent’s workspace.
Nesting is capped at three levels; creating under a project already at that depth returns 400.
Omitted fields default: visibility to private, metadata to an empty object, description to an empty string.
slug is generated server-side from the name plus random letters and is not caller-controllable; treat external_id as the stable identifier.
There is no idempotency key, so repeating this call creates a second project with the same name.

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.

Body

application/json

Any desired information about the new project object

name

string

required

Name of the project

Minimum string length: 1

description

string | null

Textual description of the project

org_name

string | null

For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the project belongs in.

Response

Returns the new project object

string<uuid>

required

Unique identifier for the project

org_id

string<uuid>

required

Unique id for the organization that the project belongs under

name

string

required

Name of the project

description

string | null

Textual description of the project

created

string<date-time> | null

Date of project creation

deleted_at

string<date-time> | null

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

user_id

string<uuid> | null

Identifies the user who created the project

settings

object | null

Show child attributes

API

CLI

SQL

Create project

Authorizations

Body

Response