Skip to main content
POST
/
v1
/
experiment
/
{experiment_id}
/
insert
Insert experiment events
curl --request POST \
  --url https://api.braintrust.dev/v1/experiment/{experiment_id}/insert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "input": "<unknown>",
      "output": "<unknown>",
      "expected": "<unknown>",
      "error": "<unknown>",
      "scores": {},
      "metadata": {
        "model": "<string>"
      },
      "tags": [
        "<string>"
      ],
      "metrics": {
        "start": 123,
        "end": 123,
        "prompt_tokens": 123,
        "completion_tokens": 123,
        "tokens": 123,
        "caller_functionname": "<unknown>",
        "caller_filename": "<unknown>",
        "caller_lineno": "<unknown>"
      },
      "context": {
        "caller_functionname": "<string>",
        "caller_filename": "<string>",
        "caller_lineno": 123
      },
      "span_attributes": {
        "name": "<string>"
      },
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "origin": {
        "object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "id": "<string>",
        "_xact_id": "<string>",
        "created": "<string>"
      },
      "facets": {},
      "_object_delete": true,
      "_is_merge": true,
      "_merge_paths": [
        [
          "<string>"
        ]
      ],
      "_array_delete": [
        {
          "path": [
            "<string>"
          ],
          "delete": [
            null
          ]
        }
      ],
      "_parent_id": "<string>",
      "span_id": "<string>",
      "root_span_id": "<string>",
      "span_parents": [
        "<string>"
      ]
    }
  ]
}
'
import requests

url = "https://api.braintrust.dev/v1/experiment/{experiment_id}/insert"

payload = { "events": [
        {
            "input": "<unknown>",
            "output": "<unknown>",
            "expected": "<unknown>",
            "error": "<unknown>",
            "scores": {},
            "metadata": { "model": "<string>" },
            "tags": ["<string>"],
            "metrics": {
                "start": 123,
                "end": 123,
                "prompt_tokens": 123,
                "completion_tokens": 123,
                "tokens": 123,
                "caller_functionname": "<unknown>",
                "caller_filename": "<unknown>",
                "caller_lineno": "<unknown>"
            },
            "context": {
                "caller_functionname": "<string>",
                "caller_filename": "<string>",
                "caller_lineno": 123
            },
            "span_attributes": { "name": "<string>" },
            "id": "<string>",
            "created": "2023-11-07T05:31:56Z",
            "origin": {
                "object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "id": "<string>",
                "_xact_id": "<string>",
                "created": "<string>"
            },
            "facets": {},
            "_object_delete": True,
            "_is_merge": True,
            "_merge_paths": [["<string>"]],
            "_array_delete": [
                {
                    "path": ["<string>"],
                    "delete": [None]
                }
            ],
            "_parent_id": "<string>",
            "span_id": "<string>",
            "root_span_id": "<string>",
            "span_parents": ["<string>"]
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: [
      {
        input: '<unknown>',
        output: '<unknown>',
        expected: '<unknown>',
        error: '<unknown>',
        scores: {},
        metadata: {model: '<string>'},
        tags: ['<string>'],
        metrics: {
          start: 123,
          end: 123,
          prompt_tokens: 123,
          completion_tokens: 123,
          tokens: 123,
          caller_functionname: '<unknown>',
          caller_filename: '<unknown>',
          caller_lineno: '<unknown>'
        },
        context: {
          caller_functionname: '<string>',
          caller_filename: '<string>',
          caller_lineno: 123
        },
        span_attributes: {name: '<string>'},
        id: '<string>',
        created: '2023-11-07T05:31:56Z',
        origin: {
          object_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
          id: '<string>',
          _xact_id: '<string>',
          created: '<string>'
        },
        facets: {},
        _object_delete: true,
        _is_merge: true,
        _merge_paths: [['<string>']],
        _array_delete: [{path: ['<string>'], delete: [null]}],
        _parent_id: '<string>',
        span_id: '<string>',
        root_span_id: '<string>',
        span_parents: ['<string>']
      }
    ]
  })
};

fetch('https://api.braintrust.dev/v1/experiment/{experiment_id}/insert', 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/experiment/{experiment_id}/insert",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'events' => [
        [
                'input' => '<unknown>',
                'output' => '<unknown>',
                'expected' => '<unknown>',
                'error' => '<unknown>',
                'scores' => [
                                
                ],
                'metadata' => [
                                'model' => '<string>'
                ],
                'tags' => [
                                '<string>'
                ],
                'metrics' => [
                                'start' => 123,
                                'end' => 123,
                                'prompt_tokens' => 123,
                                'completion_tokens' => 123,
                                'tokens' => 123,
                                'caller_functionname' => '<unknown>',
                                'caller_filename' => '<unknown>',
                                'caller_lineno' => '<unknown>'
                ],
                'context' => [
                                'caller_functionname' => '<string>',
                                'caller_filename' => '<string>',
                                'caller_lineno' => 123
                ],
                'span_attributes' => [
                                'name' => '<string>'
                ],
                'id' => '<string>',
                'created' => '2023-11-07T05:31:56Z',
                'origin' => [
                                'object_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                'id' => '<string>',
                                '_xact_id' => '<string>',
                                'created' => '<string>'
                ],
                'facets' => [
                                
                ],
                '_object_delete' => true,
                '_is_merge' => true,
                '_merge_paths' => [
                                [
                                                                '<string>'
                                ]
                ],
                '_array_delete' => [
                                [
                                                                'path' => [
                                                                                                                                '<string>'
                                                                ],
                                                                'delete' => [
                                                                                                                                null
                                                                ]
                                ]
                ],
                '_parent_id' => '<string>',
                'span_id' => '<string>',
                'root_span_id' => '<string>',
                'span_parents' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://api.braintrust.dev/v1/experiment/{experiment_id}/insert"

	payload := strings.NewReader("{\n  \"events\": [\n    {\n      \"input\": \"<unknown>\",\n      \"output\": \"<unknown>\",\n      \"expected\": \"<unknown>\",\n      \"error\": \"<unknown>\",\n      \"scores\": {},\n      \"metadata\": {\n        \"model\": \"<string>\"\n      },\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"metrics\": {\n        \"start\": 123,\n        \"end\": 123,\n        \"prompt_tokens\": 123,\n        \"completion_tokens\": 123,\n        \"tokens\": 123,\n        \"caller_functionname\": \"<unknown>\",\n        \"caller_filename\": \"<unknown>\",\n        \"caller_lineno\": \"<unknown>\"\n      },\n      \"context\": {\n        \"caller_functionname\": \"<string>\",\n        \"caller_filename\": \"<string>\",\n        \"caller_lineno\": 123\n      },\n      \"span_attributes\": {\n        \"name\": \"<string>\"\n      },\n      \"id\": \"<string>\",\n      \"created\": \"2023-11-07T05:31:56Z\",\n      \"origin\": {\n        \"object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"id\": \"<string>\",\n        \"_xact_id\": \"<string>\",\n        \"created\": \"<string>\"\n      },\n      \"facets\": {},\n      \"_object_delete\": true,\n      \"_is_merge\": true,\n      \"_merge_paths\": [\n        [\n          \"<string>\"\n        ]\n      ],\n      \"_array_delete\": [\n        {\n          \"path\": [\n            \"<string>\"\n          ],\n          \"delete\": [\n            null\n          ]\n        }\n      ],\n      \"_parent_id\": \"<string>\",\n      \"span_id\": \"<string>\",\n      \"root_span_id\": \"<string>\",\n      \"span_parents\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.braintrust.dev/v1/experiment/{experiment_id}/insert")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    {\n      \"input\": \"<unknown>\",\n      \"output\": \"<unknown>\",\n      \"expected\": \"<unknown>\",\n      \"error\": \"<unknown>\",\n      \"scores\": {},\n      \"metadata\": {\n        \"model\": \"<string>\"\n      },\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"metrics\": {\n        \"start\": 123,\n        \"end\": 123,\n        \"prompt_tokens\": 123,\n        \"completion_tokens\": 123,\n        \"tokens\": 123,\n        \"caller_functionname\": \"<unknown>\",\n        \"caller_filename\": \"<unknown>\",\n        \"caller_lineno\": \"<unknown>\"\n      },\n      \"context\": {\n        \"caller_functionname\": \"<string>\",\n        \"caller_filename\": \"<string>\",\n        \"caller_lineno\": 123\n      },\n      \"span_attributes\": {\n        \"name\": \"<string>\"\n      },\n      \"id\": \"<string>\",\n      \"created\": \"2023-11-07T05:31:56Z\",\n      \"origin\": {\n        \"object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"id\": \"<string>\",\n        \"_xact_id\": \"<string>\",\n        \"created\": \"<string>\"\n      },\n      \"facets\": {},\n      \"_object_delete\": true,\n      \"_is_merge\": true,\n      \"_merge_paths\": [\n        [\n          \"<string>\"\n        ]\n      ],\n      \"_array_delete\": [\n        {\n          \"path\": [\n            \"<string>\"\n          ],\n          \"delete\": [\n            null\n          ]\n        }\n      ],\n      \"_parent_id\": \"<string>\",\n      \"span_id\": \"<string>\",\n      \"root_span_id\": \"<string>\",\n      \"span_parents\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.braintrust.dev/v1/experiment/{experiment_id}/insert")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    {\n      \"input\": \"<unknown>\",\n      \"output\": \"<unknown>\",\n      \"expected\": \"<unknown>\",\n      \"error\": \"<unknown>\",\n      \"scores\": {},\n      \"metadata\": {\n        \"model\": \"<string>\"\n      },\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"metrics\": {\n        \"start\": 123,\n        \"end\": 123,\n        \"prompt_tokens\": 123,\n        \"completion_tokens\": 123,\n        \"tokens\": 123,\n        \"caller_functionname\": \"<unknown>\",\n        \"caller_filename\": \"<unknown>\",\n        \"caller_lineno\": \"<unknown>\"\n      },\n      \"context\": {\n        \"caller_functionname\": \"<string>\",\n        \"caller_filename\": \"<string>\",\n        \"caller_lineno\": 123\n      },\n      \"span_attributes\": {\n        \"name\": \"<string>\"\n      },\n      \"id\": \"<string>\",\n      \"created\": \"2023-11-07T05:31:56Z\",\n      \"origin\": {\n        \"object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"id\": \"<string>\",\n        \"_xact_id\": \"<string>\",\n        \"created\": \"<string>\"\n      },\n      \"facets\": {},\n      \"_object_delete\": true,\n      \"_is_merge\": true,\n      \"_merge_paths\": [\n        [\n          \"<string>\"\n        ]\n      ],\n      \"_array_delete\": [\n        {\n          \"path\": [\n            \"<string>\"\n          ],\n          \"delete\": [\n            null\n          ]\n        }\n      ],\n      \"_parent_id\": \"<string>\",\n      \"span_id\": \"<string>\",\n      \"root_span_id\": \"<string>\",\n      \"span_parents\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "row_ids": [
    "<string>"
  ]
}
"<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.

Path Parameters

​
experiment_id
string<uuid>
required

Experiment id

Body

application/json

An array of experiment events to insert

​
events
object[]
required

A list of experiment events to insert

Response

Returns the inserted row ids

​
row_ids
string[]
required

The ids of all rows that were inserted, aligning one-to-one with the rows provided as input