List Prompts

GEThttps://api.confident-ai.com/v2/prompts

Lists all the prompts in your Confident AI project.

GET/v2/prompts

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

200

{
  "success": true,
  "data": {
    "prompts": [
      {
        "id": "<PROMPT-ID>",
        "alias": "greeting",
        "type": "TEXT"
      }
    ]
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Response

List Prompts succeeded.

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- promptslist of objects
  This is the list of prompts in your project.
  Show 3 propertiesHide 3 properties
  - idstring
    This is the unique id of the prompt.
  - aliasstring
    This is the alias of the prompt, which is unique within your project.
  - typeenum
    This is the type of the prompt, which can be either a simple text or a list of messages.
    Show 2 enum valuesHide 2 enum values
    TEXT
    LIST
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI