{ "opencollection": "1.0.0", "info": { "name": "Braintrust Acls Prompts API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Prompts", "type": "folder" }, "items": [ { "info": { "name": "List prompts", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/prompt", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Limit the number of objects to return" }, { "name": "starting_after", "value": "", "type": "query", "description": "Pagination cursor id.\n\nFor 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`" }, { "name": "ending_before", "value": "", "type": "query", "description": "Pagination cursor id.\n\nFor 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`" }, { "name": "ids", "value": "", "type": "query", "description": "Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times" }, { "name": "prompt_name", "value": "", "type": "query", "description": "Name of the prompt to search for" }, { "name": "project_name", "value": "", "type": "query", "description": "Name of the project to search for" }, { "name": "project_id", "value": "", "type": "query", "description": "Project id" }, { "name": "slug", "value": "", "type": "query", "description": "Retrieve prompt with a specific slug" }, { "name": "version", "value": "", "type": "query", "description": "Retrieve prompt at a specific version.\n\nThe version id can either be a transaction id (e.g. '1000192656880881099') or a version identifier (e.g. '81cd05ee665fdfb3')." }, { "name": "environment", "value": "", "type": "query", "description": "Filter by environment slug. Cannot be used together with `version`.\n\nFor `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." }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all prompts. The prompts are sorted by creation date, with the most recently-created prompts coming first" }, { "info": { "name": "Create prompt", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/prompt", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new prompt. If there is an existing prompt in the project with the same slug as the one specified in the request, will return the existing prompt unmodified" }, { "info": { "name": "Create or replace prompt", "type": "http" }, "http": { "method": "PUT", "url": "https://api.braintrust.dev/v1/prompt", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace prompt. If there is an existing prompt in the project with the same slug as the one specified in the request, will replace the existing prompt with the provided fields" }, { "info": { "name": "Get prompt", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/prompt/:prompt_id", "params": [ { "name": "prompt_id", "value": "", "type": "path", "description": "Prompt id" }, { "name": "version", "value": "", "type": "query", "description": "Retrieve prompt at a specific version.\n\nThe version id can either be a transaction id (e.g. '1000192656880881099') or a version identifier (e.g. '81cd05ee665fdfb3')." }, { "name": "environment", "value": "", "type": "query", "description": "Filter by environment slug. Cannot be used together with `version`.\n\nFor `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." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a prompt object by its id" }, { "info": { "name": "Partially update prompt", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.braintrust.dev/v1/prompt/:prompt_id", "params": [ { "name": "prompt_id", "value": "", "type": "path", "description": "Prompt id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a prompt object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null." }, { "info": { "name": "Delete prompt", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/prompt/:prompt_id", "params": [ { "name": "prompt_id", "value": "", "type": "path", "description": "Prompt id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a prompt object by its id" } ] } ], "bundled": true }