List Branches

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

Retrieves a list of all the branches associated with a prompt

GET/v1/prompts/{alias}/branches

curl -X GET "https://api.confident-ai.com/v1/prompts/{alias}/branches" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "branches": [
      {
        "id": "br_123456",
        "name": "main"
      },
      {
        "id": "br_123789",
        "name": "NewBranch"
      }
    ]
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

aliasstringRequired
The unique alias of the prompt.

Response

successboolean
This is true if the prompt branches were successfully retrieved.
dataobject
Show 1 propertyHide 1 property
- brancheslist of objects
  Show 2 propertiesHide 2 properties
  - idstring
    This is the unique id of the prompt branch.
  - namestring
    This is the name of the prompt branch.
deprecatedboolean
This is true if this endpoint is deprecated.

Built byConfident AI