List Prompts

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

Lists all the available prompts in your Confident AI project.

GET/v1/prompts

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

200

{
  "success": true,
  "data": {
    "prompts": [
      {
        "id": "PROMPT-ID",
        "alias": "PROMPT-ALIAS",
        "type": "TEXT"
      }
    ]
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Response

successboolean
This is true if the prompts were successfully retrieved.
dataobject
This maps to all the prompts retrieved.
Show 1 propertyHide 1 property
- promptslist of objects
  Show 3 propertiesHide 3 properties
  - idstring
    This is the unique id of the dataset.
  - aliasstring
    This is the alias of the dataset, which is unique within your project.
  - typeenum
    This is the type of the prompt (TEXT or LIST).
    Show 2 enum valuesHide 2 enum values
    TEXT
    LIST
deprecatedboolean
This is true if this prompts endpoint is deprecated.

Built byConfident AI