Skip to main content
GET
/
v1
/
prompt
List prompts
curl --request GET \
  --url https://api.braintrust.dev/v1/prompt \
  --header 'Authorization: Bearer <token>'
{
  "objects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "_xact_id": "<string>",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "log_id": "p",
      "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "prompt_data": {
        "prompt": {
          "type": "chat",
          "messages": [
            {
              "content": "<string>",
              "role": "system",
              "name": "<string>"
            }
          ],
          "tools": "<string>"
        },
        "options": {
          "model": "<string>",
          "params": {
            "use_cache": true,
            "temperature": 123,
            "top_p": 123,
            "max_tokens": 123,
            "max_completion_tokens": 123,
            "frequency_penalty": 123,
            "presence_penalty": 123,
            "response_format": {
              "type": "json_object"
            },
            "tool_choice": "auto",
            "function_call": "auto",
            "n": 123,
            "stop": [
              "<string>"
            ],
            "reasoning_effort": "minimal",
            "verbosity": "low"
          },
          "position": "<string>"
        },
        "parser": {
          "type": "llm_classifier",
          "use_cot": true,
          "choice_scores": {}
        },
        "tool_functions": [
          {
            "type": "function",
            "id": "<string>"
          }
        ],
        "origin": {
          "prompt_id": "<string>",
          "project_id": "<string>",
          "prompt_version": "<string>"
        }
      },
      "tags": [
        "<string>"
      ],
      "metadata": {},
      "function_type": "llm"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Most Braintrust endpoints are authenticated by providing your API key as a header Authorization: Bearer [api_key] to your HTTP request. You can create an API key in the Braintrust organization settings page.

Query Parameters

​
limit
integer | null

Limit the number of objects to return

Required range: x >= 0
​
starting_after
string<uuid>

Pagination cursor id.

For example, if the final item in the last page you fetched had an id of foo, pass starting_after=foo to fetch the next page. Note: you may only pass one of starting_after and ending_before

​
ending_before
string<uuid>

Pagination cursor id.

For example, if the initial item in the last page you fetched had an id of foo, pass ending_before=foo to fetch the previous page. Note: you may only pass one of starting_after and ending_before

​
ids

Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times

​
prompt_name
string

Name of the prompt to search for

​
project_name
string

Name of the project to search for

​
project_id
string<uuid>

Project id

​
slug
string

Retrieve prompt with a specific slug

​
version
string

Retrieve prompt at a specific version.

The version id can either be a transaction id (e.g. '1000192656880881099') or a version identifier (e.g. '81cd05ee665fdfb3').

​
org_name
string

Filter search results to within a particular organization

Response

Returns a list of prompt objects

​
objects
object[]
required

A list of prompt objects