BRbraintrustdata
Views

Get view

Changed on

Get a view object by its id

get/v1/view/{view_id}

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Path parameters

view_idstring uuid required

View id

Query parameters

object_type'organization' | 'project' | 'experiment' | 'dataset' | 'prompt' | 'prompt_session' | 'group' | 'role' | 'org_member' | 'project_log' | 'org_project' | 'org_audit_logs' | 'project_group' | 'project_group_projects' | 'ai_secret' | 'org_ai_secret' | 'org_account' required

The object type that the ACL applies to

object_idstring uuid required

The id of the object the ACL applies to

Response

Returns the view object

idstring uuid required

Unique identifier for the view

object_type'organization' | 'project' | 'experiment' | 'dataset' | 'prompt' | 'prompt_session' | 'group' | 'role' | 'org_member' | 'project_log' | 'org_project' | 'org_audit_logs' | 'project_group' | 'project_group_projects' | 'ai_secret' | 'org_ai_secret' | 'org_account' required

The object type that the ACL applies to

object_idstring uuid required

The id of the object the view applies to

view_type'projects' | 'experiments' | 'experiment' | 'playgrounds' | 'playground' | 'datasets' | 'dataset' | 'prompts' | 'parameters' | 'tools' | 'scorers' | 'classifiers' | 'logs' | 'patterns' | 'monitor' | 'for_review_project_log' | 'for_review_experiments' | 'for_review_datasets' required

Type of object that the view corresponds to.

namestring required

Name of the view

descriptionstring nullable

Textual description of the view

starredboolean

Whether the view is starred in its project

createdstring date-time nullable

Date of view creation

updated_atstring date-time nullable

Date of last view update

user_idstring uuid nullable

Identifies the user who created the view

deleted_atstring date-time nullable

Date of role deletion, or null if the role is still active

Changes

  • 8f5039399f77Revision changes
    • info

      removed the undefined enum value from the response property for the response status

  • 6409b3f2bde5Revision changes
    • warning

      added the new patterns enum value to the response property for the response status