{ "info": { "_postman_id": "b1a1c0de-bd47-4d10-9f00-braintrustdata1", "name": "Braintrust REST API", "description": "Postman collection for the Braintrust REST API (https://api.braintrust.dev/v1). Covers projects, experiments, datasets, logs/spans, prompts, functions, evals, organization/ACL, credentials, and the OpenAI-compatible AI proxy. Authenticate with a Bearer API key.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{BRAINTRUST_API_KEY}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.braintrust.dev", "type": "string" }, { "key": "BRAINTRUST_API_KEY", "value": "", "type": "string" }, { "key": "project_id", "value": "", "type": "string" }, { "key": "experiment_id", "value": "", "type": "string" }, { "key": "dataset_id", "value": "", "type": "string" }, { "key": "function_id", "value": "", "type": "string" } ], "item": [ { "name": "Projects", "item": [ { "name": "List projects", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/project?limit=100", "host": ["{{baseUrl}}"], "path": ["v1", "project"], "query": [{ "key": "limit", "value": "100" }] } } }, { "name": "Create project", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"name\": \"my-project\"\n}" }, "url": { "raw": "{{baseUrl}}/v1/project", "host": ["{{baseUrl}}"], "path": ["v1", "project"] } } }, { "name": "Get project", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/project/{{project_id}}", "host": ["{{baseUrl}}"], "path": ["v1", "project", "{{project_id}}"] } } }, { "name": "Delete project", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/project/{{project_id}}", "host": ["{{baseUrl}}"], "path": ["v1", "project", "{{project_id}}"] } } } ] }, { "name": "Experiments", "item": [ { "name": "Create experiment", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"project_id\": \"{{project_id}}\",\n \"name\": \"my-experiment\"\n}" }, "url": { "raw": "{{baseUrl}}/v1/experiment", "host": ["{{baseUrl}}"], "path": ["v1", "experiment"] } } }, { "name": "Insert experiment events", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"events\": [\n {\n \"input\": {\"question\": \"What is 2+2?\"},\n \"output\": \"4\",\n \"expected\": \"4\",\n \"scores\": {\"accuracy\": 1}\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/v1/experiment/{{experiment_id}}/insert", "host": ["{{baseUrl}}"], "path": ["v1", "experiment", "{{experiment_id}}", "insert"] } } }, { "name": "Fetch experiment events", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"limit\": 100\n}" }, "url": { "raw": "{{baseUrl}}/v1/experiment/{{experiment_id}}/fetch", "host": ["{{baseUrl}}"], "path": ["v1", "experiment", "{{experiment_id}}", "fetch"] } } }, { "name": "Summarize experiment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/experiment/{{experiment_id}}/summarize?summarize_scores=true", "host": ["{{baseUrl}}"], "path": ["v1", "experiment", "{{experiment_id}}", "summarize"], "query": [{ "key": "summarize_scores", "value": "true" }] } } } ] }, { "name": "Datasets", "item": [ { "name": "Create dataset", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"project_id\": \"{{project_id}}\",\n \"name\": \"my-dataset\"\n}" }, "url": { "raw": "{{baseUrl}}/v1/dataset", "host": ["{{baseUrl}}"], "path": ["v1", "dataset"] } } }, { "name": "Insert dataset events", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"events\": [\n {\n \"input\": {\"question\": \"What is the capital of France?\"},\n \"expected\": \"Paris\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/v1/dataset/{{dataset_id}}/insert", "host": ["{{baseUrl}}"], "path": ["v1", "dataset", "{{dataset_id}}", "insert"] } } }, { "name": "Fetch dataset events", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"limit\": 100\n}" }, "url": { "raw": "{{baseUrl}}/v1/dataset/{{dataset_id}}/fetch", "host": ["{{baseUrl}}"], "path": ["v1", "dataset", "{{dataset_id}}", "fetch"] } } } ] }, { "name": "Logs", "item": [ { "name": "Insert project logs", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"events\": [\n {\n \"input\": {\"prompt\": \"Hello\"},\n \"output\": \"Hi there!\",\n \"metadata\": {\"model\": \"gpt-4o\"}\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/v1/project_logs/{{project_id}}/insert", "host": ["{{baseUrl}}"], "path": ["v1", "project_logs", "{{project_id}}", "insert"] } } }, { "name": "Fetch project logs", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"limit\": 100\n}" }, "url": { "raw": "{{baseUrl}}/v1/project_logs/{{project_id}}/fetch", "host": ["{{baseUrl}}"], "path": ["v1", "project_logs", "{{project_id}}", "fetch"] } } } ] }, { "name": "Prompts", "item": [ { "name": "List prompts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/prompt?project_id={{project_id}}", "host": ["{{baseUrl}}"], "path": ["v1", "prompt"], "query": [{ "key": "project_id", "value": "{{project_id}}" }] } } }, { "name": "Create prompt", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"project_id\": \"{{project_id}}\",\n \"name\": \"Greeting\",\n \"slug\": \"greeting\",\n \"prompt_data\": {\n \"prompt\": {\"type\": \"chat\", \"messages\": [{\"role\": \"user\", \"content\": \"Say hello to {{name}}\"}]},\n \"options\": {\"model\": \"gpt-4o\"}\n }\n}" }, "url": { "raw": "{{baseUrl}}/v1/prompt", "host": ["{{baseUrl}}"], "path": ["v1", "prompt"] } } } ] }, { "name": "Functions", "item": [ { "name": "List functions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/function?project_id={{project_id}}", "host": ["{{baseUrl}}"], "path": ["v1", "function"], "query": [{ "key": "project_id", "value": "{{project_id}}" }] } } }, { "name": "Invoke function", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"input\": {\"text\": \"Some text to score\"},\n \"stream\": false\n}" }, "url": { "raw": "{{baseUrl}}/v1/function/{{function_id}}/invoke", "host": ["{{baseUrl}}"], "path": ["v1", "function", "{{function_id}}", "invoke"] } } } ] }, { "name": "Evals", "item": [ { "name": "Launch eval", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"project_id\": \"{{project_id}}\",\n \"data\": {\"dataset_id\": \"{{dataset_id}}\"},\n \"task\": \"my-task-function\",\n \"scores\": [\"Factuality\"]\n}" }, "url": { "raw": "{{baseUrl}}/v1/eval", "host": ["{{baseUrl}}"], "path": ["v1", "eval"] } } } ] }, { "name": "Organization & ACL", "item": [ { "name": "List organizations", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/organization", "host": ["{{baseUrl}}"], "path": ["v1", "organization"] } } }, { "name": "List ACLs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/acl?object_type=project&object_id={{project_id}}", "host": ["{{baseUrl}}"], "path": ["v1", "acl"], "query": [ { "key": "object_type", "value": "project" }, { "key": "object_id", "value": "{{project_id}}" } ] } } } ] }, { "name": "Credentials", "item": [ { "name": "List API keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/api_key", "host": ["{{baseUrl}}"], "path": ["v1", "api_key"] } } } ] }, { "name": "AI Proxy", "item": [ { "name": "Proxy chat/completions", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"model\": \"gpt-4o\",\n \"messages\": [{\"role\": \"user\", \"content\": \"Hello!\"}],\n \"stream\": false\n}" }, "url": { "raw": "{{baseUrl}}/v1/proxy/chat/completions", "host": ["{{baseUrl}}"], "path": ["v1", "proxy", "chat", "completions"] } } }, { "name": "Proxy embeddings", "request": { "method": "POST", "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { "mode": "raw", "raw": "{\n \"model\": \"text-embedding-3-small\",\n \"input\": \"The quick brown fox\"\n}" }, "url": { "raw": "{{baseUrl}}/v1/proxy/embeddings", "host": ["{{baseUrl}}"], "path": ["v1", "proxy", "embeddings"] } } } ] } ] }