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 Center Status Support Get a demo Platform

Documentation Evals API Reference Integrations & OTEL Platform Settings Self-Hosting Guides Changelog

Documentation Evals API Reference Integrations & OTEL Platform Settings Self-Hosting Guides Changelog

Get Started
Data Models
Evals
Legacy

Trust Center Status Support Get a demo Platform

Data Models Prompts Labels

Pull Prompts By Label

GET

https://api.confident-ai.com/v1/prompts/:alias/labels/:label

GET

/v1/prompts/:alias/labels/:label

$ curl https://api.confident-ai.com/v1/prompts/PROMPT-ALIAS/labels/PROMPT-LABEL \
>      -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

1 {
2   "success": true,
3   "data": {
4     "id": "prv_abc123",
5     "hash": "bab04ce",
6     "type": "TEXT",
7     "interpolationType": "FSTRING",
8     "outputType": "TEXT",
9     "version": "00.00.02",
10     "label": "my-label",
11     "text": "Hello, {{name}}!",
12     "modelSettings": {
13       "provider": "OPEN_AI",
14       "name": "gpt-4o",
15       "temperature": 0.7
16     }
17   },
18   "deprecated": false
19 }

Retrieves a prompt with alias and label from your Confident AI account.

Was this page helpful?

List Versions

Path parameters

aliasstringRequired

The unique alias of the prompt.

labelstringRequired

The label name of the prompt.

Headers

CONFIDENT_API_KEYstringRequired

The API key of your Confident AI project.

Response

successboolean

This is true if the prompt was successfully retrieved.

dataobject

deprecatedboolean

This is true if this endpoint is deprecated.