Launch Week 02 wrapped — explore all five launches

Update Branch

PUThttps://api.confident-ai.com/v1/prompts/{alias}/branches/{name}

Updates the name of an existing branch in your prompt on Confident AI.

PUT/v1/prompts/{alias}/branches/{name}
curl -X PUT "https://api.confident-ai.com/v1/prompts/{alias}/branches/{name}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "RenamedBranch"
}'
200
{
  "success": true,
  "data": {
    "id": "br_123456"
  },
  "deprecated": false
}

Headers

  • CONFIDENT_API_KEYstringRequired

    The API key of your Confident AI project.

Path parameters

  • aliasstringRequired

    The unique alias of the prompt.

  • namestringRequired

    The unique name of the branch you're trying to update.

Request body

  • namestring

    The new name of the branch you're trying to update.

  • requiredany

Response

  • successboolean

    This is true if the prompt branch was successfully deleted.

  • dataobject

    Show 1 propertyHide 1 property
    • idstring

      This is the id of the updated prompt branch.

  • deprecatedboolean

    This is true if this endpoint is deprecated.

Built byConfident AI