List Branches

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

Lists the branches of the prompt.

GET/v2/prompts/{promptId}/branches

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

200

{
  "success": true,
  "data": {
    "branches": [
      {
        "id": "<BRANCH-ID>",
        "name": "experiment"
      }
    ]
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

promptIdstringRequired
The unique id of the prompt.

Response

List Branches succeeded.

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- brancheslist of objects
  This is the list of branches on the prompt.
  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
Indicates if this endpoint is deprecated.

Built byConfident AI