Skip to main content
PUT
/
v1
/
group
Create or replace group
curl --request PUT \
  --url https://api.braintrust.dev/v1/group \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "member_users": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "member_groups": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "org_name": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "member_users": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "member_groups": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

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 group object

​
name
string
required

Name of the group

Minimum length: 1
​
description
string | null

Textual description of the group

​
member_users
string<uuid>[] | null

Ids of users which belong to this group

​
member_groups
string<uuid>[] | null

Ids of the groups this group inherits from

An inheriting group has all the users contained in its member groups, as well as all of their inherited users

​
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 group belongs in.

Response

Returns the new group object

A group is a collection of users which can be assigned an ACL

Groups can consist of individual users, as well as a set of groups they inherit from

​
id
string<uuid>
required

Unique identifier for the group

​
org_id
string<uuid>
required

Unique id for the organization that the group belongs under

It is forbidden to change the org after creating a group

​
name
string
required

Name of the group

​
user_id
string<uuid> | null

Identifies the user who created the group

​
created
string<date-time> | null

Date of group creation

​
description
string | null

Textual description of the group

​
deleted_at
string<date-time> | null

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

​
member_users
string<uuid>[] | null

Ids of users which belong to this group

​
member_groups
string<uuid>[] | null

Ids of the groups this group inherits from

An inheriting group has all the users contained in its member groups, as well as all of their inherited users