---
title: "Partially update ai_secret"
method: PATCH
path: "/v1/ai_secret/{ai_secret_id}"
tags: ["AiSecrets"]
---

# Partially update ai_secret

`PATCH /v1/ai_secret/{ai_secret_id}`

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.

## Path parameters

- `ai_secret_id` string, uuid, required — AiSecret id

## Request body

- PatchAISecret
  - `name` string, nullable — Name of the AI secret
  - `type` string, nullable
  - `metadata` object, nullable
  - `secret` string, nullable

## Response `200`

Returns the ai_secret object

- AISecret
  - `id` string, uuid, required — Unique identifier for the AI secret
  - `created` string, date-time, nullable — Date of AI secret creation
  - `org_id` string, uuid, required — Unique identifier for the organization
  - `name` string, required — Name of the AI secret
  - `type` string, nullable
  - `metadata` object, nullable
  - `preview_secret` string, nullable

## Other responses

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

---

[API](https://skmtc.net/braintrustdata/apis/braintrust-api.md) · [All operations](https://skmtc.net/braintrustdata/apis/braintrust-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/braintrustdata/braintrust-api/revisions/9d216c8243fe/schema)