BRbraintrustdata
Views

List views

Changed on

List out all views. The views are sorted by creation date, with the most recently-created views coming first

get/v1/view

Request

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

Query parameters

limitinteger nullable

Limit the number of objects to return

starting_afterstring uuid

Pagination cursor id.

For 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

ending_beforestring uuid

Pagination cursor id.

For 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

string uuid
OR
string[]
view_namestring

Name of the view to search for

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'

Type of object that the view corresponds to.

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 a list of view objects

Changes

  • 8f5039399f77Revision changes
    • breaking

      removed the enum value undefined from the query request parameter view_type

    • 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

    • info

      added the new enum value patterns to the query request parameter view_type