Add project_id support and Prompt#version accessor#131
Merged
David Elner (delner) merged 2 commits intobraintrustdata:mainfrom Apr 1, 2026
Merged
Conversation
…version accessor The Braintrust API supports filtering functions by project_id (UUID), but the SDK only exposed project_name. This adds project_id as an optional parameter to Functions#list and Prompt.load, allowing callers who have a project UUID to load prompts without needing to resolve the project name first. Also adds a Prompt#version reader that exposes the _xact_id from the API response, which is useful for pinning prompts to specific versions and for observability metadata. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
David Elner (delner)
force-pushed
the
add-project-id-and-version-support
branch
from
5b591e4 to
1f08c0d
Compare
David Elner (delner)
approved these changes
Mar 31, 2026
Collaborator
David Elner (delner)
left a comment
David Elner (delner)
left a comment
There was a problem hiding this comment.
Tweaked some tests to shore up coverage but otherwise looks good!
Contributor
Author
|
Awesome, thanks David Elner (@delner) ! Can we get this merged + released? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
project_id:parameter toFunctions#listandPrompt.load, and exposesPrompt#version(backed by_xact_idfrom the API response).Motivation
When integrating Braintrust prompts into applications, it's common to reference projects by UUID rather than name (e.g., from configuration or environment variables). The API already supports
project_idas a query parameter onGET /v1/function, but the SDK only exposedproject_name.Similarly,
_xact_idis returned by the API and represents the prompt version, but wasn't accessible on thePromptobject. This is useful for observability (e.g., attaching prompt version to OpenTelemetry spans).Changes
Functions#list: Added optionalproject_id:keyword argument, passed as query param when presentPrompt.load: Added optionalproject_id:keyword argument as alternative toproject:. RaisesArgumentErrorif neither is provided.project:is no longer required (but one of the two must be given).Prompt#version: New reader that returns@data["_xact_id"]Tests
Prompt#version(present and nil cases)Prompt.loadargument validation (requires project or project_id)Prompt.load(project_id:)Functions#list(project_id:)load_with_versionintegration testBackward Compatibility
Fully backward compatible.
Prompt.load(project: "name", slug: "slug")continues to work. The only signature change is thatproject:is now optional (but anArgumentErroris raised if neitherproject:norproject_id:is provided).