|
1 | 1 | # Braintrust URL Formats |
2 | 2 |
|
3 | | -## App Links (Current Format) |
| 3 | +Use `BRAINTRUST_APP_URL` as the source of truth for app links. It already includes the scheme |
| 4 | +and any required base path. On hosted Braintrust, the default is |
| 5 | +`https://www.braintrust.dev/app`. |
| 6 | + |
| 7 | +## App Links |
4 | 8 |
|
5 | 9 | ### Experiments |
6 | 10 |
|
7 | | -`https://BRAINTRUST_APP_URL/{org}/p/{project}/experiments/{experiment_name}?r={root_span_id}&s={span_id}` |
| 11 | +`{BRAINTRUST_APP_URL}/{org}/p/{project}/experiments/{experiment_name}?r={root_span_id}&s={span_id}` |
8 | 12 |
|
9 | 13 | ### Datasets |
10 | 14 |
|
11 | | -`https://BRAINTRUST_APP_URL/{org}/p/{project}/datasets/{dataset_name}?r={root_span_id}` |
| 15 | +`{BRAINTRUST_APP_URL}/{org}/p/{project}/datasets/{dataset_name}?r={root_span_id}` |
12 | 16 |
|
13 | 17 | ### Project Logs |
14 | 18 |
|
15 | | -`https://BRAINTRUST_APP_URL/{org}/p/{project}/logs?r={root_span_id}&s={span_id}` |
| 19 | +`{BRAINTRUST_APP_URL}/{org}/p/{project}/logs?r={root_span_id}&s={span_id}` |
16 | 20 |
|
17 | 21 | ## Legacy Object URLs |
18 | 22 |
|
19 | | -`https://BRAINTRUST_APP_URL/object?object_type=...&object_id=...&id=...` |
| 23 | +`{BRAINTRUST_APP_URL}/object?object_type=...&object_id=...&id=...` |
20 | 24 |
|
21 | 25 | ## URL Parameters |
22 | 26 |
|
23 | | -| Parameter | Description | |
24 | | -| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
25 | | -| r | The root_span_id - identifies a trace | |
26 | | -| s | The span_id - identifies a specific span within the trace | |
27 | | -| id | Legacy parameter for root_span_id in object URLs | |
28 | | -| BRAINTRUST_APP_URL | url where the app is accessible, www.braintrust.dev/app for non self-hosted instances. See the env variable BRAINTRUST_APP_URL (and use www.braintrust.dev/app if it is not set) | |
| 27 | +| Parameter | Description | |
| 28 | +| --------- | ----------- | |
| 29 | +| `r` | Root span ID. Identifies a trace. | |
| 30 | +| `s` | Span ID. Identifies a specific span within a trace. | |
| 31 | +| `id` | Legacy root span ID parameter in object URLs. | |
29 | 32 |
|
30 | 33 | ## Notes |
31 | 34 |
|
32 | | -- The `r=` parameter is always the root_span_id |
33 | | -- For logs and experiments, use `s=` to reference a specific span within a trace |
| 35 | +- The `r=` parameter is always the `root_span_id`. |
| 36 | +- For logs and experiments, use `s=` to reference a specific span within a trace. |
0 commit comments