BRbraintrustdata
AiSecrets

Partially update AI secret

Changed on

Partially update an AI secret object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.

patch/v1/ai_secret/{ai_secret_id}

Request

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

Path parameters

ai_secret_idstring uuid required

AiSecret id

Request body

namestring nullable

Name of the AI secret

typestring nullable
metadataobject nullable
secretstring nullable

Response

Returns the AI secret object

idstring uuid required

Unique identifier for the AI secret

createdstring date-time nullable

Date of AI secret creation

updated_atstring date-time nullable

Date of last AI secret update

secret_updated_atstring date-time nullable

Date of last update to the encrypted secret value itself

org_idstring uuid required

Unique identifier for the organization

namestring required

Name of the AI secret

typestring nullable
metadataobject nullable
secret_updated_by_user_idstring uuid nullable

User id of the last update to the encrypted secret value

preview_secretstring nullable

Changes

  • 8f5039399f77Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

  • 7c3461755f69Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status