{
  "opencollection": "1.0.0",
  "info": {
    "name": "Braintrust Acls Experiments API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Experiments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List experiments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.braintrust.dev/v1/experiment",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of objects to return"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "Pagination cursor id.\n\nFor 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`"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "Pagination cursor id.\n\nFor 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`"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times"
              },
              {
                "name": "experiment_name",
                "value": "",
                "type": "query",
                "description": "Name of the experiment to search for"
              },
              {
                "name": "project_name",
                "value": "",
                "type": "query",
                "description": "Name of the project to search for"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "query",
                "description": "Project id"
              },
              {
                "name": "org_name",
                "value": "",
                "type": "query",
                "description": "Filter search results to within a particular organization"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "List out all experiments. The experiments are sorted by creation date, with the most recently-created experiments coming first"
        },
        {
          "info": {
            "name": "Create experiment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.braintrust.dev/v1/experiment",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new experiment. If there is an existing experiment in the project with the same name as the one specified in the request, will return the existing experiment unmodified"
        },
        {
          "info": {
            "name": "Get experiment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.braintrust.dev/v1/experiment/:experiment_id",
            "params": [
              {
                "name": "experiment_id",
                "value": "",
                "type": "path",
                "description": "Experiment id"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get an experiment object by its id"
        },
        {
          "info": {
            "name": "Partially update experiment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.braintrust.dev/v1/experiment/:experiment_id",
            "params": [
              {
                "name": "experiment_id",
                "value": "",
                "type": "path",
                "description": "Experiment id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Partially update an experiment object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null."
        },
        {
          "info": {
            "name": "Delete experiment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.braintrust.dev/v1/experiment/:experiment_id",
            "params": [
              {
                "name": "experiment_id",
                "value": "",
                "type": "path",
                "description": "Experiment id"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete an experiment object by its id"
        },
        {
          "info": {
            "name": "Insert experiment events",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.braintrust.dev/v1/experiment/:experiment_id/insert",
            "params": [
              {
                "name": "experiment_id",
                "value": "",
                "type": "path",
                "description": "Experiment id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Insert a set of events into the experiment"
        },
        {
          "info": {
            "name": "Fetch experiment (GET form)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.braintrust.dev/v1/experiment/:experiment_id/fetch",
            "params": [
              {
                "name": "experiment_id",
                "value": "",
                "type": "path",
                "description": "Experiment id"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "limit the number of traces fetched\n\nFetch queries may be paginated if the total result size is expected to be large (e.g. project_logs which accumulate over a long time). Note that fetch queries only support pagination in descending time order (from latest to earliest `_xact_id`. Furthermore, later pages may return rows which showed up in earlier pages, except with an earlier `_xact_id`. This happens because pagination occurs over the whole version history of the event log. You will most likely want to exclude any such duplicate, outdated rows (by `id`) from your combined result set.\n\nThe `limit` parameter controls the number of full traces to return. So you may end up with more individual rows than the specified limit if you are fetching events containing traces."
              },
              {
                "name": "max_xact_id",
                "value": "",
                "type": "query",
                "description": "DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests. Please prefer the 'cursor' argument going forwards.\n\nTogether, `max_xact_id` and `max_root_span_id` form a pagination cursor\n\nSince a paginated fetch query returns results in order from latest to earliest, the cursor for the next page can be found as the row with the minimum (earliest) value of the tuple `(_xact_id, root_span_id)`. See the documentation of `limit` for an overview of paginating fetch queries."
              },
              {
                "name": "max_root_span_id",
                "value": "",
                "type": "query",
                "description": "DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests. Please prefer the 'cursor' argument going forwards.\n\nTogether, `max_xact_id` and `max_root_span_id` form a pagination cursor\n\nSince a paginated fetch query returns results in order from latest to earliest, the cursor for the next page can be found as the row with the minimum (earliest) value of the tuple `(_xact_id, root_span_id)`. See the documentation of `limit` for an overview of paginating fetch queries."
              },
              {
                "name": "version",
                "value": "",
                "type": "query",
                "description": "Retrieve a snapshot of events from a past time\n\nThe version id is essentially a filter on the latest event transaction id. You can use the `max_xact_id` returned by a past fetch as the version to reproduce that exact fetch."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetch the events in an experiment. Equivalent to the POST form of the same path, but with the parameters in the URL query rather than in the request body. For more complex queries, use the `POST /btql` endpoint."
        },
        {
          "info": {
            "name": "Fetch experiment (POST form)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.braintrust.dev/v1/experiment/:experiment_id/fetch",
            "params": [
              {
                "name": "experiment_id",
                "value": "",
                "type": "path",
                "description": "Experiment id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetch the events in an experiment. Equivalent to the GET form of the same path, but with the parameters in the request body rather than in the URL query. For more complex queries, use the `POST /btql` endpoint."
        },
        {
          "info": {
            "name": "Feedback for experiment events",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.braintrust.dev/v1/experiment/:experiment_id/feedback",
            "params": [
              {
                "name": "experiment_id",
                "value": "",
                "type": "path",
                "description": "Experiment id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Log feedback for a set of experiment events"
        },
        {
          "info": {
            "name": "Summarize experiment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.braintrust.dev/v1/experiment/:experiment_id/summarize",
            "params": [
              {
                "name": "experiment_id",
                "value": "",
                "type": "path",
                "description": "Experiment id"
              },
              {
                "name": "summarize_scores",
                "value": "",
                "type": "query",
                "description": "Whether to summarize the scores and metrics. If false (or omitted), only the metadata will be returned."
              },
              {
                "name": "comparison_experiment_id",
                "value": "",
                "type": "query",
                "description": "The experiment to compare against, if summarizing scores and metrics. If omitted, will fall back to the `base_exp_id` stored in the experiment metadata, and then to the most recent experiment run in the same project. Must pass `summarize_scores=true` for this id to be used"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Summarize experiment"
        }
      ]
    }
  ],
  "bundled": true
}