Projects

Create a new project. If there is an existing project with the same name as the one specified in the request, will return the existing project unmodified

post/v1/project

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Request body

namestring required

Name of the project

descriptionstring nullable

Textual description of the project

org_namestring nullable

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.

project_group_namestring nullable

Create the project within the named project group in this organization. Requires project_group:update on the group's definition.

Response

Returns the new project object

idstring uuid required

Unique identifier for the project

org_idstring uuid required

Unique id for the organization that the project belongs under

namestring required

Name of the project

descriptionstring nullable

Textual description of the project

createdstring date-time nullable

Date of project creation

deleted_atstring date-time nullable

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

user_idstring uuid nullable

Identifies the user who created the project

Changes

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • info

      removed the undefined enum value from the /// response property for the response status

    • info

      added the new optional request property