Prompts

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

get/v1/prompt

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[]
prompt_namestring

Name of the prompt to search for

project_namestring

Name of the project to search for

project_idstring uuid

Project id

slugstring

Retrieve prompt with a specific slug

versionstring

Retrieve prompt at a specific version.

The version id can either be a transaction id (e.g. '1000192656880881099') or a version identifier (e.g. '81cd05ee665fdfb3').

environmentstring

Filter by environment slug. Cannot be used together with version.

For GET /v1/prompt, environment resolution currently requires the request to match a single prompt. If multiple prompts match, the endpoint returns 400 (for example when limit=1 is not set). Use limit=1 or other filters (for example slug, project_id) to narrow results.

org_namestring

Filter search results to within a particular organization

Response

Returns a list of prompt objects

Changes

    • info

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

    • info

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

    • info

      added the optional property ////// to the response with the status