For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Trust CenterStatusSupportGet a demoPlatform
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
    • Data Models
    • API Conventions
  • Data Models
      • GETList Prompts
      • POSTPush Prompts
        • GETList Branches
        • POSTCreate Branch
        • PUTUpdate Branch
        • DELDelete Branch
  • Evals
  • Legacy
LogoLogo
Trust CenterStatusSupportGet a demoPlatform
Data ModelsPromptsBranches

Update Branch

PUT
https://api.confident-ai.com/v1/prompts/:alias/branches/:name
PUT
/v1/prompts/:alias/branches/:name
$curl -X PUT https://api.confident-ai.com/v1/prompts/PROMPT-ALIAS/branches/BRANCH-NAME \
>     -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "RenamedBranch"
>}'
200Updated
1{
2  "success": true,
3  "data": {
4    "id": "br_123456"
5  },
6  "deprecated": false
7}
Updates the name of an existing branch in your prompt on Confident AI.
Was this page helpful?
Previous

Delete Branch

Next
Built with

Path parameters

aliasstringRequired
The unique alias of the prompt.
namestringRequired
The unique name of the branch you're trying to update.

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request

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

Response

successboolean
This is true if the prompt branch was successfully deleted.
dataobject
deprecatedboolean
This is true if this endpoint is deprecated.