Update Branch

PUThttps://api.confident-ai.com/v2/prompts/{promptId}/branches/{branchId}

Renames a branch of the prompt. The main branch cannot be renamed.

PUT/v2/prompts/{promptId}/branches/{branchId}

curl -X PUT "https://api.confident-ai.com/v2/prompts/{promptId}/branches/{branchId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "experiment-v2"
}'

200

{
  "success": true,
  "data": {
    "id": "<BRANCH-ID>"
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

promptIdstringRequired
The unique id of the prompt.
branchIdstringRequired
The unique id of the branch.

Request body

namestringRequired
The new name of the branch. The main branch cannot be renamed.

Response

Update Branch succeeded.

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- idstring
  This is the unique id of the prompt branch.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI