Braintest
POST/v1/project

Create project

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

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

Any desired information about the new project object

namestringrequired

Name of the project

org_namestringoptional

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.

6 status codes
200Returns the new project object
idstringrequired

Unique identifier for the project

org_idstringrequired

Unique id for the organization that the project belongs under

namestringrequired

Name of the project

createdstringoptional

Date of project creation

deleted_atstringoptional

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

user_idstringoptional

Identifies the user who created the project

settingsobjectoptional
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something went wrong on Braintrust's end. (These are rare.)

Error handling

A 400 is returned: The request was unacceptable, often due to missing a required parameter A 401 is returned: No valid API key provided A 403 is returned: The API key doesn’t have permissions to perform the request A 429 is returned: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests A 500 is returned: Something went wrong on Braintrust's end. (These are rare.)