Skip to main content
PATCH
/
v1
/
project_tag
/
{project_tag_id}
Partially update project_tag
curl --request PATCH \
  --url https://api.braintrust.dev/v1/project_tag/{project_tag_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "color": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "color": "<string>",
  "position": "<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

​
project_tag_id
string<uuid>
required

ProjectTag id

Body

application/json

Fields to update

​
name
string | null

Name of the project tag

​
description
string | null

Textual description of the project tag

​
color
string | null

Color of the tag for the UI

Response

Returns the project_tag object

A project tag is a user-configured tag for tracking and filtering your experiments, logs, and other data

​
id
string<uuid>
required

Unique identifier for the project tag

​
project_id
string<uuid>
required

Unique identifier for the project that the project tag belongs under

​
user_id
string<uuid>
required
​
name
string
required

Name of the project tag

​
created
string<date-time> | null

Date of project tag creation

​
description
string | null

Textual description of the project tag

​
color
string | null

Color of the tag for the UI

​
position
string | null

An optional LexoRank-based string that sets the sort position for the tag in the UI