{ "opencollection": "1.0.0", "info": { "name": "Braintrust API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "List projects", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/project", "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": "project_name", "value": "", "type": "query", "description": "Name of the project to search for" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all projects. The projects are sorted by creation date, with the most recently-created projects coming first" }, { "info": { "name": "Create project", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/project", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new project. If there is an existing project with the same name as the one specified in the request, will return the existing project unmodified" }, { "info": { "name": "Get project", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/project/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a project object by its id" }, { "info": { "name": "Partially update project", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/project/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a project 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 project", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/project/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a project object by its id" } ] }, { "info": { "name": "CORS", "type": "folder" }, "items": [ { "info": { "name": "Enable CORS (`/v1/project`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/project" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/project/{project_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/project/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/project_logs/{project_id}/insert`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/project_logs/:project_id/insert", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/project_logs/{project_id}/fetch`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/project_logs/:project_id/fetch", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/project_logs/{project_id}/feedback`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/project_logs/:project_id/feedback", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/experiment`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/experiment" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/experiment/{experiment_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/experiment/:experiment_id", "params": [ { "name": "experiment_id", "value": "", "type": "path", "description": "Experiment id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/experiment/{experiment_id}/insert`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/experiment/:experiment_id/insert", "params": [ { "name": "experiment_id", "value": "", "type": "path", "description": "Experiment id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/experiment/{experiment_id}/fetch`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/experiment/:experiment_id/fetch", "params": [ { "name": "experiment_id", "value": "", "type": "path", "description": "Experiment id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/experiment/{experiment_id}/feedback`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/experiment/:experiment_id/feedback", "params": [ { "name": "experiment_id", "value": "", "type": "path", "description": "Experiment id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/experiment/{experiment_id}/summarize`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/experiment/:experiment_id/summarize", "params": [ { "name": "experiment_id", "value": "", "type": "path", "description": "Experiment id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/dataset`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/dataset" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/dataset/{dataset_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/dataset/{dataset_id}/insert`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id/insert", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/dataset/{dataset_id}/fetch`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id/fetch", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/dataset/{dataset_id}/feedback`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id/feedback", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/dataset/{dataset_id}/summarize`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id/summarize", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/prompt`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/prompt" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/prompt/{prompt_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/prompt/:prompt_id", "params": [ { "name": "prompt_id", "value": "", "type": "path", "description": "Prompt id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/role`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/role" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/role/{role_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/role/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "Role id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/group`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/group" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/group/{group_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/group/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "Group id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/acl`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/acl" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/acl/{acl_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/acl/:acl_id", "params": [ { "name": "acl_id", "value": "", "type": "path", "description": "Acl id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/acl/list_org`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/acl/list_org" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/acl/acl/batch_update`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/acl/acl/batch_update" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/user`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/user" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/user/{user_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/user/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/project_automation`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/project_automation" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/project_automation/{project_automation_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/project_automation/:project_automation_id", "params": [ { "name": "project_automation_id", "value": "", "type": "path", "description": "ProjectAutomation id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/project_score`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/project_score" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/project_score/{project_score_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/project_score/:project_score_id", "params": [ { "name": "project_score_id", "value": "", "type": "path", "description": "ProjectScore id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/project_tag`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/project_tag" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/project_tag/{project_tag_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/project_tag/:project_tag_id", "params": [ { "name": "project_tag_id", "value": "", "type": "path", "description": "ProjectTag id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/span_iframe`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/span_iframe" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/span_iframe/{span_iframe_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/span_iframe/:span_iframe_id", "params": [ { "name": "span_iframe_id", "value": "", "type": "path", "description": "SpanIframe id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/function`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/function" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/function/{function_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/function/:function_id", "params": [ { "name": "function_id", "value": "", "type": "path", "description": "Function id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/function/{function_id}/invoke`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/function/:function_id/invoke", "params": [ { "name": "function_id", "value": "", "type": "path", "description": "Function id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/view`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/view" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/view/{view_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/view/:view_id", "params": [ { "name": "view_id", "value": "", "type": "path", "description": "View id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/organization`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/organization" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/organization/{organization_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/organization/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Organization id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/organization/members`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/organization/members" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/api_key`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/api_key" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/api_key/{api_key_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/api_key/:api_key_id", "params": [ { "name": "api_key_id", "value": "", "type": "path", "description": "ApiKey id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/service_token`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/service_token" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/service_token/{service_token_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/service_token/:service_token_id", "params": [ { "name": "service_token_id", "value": "", "type": "path", "description": "ServiceToken id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/ai_secret`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/ai_secret" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/ai_secret/{ai_secret_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/ai_secret/:ai_secret_id", "params": [ { "name": "ai_secret_id", "value": "", "type": "path", "description": "AiSecret id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/env_var`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/env_var" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/env_var/{env_var_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/env_var/:env_var_id", "params": [ { "name": "env_var_id", "value": "", "type": "path", "description": "EnvVar id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/mcp_server`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/mcp_server" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/mcp_server/{mcp_server_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/mcp_server/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "McpServer id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/dataset_snapshot`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/dataset_snapshot" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/dataset_snapshot/{dataset_snapshot_id}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/dataset_snapshot/:dataset_snapshot_id", "params": [ { "name": "dataset_snapshot_id", "value": "", "type": "path", "description": "DatasetSnapshot id" } ] }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/insert`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/insert" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/proxy/chat/completions`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/proxy/chat/completions" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/proxy/completions`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/proxy/completions" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/proxy/auto`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/proxy/auto" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/proxy/embeddings`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/proxy/embeddings" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/proxy/credentials`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/proxy/credentials" }, "docs": "Enable CORS" }, { "info": { "name": "Enable CORS (`/v1/proxy/{path+}`)", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.braintrust.dev/v1/proxy/:path+", "params": [ { "name": "path+", "value": "", "type": "path", "description": "The path to proxy" } ] }, "docs": "Enable CORS" } ] }, { "info": { "name": "Logs", "type": "folder" }, "items": [ { "info": { "name": "Insert project logs events", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/project_logs/:project_id/insert", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Insert a set of events into the project logs" }, { "info": { "name": "Fetch project logs (GET form)", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/project_logs/:project_id/fetch", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project 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 a project logs. 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 project logs (POST form)", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/project_logs/:project_id/fetch", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch the events in a project logs. 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 project logs events", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/project_logs/:project_id/feedback", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Log feedback for a set of project logs events" } ] }, { "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" } ] }, { "info": { "name": "Datasets", "type": "folder" }, "items": [ { "info": { "name": "List datasets", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/dataset", "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": "dataset_name", "value": "", "type": "query", "description": "Name of the dataset 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 datasets. The datasets are sorted by creation date, with the most recently-created datasets coming first" }, { "info": { "name": "Create dataset", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/dataset", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new dataset. If there is an existing dataset in the project with the same name as the one specified in the request, will return the existing dataset unmodified" }, { "info": { "name": "Get dataset", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a dataset object by its id" }, { "info": { "name": "Partially update dataset", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a dataset 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 dataset", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a dataset object by its id" }, { "info": { "name": "Insert dataset events", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id/insert", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Insert a set of events into the dataset" }, { "info": { "name": "Fetch dataset (GET form)", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id/fetch", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset 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 a dataset. 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 dataset (POST form)", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id/fetch", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch the events in a dataset. 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 dataset events", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id/feedback", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Log feedback for a set of dataset events" }, { "info": { "name": "Summarize dataset", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/dataset/:dataset_id/summarize", "params": [ { "name": "dataset_id", "value": "", "type": "path", "description": "Dataset id" }, { "name": "summarize_data", "value": "", "type": "query", "description": "Whether to summarize the data. If false (or omitted), only the metadata will be returned." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Summarize dataset" } ] }, { "info": { "name": "Prompts", "type": "folder" }, "items": [ { "info": { "name": "List prompts", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/prompt", "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": "prompt_name", "value": "", "type": "query", "description": "Name of the prompt 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": "slug", "value": "", "type": "query", "description": "Retrieve prompt with a specific slug" }, { "name": "version", "value": "", "type": "query", "description": "Retrieve prompt at a specific version.\n\nThe version id can either be a transaction id (e.g. '1000192656880881099') or a version identifier (e.g. '81cd05ee665fdfb3')." }, { "name": "environment", "value": "", "type": "query", "description": "Filter by environment slug. Cannot be used together with `version`.\n\nFor `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." }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all prompts. The prompts are sorted by creation date, with the most recently-created prompts coming first" }, { "info": { "name": "Create prompt", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/prompt", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new prompt. If there is an existing prompt in the project with the same slug as the one specified in the request, will return the existing prompt unmodified" }, { "info": { "name": "Create or replace prompt", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/prompt", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace prompt. If there is an existing prompt in the project with the same slug as the one specified in the request, will replace the existing prompt with the provided fields" }, { "info": { "name": "Get prompt", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/prompt/:prompt_id", "params": [ { "name": "prompt_id", "value": "", "type": "path", "description": "Prompt id" }, { "name": "version", "value": "", "type": "query", "description": "Retrieve prompt at a specific version.\n\nThe version id can either be a transaction id (e.g. '1000192656880881099') or a version identifier (e.g. '81cd05ee665fdfb3')." }, { "name": "environment", "value": "", "type": "query", "description": "Filter by environment slug. Cannot be used together with `version`.\n\nFor `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." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a prompt object by its id" }, { "info": { "name": "Partially update prompt", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/prompt/:prompt_id", "params": [ { "name": "prompt_id", "value": "", "type": "path", "description": "Prompt id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a prompt 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 prompt", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/prompt/:prompt_id", "params": [ { "name": "prompt_id", "value": "", "type": "path", "description": "Prompt id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a prompt object by its id" } ] }, { "info": { "name": "Roles", "type": "folder" }, "items": [ { "info": { "name": "List roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/role", "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": "role_name", "value": "", "type": "query", "description": "Name of the role to search for" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all roles. The roles are sorted by creation date, with the most recently-created roles coming first" }, { "info": { "name": "Create role", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/role", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new role. If there is an existing role with the same name as the one specified in the request, will return the existing role unmodified" }, { "info": { "name": "Create or replace role", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/role", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace role. If there is an existing role with the same name as the one specified in the request, will replace the existing role with the provided fields" }, { "info": { "name": "Get role", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/role/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "Role id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a role object by its id" }, { "info": { "name": "Partially update role", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/role/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "Role id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a role 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 role", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/role/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path", "description": "Role id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a role object by its id" } ] }, { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "List groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/group", "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": "group_name", "value": "", "type": "query", "description": "Name of the group to search for" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all groups. The groups are sorted by creation date, with the most recently-created groups coming first" }, { "info": { "name": "Create group", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/group", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new group. If there is an existing group with the same name as the one specified in the request, will return the existing group unmodified" }, { "info": { "name": "Create or replace group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/group", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace group. If there is an existing group with the same name as the one specified in the request, will replace the existing group with the provided fields" }, { "info": { "name": "Get group", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/group/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "Group id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a group object by its id" }, { "info": { "name": "Partially update group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/group/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "Group id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a group 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 group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/group/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "Group id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a group object by its id" } ] }, { "info": { "name": "Acls", "type": "folder" }, "items": [ { "info": { "name": "List acls", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/acl", "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": "object_type", "value": "", "type": "query", "description": "The object type that the ACL applies to" }, { "name": "object_id", "value": "", "type": "query", "description": "The id of the object the ACL applies to" }, { "name": "user_id", "value": "", "type": "query", "description": "Id of the user the ACL applies to. Exactly one of `user_id` and `group_id` will be provided" }, { "name": "group_id", "value": "", "type": "query", "description": "Id of the group the ACL applies to. Exactly one of `user_id` and `group_id` will be provided" }, { "name": "permission", "value": "", "type": "query", "description": "Each permission permits a certain type of operation on an object in the system\n\nPermissions can be assigned to to objects on an individual basis, or grouped into roles" }, { "name": "restrict_object_type", "value": "", "type": "query", "description": "The object type that the ACL applies to" }, { "name": "role_id", "value": "", "type": "query", "description": "Id of the role the ACL grants. Exactly one of `permission` and `role_id` will be provided" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all acls. The acls are sorted by creation date, with the most recently-created acls coming first" }, { "info": { "name": "Create acl", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/acl", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new acl. If there is an existing acl with the same contents as the one specified in the request, will return the existing acl unmodified" }, { "info": { "name": "Delete single acl", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/acl", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a single acl" }, { "info": { "name": "Get acl", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/acl/:acl_id", "params": [ { "name": "acl_id", "value": "", "type": "path", "description": "Acl id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get an acl object by its id" }, { "info": { "name": "Delete acl", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/acl/:acl_id", "params": [ { "name": "acl_id", "value": "", "type": "path", "description": "Acl id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an acl object by its id" }, { "info": { "name": "Batch update acls", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/acl/batch_update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Batch update acls. This operation is idempotent, so adding acls which already exist will have no effect, and removing acls which do not exist will have no effect." }, { "info": { "name": "List org acls", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/acl/list_org", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Limit the number of objects to return" }, { "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": "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": "object_type", "value": "", "type": "query", "description": "The object type that the ACL applies to" }, { "name": "object_id", "value": "", "type": "query", "description": "The id of the object the ACL applies to" }, { "name": "user_id", "value": "", "type": "query", "description": "Id of the user the ACL applies to. Exactly one of `user_id` and `group_id` will be provided" }, { "name": "group_id", "value": "", "type": "query", "description": "Id of the group the ACL applies to. Exactly one of `user_id` and `group_id` will be provided" }, { "name": "permission", "value": "", "type": "query", "description": "Each permission permits a certain type of operation on an object in the system\n\nPermissions can be assigned to to objects on an individual basis, or grouped into roles" }, { "name": "restrict_object_type", "value": "", "type": "query", "description": "The object type that the ACL applies to" }, { "name": "role_id", "value": "", "type": "query", "description": "Id of the role the ACL grants. Exactly one of `permission` and `role_id` will be provided" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all acls in the org. This query requires the caller to have `read_acls` permission at the organization level" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "List users", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/user", "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": "given_name", "value": "", "type": "query", "description": "Given name of the user to search for. You may pass the param multiple times to filter for more than one given name" }, { "name": "family_name", "value": "", "type": "query", "description": "Family name of the user to search for. You may pass the param multiple times to filter for more than one family name" }, { "name": "email", "value": "", "type": "query", "description": "Email of the user to search for. You may pass the param multiple times to filter for more than one email" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all users. The users are sorted by creation date, with the most recently-created users coming first" }, { "info": { "name": "Get user", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/user/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "User id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a user object by its id" } ] }, { "info": { "name": "ProjectAutomations", "type": "folder" }, "items": [ { "info": { "name": "List project_automations", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/project_automation", "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": "project_automation_name", "value": "", "type": "query", "description": "Name of the project_automation to search for" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all project_automations. The project_automations are sorted by creation date, with the most recently-created project_automations coming first" }, { "info": { "name": "Create project_automation", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/project_automation", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new project_automation. If there is an existing project_automation with the same name as the one specified in the request, will return the existing project_automation unmodified" }, { "info": { "name": "Create or replace project_automation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/project_automation", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace project_automation. If there is an existing project_automation with the same name as the one specified in the request, will replace the existing project_automation with the provided fields" }, { "info": { "name": "Get project_automation", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/project_automation/:project_automation_id", "params": [ { "name": "project_automation_id", "value": "", "type": "path", "description": "ProjectAutomation id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a project_automation object by its id" }, { "info": { "name": "Partially update project_automation", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/project_automation/:project_automation_id", "params": [ { "name": "project_automation_id", "value": "", "type": "path", "description": "ProjectAutomation id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a project_automation 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 project_automation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/project_automation/:project_automation_id", "params": [ { "name": "project_automation_id", "value": "", "type": "path", "description": "ProjectAutomation id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a project_automation object by its id" } ] }, { "info": { "name": "ProjectScores", "type": "folder" }, "items": [ { "info": { "name": "List project_scores", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/project_score", "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": "project_score_name", "value": "", "type": "query", "description": "Name of the project_score 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" }, { "name": "score_type", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all project_scores. The project_scores are sorted by creation date, with the most recently-created project_scores coming first" }, { "info": { "name": "Create project_score", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/project_score", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new project_score. If there is an existing project_score in the project with the same name as the one specified in the request, will return the existing project_score unmodified" }, { "info": { "name": "Create or replace project_score", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/project_score", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace project_score. If there is an existing project_score in the project with the same name as the one specified in the request, will replace the existing project_score with the provided fields" }, { "info": { "name": "Get project_score", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/project_score/:project_score_id", "params": [ { "name": "project_score_id", "value": "", "type": "path", "description": "ProjectScore id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a project_score object by its id" }, { "info": { "name": "Partially update project_score", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/project_score/:project_score_id", "params": [ { "name": "project_score_id", "value": "", "type": "path", "description": "ProjectScore id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a project_score 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 project_score", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/project_score/:project_score_id", "params": [ { "name": "project_score_id", "value": "", "type": "path", "description": "ProjectScore id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a project_score object by its id" } ] }, { "info": { "name": "ProjectTags", "type": "folder" }, "items": [ { "info": { "name": "List project_tags", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/project_tag", "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": "project_tag_name", "value": "", "type": "query", "description": "Name of the project_tag 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 project_tags. The project_tags are sorted by creation date, with the most recently-created project_tags coming first" }, { "info": { "name": "Create project_tag", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/project_tag", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new project_tag. If there is an existing project_tag in the project with the same name as the one specified in the request, will return the existing project_tag unmodified" }, { "info": { "name": "Create or replace project_tag", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/project_tag", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace project_tag. If there is an existing project_tag in the project with the same name as the one specified in the request, will replace the existing project_tag with the provided fields" }, { "info": { "name": "Get project_tag", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/project_tag/:project_tag_id", "params": [ { "name": "project_tag_id", "value": "", "type": "path", "description": "ProjectTag id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a project_tag object by its id" }, { "info": { "name": "Partially update project_tag", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/project_tag/:project_tag_id", "params": [ { "name": "project_tag_id", "value": "", "type": "path", "description": "ProjectTag id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a project_tag 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 project_tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/project_tag/:project_tag_id", "params": [ { "name": "project_tag_id", "value": "", "type": "path", "description": "ProjectTag id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a project_tag object by its id" } ] }, { "info": { "name": "SpanIframes", "type": "folder" }, "items": [ { "info": { "name": "List span_iframes", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/span_iframe", "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": "span_iframe_name", "value": "", "type": "query", "description": "Name of the span_iframe to search for" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all span_iframes. The span_iframes are sorted by creation date, with the most recently-created span_iframes coming first" }, { "info": { "name": "Create span_iframe", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/span_iframe", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new span_iframe. If there is an existing span_iframe with the same name as the one specified in the request, will return the existing span_iframe unmodified" }, { "info": { "name": "Create or replace span_iframe", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/span_iframe", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace span_iframe. If there is an existing span_iframe with the same name as the one specified in the request, will replace the existing span_iframe with the provided fields" }, { "info": { "name": "Get span_iframe", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/span_iframe/:span_iframe_id", "params": [ { "name": "span_iframe_id", "value": "", "type": "path", "description": "SpanIframe id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a span_iframe object by its id" }, { "info": { "name": "Partially update span_iframe", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/span_iframe/:span_iframe_id", "params": [ { "name": "span_iframe_id", "value": "", "type": "path", "description": "SpanIframe id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a span_iframe 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 span_iframe", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/span_iframe/:span_iframe_id", "params": [ { "name": "span_iframe_id", "value": "", "type": "path", "description": "SpanIframe id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a span_iframe object by its id" } ] }, { "info": { "name": "Functions", "type": "folder" }, "items": [ { "info": { "name": "List functions", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/function", "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": "function_name", "value": "", "type": "query", "description": "Name of the function 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": "slug", "value": "", "type": "query", "description": "Retrieve prompt with a specific slug" }, { "name": "version", "value": "", "type": "query", "description": "Retrieve prompt at a specific version.\n\nThe version id can either be a transaction id (e.g. '1000192656880881099') or a version identifier (e.g. '81cd05ee665fdfb3')." }, { "name": "environment", "value": "", "type": "query", "description": "Filter by environment slug. Cannot be used together with `version`.\n\nFor `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." }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all functions. The functions are sorted by creation date, with the most recently-created functions coming first" }, { "info": { "name": "Create function", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/function", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new function. If there is an existing function in the project with the same slug as the one specified in the request, will return the existing function unmodified" }, { "info": { "name": "Create or replace function", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/function", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace function. If there is an existing function in the project with the same slug as the one specified in the request, will replace the existing function with the provided fields" }, { "info": { "name": "Get function", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/function/:function_id", "params": [ { "name": "function_id", "value": "", "type": "path", "description": "Function id" }, { "name": "version", "value": "", "type": "query", "description": "Retrieve prompt at a specific version.\n\nThe version id can either be a transaction id (e.g. '1000192656880881099') or a version identifier (e.g. '81cd05ee665fdfb3')." }, { "name": "environment", "value": "", "type": "query", "description": "Filter by environment slug. Cannot be used together with `version`.\n\nFor `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." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a function object by its id" }, { "info": { "name": "Partially update function", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/function/:function_id", "params": [ { "name": "function_id", "value": "", "type": "path", "description": "Function id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a function 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 function", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/function/:function_id", "params": [ { "name": "function_id", "value": "", "type": "path", "description": "Function id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a function object by its id" }, { "info": { "name": "Invoke function", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/function/:function_id/invoke", "params": [ { "name": "function_id", "value": "", "type": "path", "description": "Function id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Invoke a function." } ] }, { "info": { "name": "Views", "type": "folder" }, "items": [ { "info": { "name": "List views", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/view", "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": "view_name", "value": "", "type": "query", "description": "Name of the view to search for" }, { "name": "view_type", "value": "", "type": "query", "description": "Type of object that the view corresponds to." }, { "name": "object_type", "value": "", "type": "query", "description": "The object type that the ACL applies to" }, { "name": "object_id", "value": "", "type": "query", "description": "The id of the object the ACL applies to" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all views. The views are sorted by creation date, with the most recently-created views coming first" }, { "info": { "name": "Create view", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/view", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new view. If there is an existing view with the same name as the one specified in the request, will return the existing view unmodified" }, { "info": { "name": "Create or replace view", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/view", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace view. If there is an existing view with the same name as the one specified in the request, will replace the existing view with the provided fields" }, { "info": { "name": "Get view", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/view/:view_id", "params": [ { "name": "view_id", "value": "", "type": "path", "description": "View id" }, { "name": "object_type", "value": "", "type": "query", "description": "The object type that the ACL applies to" }, { "name": "object_id", "value": "", "type": "query", "description": "The id of the object the ACL applies to" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a view object by its id" }, { "info": { "name": "Partially update view", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/view/:view_id", "params": [ { "name": "view_id", "value": "", "type": "path", "description": "View id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a view 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 view", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/view/:view_id", "params": [ { "name": "view_id", "value": "", "type": "path", "description": "View id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a view object by its id" } ] }, { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "List organizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/organization", "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": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all organizations. The organizations are sorted by creation date, with the most recently-created organizations coming first" }, { "info": { "name": "Get organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/organization/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Organization id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get an organization object by its id" }, { "info": { "name": "Partially update organization", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/organization/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Organization id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update an organization 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": "Modify organization membership", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/organization/members", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Modify organization membership.\n\nOrganization owners can use this endpoint to create service accounts, but service tokens for those accounts must be created in the Braintrust UI, at [**Settings > Service tokens**](https://www.braintrust.dev/app/~/configuration/org/service-tokens)." } ] }, { "info": { "name": "ApiKeys", "type": "folder" }, "items": [ { "info": { "name": "List api_keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/api_key", "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": "api_key_name", "value": "", "type": "query", "description": "Name of the api_key to search for" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all API keys. They are sorted by creation date, with the most recently-created keys coming first.\n\nTo create new API keys, go to [**Settings > API keys**](https://www.braintrust.dev/app/~/configuration/org/api-keys) in the Braintrust UI." }, { "info": { "name": "Get api_key", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/api_key/:api_key_id", "params": [ { "name": "api_key_id", "value": "", "type": "path", "description": "ApiKey id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get an api_key object by its id" }, { "info": { "name": "Delete api_key", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/api_key/:api_key_id", "params": [ { "name": "api_key_id", "value": "", "type": "path", "description": "ApiKey id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an api_key object by its id" } ] }, { "info": { "name": "ServiceTokens", "type": "folder" }, "items": [ { "info": { "name": "List service_tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/service_token", "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": "service_token_name", "value": "", "type": "query", "description": "Name of the service_token to search for" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all service tokens. They are sorted by creation date, with the most recently-created tokens coming first.\n\nTo create service tokens, organization owners can go to [**Settings > Service tokens**](https://www.braintrust.dev/app/~/configuration/org/service-tokens) in the Braintrust UI." }, { "info": { "name": "Delete single service_token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/service_token", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a single service_token" }, { "info": { "name": "Get service_token", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/service_token/:service_token_id", "params": [ { "name": "service_token_id", "value": "", "type": "path", "description": "ServiceToken id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a service_token object by its id" }, { "info": { "name": "Delete service_token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/service_token/:service_token_id", "params": [ { "name": "service_token_id", "value": "", "type": "path", "description": "ServiceToken id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a service_token object by its id" } ] }, { "info": { "name": "AiSecrets", "type": "folder" }, "items": [ { "info": { "name": "List ai_secrets", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/ai_secret", "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": "ai_secret_name", "value": "", "type": "query", "description": "Name of the ai_secret to search for" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" }, { "name": "ai_secret_type", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all ai_secrets. The ai_secrets are sorted by creation date, with the most recently-created ai_secrets coming first" }, { "info": { "name": "Create ai_secret", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/ai_secret", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new ai_secret. If there is an existing ai_secret with the same name as the one specified in the request, will return the existing ai_secret unmodified" }, { "info": { "name": "Create or replace ai_secret", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/ai_secret", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace ai_secret. If there is an existing ai_secret with the same name as the one specified in the request, will replace the existing ai_secret with the provided fields" }, { "info": { "name": "Delete single ai_secret", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/ai_secret", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a single ai_secret" }, { "info": { "name": "Get ai_secret", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/ai_secret/:ai_secret_id", "params": [ { "name": "ai_secret_id", "value": "", "type": "path", "description": "AiSecret id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get an ai_secret object by its id" }, { "info": { "name": "Partially update ai_secret", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/ai_secret/:ai_secret_id", "params": [ { "name": "ai_secret_id", "value": "", "type": "path", "description": "AiSecret id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update an ai_secret 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 ai_secret", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/ai_secret/:ai_secret_id", "params": [ { "name": "ai_secret_id", "value": "", "type": "path", "description": "AiSecret id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an ai_secret object by its id" } ] }, { "info": { "name": "EnvVars", "type": "folder" }, "items": [ { "info": { "name": "List env_vars", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/env_var", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Limit the number of objects to return" }, { "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": "env_var_name", "value": "", "type": "query", "description": "Name of the env_var to search for" }, { "name": "object_type", "value": "", "type": "query", "description": "The type of the object the environment variable is scoped for" }, { "name": "object_id", "value": "", "type": "query", "description": "The id of the object the environment variable is scoped for" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all env_vars. The env_vars are sorted by creation date, with the most recently-created env_vars coming first" }, { "info": { "name": "Create env_var", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/env_var", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new env_var. If there is an existing env_var with the same name as the one specified in the request, will return the existing env_var unmodified" }, { "info": { "name": "Create or replace env_var", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/env_var", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace env_var. If there is an existing env_var with the same name as the one specified in the request, will replace the existing env_var with the provided fields" }, { "info": { "name": "Get env_var", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/env_var/:env_var_id", "params": [ { "name": "env_var_id", "value": "", "type": "path", "description": "EnvVar id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get an env_var object by its id" }, { "info": { "name": "Partially update env_var", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/env_var/:env_var_id", "params": [ { "name": "env_var_id", "value": "", "type": "path", "description": "EnvVar id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update an env_var 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 env_var", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/env_var/:env_var_id", "params": [ { "name": "env_var_id", "value": "", "type": "path", "description": "EnvVar id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an env_var object by its id" } ] }, { "info": { "name": "McpServers", "type": "folder" }, "items": [ { "info": { "name": "List mcp_servers", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/mcp_server", "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": "mcp_server_name", "value": "", "type": "query", "description": "Name of the mcp_server to search for" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all mcp_servers. The mcp_servers are sorted by creation date, with the most recently-created mcp_servers coming first" }, { "info": { "name": "Create mcp_server", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/mcp_server", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new mcp_server. If there is an existing mcp_server with the same name as the one specified in the request, will return the existing mcp_server unmodified" }, { "info": { "name": "Create or replace mcp_server", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/mcp_server", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace mcp_server. If there is an existing mcp_server with the same name as the one specified in the request, will replace the existing mcp_server with the provided fields" }, { "info": { "name": "Get mcp_server", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/mcp_server/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "McpServer id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a mcp_server object by its id" }, { "info": { "name": "Partially update mcp_server", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/mcp_server/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "McpServer id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a mcp_server 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 mcp_server", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/mcp_server/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path", "description": "McpServer id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a mcp_server object by its id" } ] }, { "info": { "name": "DatasetSnapshots", "type": "folder" }, "items": [ { "info": { "name": "List dataset_snapshots", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/dataset_snapshot", "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": "dataset_snapshot_name", "value": "", "type": "query", "description": "Name of the dataset_snapshot to search for" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all dataset_snapshots. The dataset_snapshots are sorted by creation date, with the most recently-created dataset_snapshots coming first" }, { "info": { "name": "Create dataset_snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/dataset_snapshot", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new dataset_snapshot. If there is an existing dataset_snapshot with the same name as the one specified in the request, will return the existing dataset_snapshot unmodified" }, { "info": { "name": "Create or replace dataset_snapshot", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/dataset_snapshot", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace dataset_snapshot. If there is an existing dataset_snapshot with the same name as the one specified in the request, will replace the existing dataset_snapshot with the provided fields" }, { "info": { "name": "Get dataset_snapshot", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/dataset_snapshot/:dataset_snapshot_id", "params": [ { "name": "dataset_snapshot_id", "value": "", "type": "path", "description": "DatasetSnapshot id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a dataset_snapshot object by its id" }, { "info": { "name": "Partially update dataset_snapshot", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/dataset_snapshot/:dataset_snapshot_id", "params": [ { "name": "dataset_snapshot_id", "value": "", "type": "path", "description": "DatasetSnapshot id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a dataset_snapshot 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 dataset_snapshot", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/dataset_snapshot/:dataset_snapshot_id", "params": [ { "name": "dataset_snapshot_id", "value": "", "type": "path", "description": "DatasetSnapshot id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a dataset_snapshot object by its id" } ] }, { "info": { "name": "Environments", "type": "folder" }, "items": [ { "info": { "name": "List environments", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/environment", "params": [ { "name": "ids", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all environments. The environments are sorted by creation date, with the most recently-created environments first." }, { "info": { "name": "Create environment", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/environment", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new environment" }, { "info": { "name": "Get environment", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/environment/:environment_id", "params": [ { "name": "environment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get environment" }, { "info": { "name": "Partially update environment", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/environment/:environment_id", "params": [ { "name": "environment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update environment" }, { "info": { "name": "Delete environment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/environment/:environment_id", "params": [ { "name": "environment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete environment" } ] }, { "info": { "name": "Other", "type": "folder" }, "items": [ { "info": { "name": "Hello world endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1" }, "docs": "Default endpoint. Simply replies with 'Hello, World!'. Authorization is not required" } ] }, { "info": { "name": "CrossObject", "type": "folder" }, "items": [ { "info": { "name": "Cross-object insert", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/insert", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Insert events and feedback across object types" } ] }, { "info": { "name": "Proxy", "type": "folder" }, "items": [ { "info": { "name": "Proxy chat/completions", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/proxy/chat/completions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Proxy a chat/completions request to the specified model, converting its format as needed. Will cache if temperature=0 or seed is set." }, { "info": { "name": "Proxy completions", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/proxy/completions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Proxy a completions request to the specified model, converting its format as needed. Will cache if temperature=0 or seed is set." }, { "info": { "name": "Proxy a model to chat/completions or completions automatically", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/proxy/auto", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Proxy a request to either chat/completions or completions automatically based on the model. Will cache if temperature=0 or seed is set." }, { "info": { "name": "Proxy embeddings", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/proxy/embeddings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Proxy an embeddings request to the specified model, converting its format as needed. Will cache automatically." }, { "info": { "name": "Create temporary credential", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/proxy/credentials", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a temporary credential which can access the proxy for a limited time. The temporary credential will be allowed to make requests on behalf of the Braintrust API key (or model provider API key) provided in the `Authorization` header. See [docs](/docs/deploy/ai-proxy#create-temporary-credentials) for code examples." }, { "info": { "name": "Proxy any OpenAI request (fallback)", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/proxy/:path+", "params": [ { "name": "path+", "value": "", "type": "path", "description": "The path to proxy" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Any requests which do not match the above paths will be proxied directly to the OpenAI API." } ] }, { "info": { "name": "Evals", "type": "folder" }, "items": [ { "info": { "name": "Launch an eval", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/eval", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Launch an evaluation. This is the API-equivalent of the `Eval` function that is built into the Braintrust SDK. In the Eval API, you provide pointers to a dataset, task function, and scoring functions. The API will then run the evaluation, create an experiment, and return the results along with a link to the experiment. To learn more about evals, see the [Evals guide](https://www.braintrust.dev/docs/evaluate)." } ] } ], "bundled": true }