Skip to main content
GET
/
v1
/
function
List functions
curl --request GET \
  --url https://api.braintrust.dev/v1/function \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.braintrust.dev/v1/function"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.braintrust.dev/v1/function', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.braintrust.dev/v1/function",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.braintrust.dev/v1/function"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.braintrust.dev/v1/function")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.braintrust.dev/v1/function")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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>",
      "function_data": {
        "type": "prompt"
      },
      "description": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "prompt_data": {
        "prompt": {
          "type": "chat",
          "messages": [
            {
              "role": "system",
              "content": "",
              "name": "<string>"
            }
          ],
          "tools": "<string>"
        },
        "options": {
          "model": "<string>",
          "params": {
            "use_cache": true,
            "reasoning_enabled": true,
            "reasoning_budget": 123,
            "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>"
            ]
          },
          "position": "<string>"
        },
        "parser": {
          "type": "llm_classifier",
          "use_cot": true,
          "choice_scores": {},
          "choice": [
            "<string>"
          ],
          "allow_no_match": true,
          "allow_skip": true
        },
        "tool_functions": [
          {
            "type": "function",
            "id": "<string>",
            "version": "<string>"
          }
        ],
        "mcp": {},
        "origin": {
          "prompt_id": "<string>",
          "project_id": "<string>",
          "prompt_version": "<string>"
        }
      },
      "tags": [
        "<string>"
      ],
      "metadata": {},
      "origin": {
        "object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "internal": true
      },
      "function_schema": {
        "parameters": null,
        "returns": null
      }
    }
  ]
}
"<string>"
"<string>"
"<string>"
"<string>"
"<string>"

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

​
function_name
string

Name of the function 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').

​
environment
string

Filter by environment slug. Cannot be used together with version.

For GET /v1/prompt, environment resolution currently requires the request to match a single prompt. If multiple prompts match, the endpoint returns 400 (for example when limit=1 is not set). Use limit=1 or other filters (for example slug, project_id) to narrow results.

​
org_name
string

Filter search results to within a particular organization

Response

Returns a list of function objects

​
objects
object[]
required

A list of function objects