diff --git a/openapi/spec.json b/openapi/spec.json index a72623f..e024994 100644 --- a/openapi/spec.json +++ b/openapi/spec.json @@ -14102,155 +14102,6 @@ } } }, - "SimulatedUserVoiceConfig": { - "type": "object", - "properties": { - "voice_id": { - "type": "string", - "format": "uuid" - }, - "language": { - "type": "string", - "minLength": 1 - }, - "accent": { - "type": "string", - "minLength": 1 - }, - "speaking_rate": { - "type": "number", - "exclusiveMinimum": 0 - } - }, - "required": [ - "voice_id" - ], - "additionalProperties": false - }, - "SimulatedUser": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "Unique identifier for the simulated user" - }, - "_xact_id": { - "type": "string", - "description": "Legacy transaction id. Not returned by simulated user CRUD." - }, - "project_id": { - "type": "string", - "format": "uuid", - "description": "Unique identifier for the project that the simulated user belongs under" - }, - "org_id": { - "type": "string", - "format": "uuid", - "description": "Unique identifier for the organization" - }, - "name": { - "type": "string", - "minLength": 1, - "description": "Name of the simulated user" - }, - "created": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Date of simulated user creation" - }, - "instructions": { - "type": "string", - "minLength": 1, - "description": "The simulated user's role, scenario, and behavior" - }, - "goal": { - "type": "string", - "minLength": 1, - "description": "The simulated user's objective, used to decide when to end the conversation" - }, - "voice_config": { - "$ref": "#/components/schemas/SimulatedUserVoiceConfig" - } - }, - "required": [ - "id", - "project_id", - "org_id", - "name", - "instructions", - "voice_config" - ] - }, - "AppLimit": { - "type": [ - "integer", - "null" - ], - "minimum": 0, - "maximum": 1000, - "default": 100, - "description": "Limit the number of objects to return" - }, - "CreateSimulatedUser": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "Name of the simulated user" - }, - "instructions": { - "type": "string", - "minLength": 1, - "description": "The simulated user's role, scenario, and behavior" - }, - "goal": { - "type": "string", - "minLength": 1, - "description": "The simulated user's objective, used to decide when to end the conversation" - }, - "voice_config": { - "$ref": "#/components/schemas/SimulatedUserVoiceConfig" - } - }, - "required": [ - "name", - "instructions", - "voice_config" - ], - "additionalProperties": false - }, - "PatchSimulatedUser": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "Name of the simulated user" - }, - "instructions": { - "type": "string", - "minLength": 1, - "description": "The simulated user's role, scenario, and behavior" - }, - "goal": { - "type": [ - "string", - "null" - ], - "minLength": 1, - "description": "The simulated user's objective. Set to null to clear it." - }, - "voice_config": { - "$ref": "#/components/schemas/SimulatedUserVoiceConfig" - } - }, - "additionalProperties": false - }, "Environment": { "type": "object", "properties": { @@ -33386,657 +33237,6 @@ } } }, - "/v1/project/{project_id}/simulated_user": { - "get": { - "operationId": "listSimulatedUsers", - "summary": "List simulated users", - "description": "List simulated users in a project, ordered by UUID. Requires project read permission.", - "tags": [ - "Simulated users" - ], - "security": [ - { - "bearerAuth": [] - }, - {} - ], - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid" - }, - "required": true, - "name": "project_id", - "in": "path" - }, - { - "schema": { - "anyOf": [ - { - "type": "string", - "format": "uuid" - }, - { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "maxItems": 1000 - } - ] - }, - "required": false, - "name": "ids", - "in": "query" - }, - { - "schema": { - "type": "string" - }, - "required": false, - "name": "simulated_user_name", - "in": "query" - }, - { - "schema": { - "$ref": "#/components/schemas/AppLimit" - }, - "required": false, - "description": "Limit the number of objects to return", - "name": "limit", - "in": "query" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - } - ], - "responses": { - "200": { - "description": "The matching simulated users", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "objects": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SimulatedUser" - } - } - }, - "required": [ - "objects" - ] - } - } - } - }, - "400": { - "description": "The request was unacceptable, often due to missing a required parameter", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "401": { - "description": "No valid API key provided", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "403": { - "description": "The API key doesn’t have permissions to perform the request", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "429": { - "description": "Too many requests hit the API too quickly. We recommend an exponential backoff of your requests", - "headers": { - "Retry-After": { - "schema": { - "type": "string" - } - } - }, - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Something went wrong on Braintrust's end. (These are rare.)", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - } - } - }, - "post": { - "operationId": "createSimulatedUser", - "summary": "Create simulated user", - "description": "Create a simulated user with a new UUID. Display names may repeat. Requires project update permission.", - "tags": [ - "Simulated users" - ], - "security": [ - { - "bearerAuth": [] - }, - {} - ], - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid" - }, - "required": true, - "name": "project_id", - "in": "path" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateSimulatedUser" - } - } - } - }, - "responses": { - "200": { - "description": "The simulated user, including its stable UUID", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SimulatedUser" - } - } - } - }, - "400": { - "description": "The request was unacceptable, often due to missing a required parameter", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "401": { - "description": "No valid API key provided", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "403": { - "description": "The API key doesn’t have permissions to perform the request", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "429": { - "description": "Too many requests hit the API too quickly. We recommend an exponential backoff of your requests", - "headers": { - "Retry-After": { - "schema": { - "type": "string" - } - } - }, - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Something went wrong on Braintrust's end. (These are rare.)", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - } - } - } - }, - "/v1/project/{project_id}/simulated_user/{id}": { - "get": { - "operationId": "getSimulatedUser", - "summary": "Get simulated user", - "description": "Retrieve a simulated user by its UUID within the specified project. Requires project read permission.", - "tags": [ - "Simulated users" - ], - "security": [ - { - "bearerAuth": [] - }, - {} - ], - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid" - }, - "required": true, - "name": "project_id", - "in": "path" - }, - { - "schema": { - "type": "string", - "format": "uuid" - }, - "required": true, - "name": "id", - "in": "path" - } - ], - "responses": { - "200": { - "description": "The simulated user, including its stable UUID", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SimulatedUser" - } - } - } - }, - "400": { - "description": "The request was unacceptable, often due to missing a required parameter", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "401": { - "description": "No valid API key provided", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "403": { - "description": "The API key doesn’t have permissions to perform the request", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "429": { - "description": "Too many requests hit the API too quickly. We recommend an exponential backoff of your requests", - "headers": { - "Retry-After": { - "schema": { - "type": "string" - } - } - }, - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Something went wrong on Braintrust's end. (These are rare.)", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - } - } - }, - "patch": { - "operationId": "patchSimulatedUser", - "summary": "Update simulated user", - "description": "Update an existing simulated user while preserving its UUID. Supplied voice_config replaces the entire voice configuration. Set goal to null to clear it. Requires project update permission and project read permission because the response includes the stored simulated user.", - "tags": [ - "Simulated users" - ], - "security": [ - { - "bearerAuth": [] - }, - {} - ], - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid" - }, - "required": true, - "name": "project_id", - "in": "path" - }, - { - "schema": { - "type": "string", - "format": "uuid" - }, - "required": true, - "name": "id", - "in": "path" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchSimulatedUser" - } - } - } - }, - "responses": { - "200": { - "description": "The simulated user, including its stable UUID", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SimulatedUser" - } - } - } - }, - "400": { - "description": "The request was unacceptable, often due to missing a required parameter", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "401": { - "description": "No valid API key provided", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "403": { - "description": "The API key doesn’t have permissions to perform the request", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "429": { - "description": "Too many requests hit the API too quickly. We recommend an exponential backoff of your requests", - "headers": { - "Retry-After": { - "schema": { - "type": "string" - } - } - }, - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Something went wrong on Braintrust's end. (These are rare.)", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - } - } - }, - "delete": { - "operationId": "deleteSimulatedUser", - "summary": "Delete simulated user", - "description": "Delete an existing simulated user in the specified project. Requires project update permission and project read permission because the response includes the stored simulated user.", - "tags": [ - "Simulated users" - ], - "security": [ - { - "bearerAuth": [] - }, - {} - ], - "parameters": [ - { - "schema": { - "type": "string", - "format": "uuid" - }, - "required": true, - "name": "project_id", - "in": "path" - }, - { - "schema": { - "type": "string", - "format": "uuid" - }, - "required": true, - "name": "id", - "in": "path" - } - ], - "responses": { - "200": { - "description": "The simulated user, including its stable UUID", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SimulatedUser" - } - } - } - }, - "400": { - "description": "The request was unacceptable, often due to missing a required parameter", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "401": { - "description": "No valid API key provided", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "403": { - "description": "The API key doesn’t have permissions to perform the request", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "429": { - "description": "Too many requests hit the API too quickly. We recommend an exponential backoff of your requests", - "headers": { - "Retry-After": { - "schema": { - "type": "string" - } - } - }, - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - }, - "500": { - "description": "Something went wrong on Braintrust's end. (These are rare.)", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": {} - } - } - } - } - } - }, "/environment": { "get": { "operationId": "listEnvironments", diff --git a/openapi/spec.yaml b/openapi/spec.yaml index eaafd67..f3bd365 100644 --- a/openapi/spec.yaml +++ b/openapi/spec.yaml @@ -23,7 +23,8 @@ components: type: http scheme: bearer bearerFormat: API key or JWT - description: "Most Braintrust endpoints are authenticated by providing your API + description: + "Most Braintrust endpoints are authenticated by providing your API key as a header `Authorization: Bearer [api_key]` to your HTTP request. You can create an API key in the Braintrust [organization settings page](https://www.braintrustdata.com/app/settings?subroute=api-keys)." @@ -271,7 +272,8 @@ components: items: type: string format: uuid - description: Filter search results to a particular set of object IDs. To specify + description: + Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times AppLimitParam: type: @@ -394,7 +396,8 @@ components: type: - boolean - "null" - description: Whether to summarize the scores and metrics. If false (or omitted), + description: + Whether to summarize the scores and metrics. If false (or omitted), only the metadata will be returned. ComparisonExperimentId: type: string @@ -407,7 +410,8 @@ components: type: - boolean - "null" - description: Whether to summarize the data. If false (or omitted), only the + description: + Whether to summarize the data. If false (or omitted), only the metadata will be returned. Slug: type: string @@ -456,7 +460,8 @@ components: - type: array items: type: string - description: Email of the user to search for. You may pass the param multiple + description: + Email of the user to search for. You may pass the param multiple times to filter for more than one email AclObjectType: type: string @@ -511,12 +516,14 @@ components: AclListUserId: type: string format: uuid - description: Id of the user the ACL applies to. Exactly one of `user_id` and + description: + Id of the user the ACL applies to. Exactly one of `user_id` and `group_id` will be provided AclListGroupId: type: string format: uuid - description: Id of the group the ACL applies to. Exactly one of `user_id` and + description: + Id of the group the ACL applies to. Exactly one of `user_id` and `group_id` will be provided AclListPermission: type: string @@ -560,7 +567,8 @@ components: AclListRoleId: type: string format: uuid - description: Id of the role the ACL grants. Exactly one of `permission` and + description: + Id of the role the ACL grants. Exactly one of `permission` and `role_id` will be provided ProjectScoreType: type: string @@ -640,7 +648,8 @@ components: - name title: global - type: "null" - description: Default preprocessor for this project. When set, functions that use + description: + Default preprocessor for this project. When set, functions that use preprocessors will use this instead of their built-in default. ProjectSettings: type: @@ -657,7 +666,8 @@ components: - string - "null" format: uuid - description: The id of the experiment to use as the default baseline for + description: + The id of the experiment to use as the default baseline for comparisons spanFieldOrder: type: @@ -710,13 +720,15 @@ components: type: - boolean - "null" - description: If true, disable real-time queries for this project. This can + description: + If true, disable real-time queries for this project. This can improve query performance for high-volume logs. monitor_charts_use_metrics_start: type: - boolean - "null" - description: If true, use metrics.start rather than created for monitor chart + description: + If true, use metrics.start rather than created for monitor chart time bucket dimensions. coding_agent_insights_dashboard: type: @@ -727,14 +739,16 @@ components: type: - boolean - "null" - description: If true, hide peer review scores, comments, and aggregate results + description: + If true, hide peer review scores, comments, and aggregate results from reviewers without project update permissions until they submit their own review. require_all_human_review_scores: type: - boolean - "null" - description: If true, automatically complete a review after every assigned + description: + If true, automatically complete a review after every assigned reviewer fills all human review scores visible to them. default_preprocessor: $ref: "#/components/schemas/NullableSavedFunctionId" @@ -797,7 +811,8 @@ components: type: - string - "null" - description: For nearly all users, this parameter should be unnecessary. But in + description: + For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the project belongs in. project_group_name: @@ -829,7 +844,8 @@ components: settings: allOf: - $ref: "#/components/schemas/ProjectSettings" - - description: Project settings. Patch operations replace all settings, so make + - description: + Project settings. Patch operations replace all settings, so make sure you include all settings you want to keep. InsertEventsResponse: type: object @@ -838,7 +854,8 @@ components: type: array items: type: string - description: The ids of all rows that were inserted, aligning one-to-one with + description: + The ids of all rows that were inserted, aligning one-to-one with the rows provided as input required: - row_ids @@ -882,7 +899,8 @@ components: enum: - scorer - null - description: A special value that indicates the span was generated by a scoring + description: + A special value that indicates the span was generated by a scoring automation log_level: type: @@ -940,17 +958,20 @@ components: type: object properties: input: - description: The arguments that uniquely define a user input (an arbitrary, JSON + description: + The arguments that uniquely define a user input (an arbitrary, JSON serializable object). output: - description: The output of your application, including post-processing (an + description: + The output of your application, including post-processing (an arbitrary, JSON serializable object), that allows you to determine whether the result is correct or not. For example, in an app that generates SQL queries, the `output` should be the _result_ of the SQL query generated by the model, not the query itself, because there may be multiple valid queries that answer a single question. expected: - description: The ground truth value (an arbitrary, JSON serializable object) + description: + The ground truth value (an arbitrary, JSON serializable object) that you'd compare to `output` to determine if your `output` value is correct or not. Braintrust currently does not compare `output` to `expected` for you, since there are so many different ways to do @@ -969,7 +990,8 @@ components: - "null" minimum: 0 maximum: 1 - description: A dictionary of numeric values (between 0 and 1) to log. The scores + description: + A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that @@ -989,7 +1011,8 @@ components: - "null" description: The model used for this example additionalProperties: {} - description: A dictionary with additional data about the test example, model + description: + A dictionary with additional data about the test example, model outputs, or just about anything else that's relevant, that you can use to help find and analyze examples later. For example, you could log the `prompt`, example's `id`, or anything else that would be @@ -1011,31 +1034,36 @@ components: type: - number - "null" - description: A unix timestamp recording when the section of code which produced + description: + A unix timestamp recording when the section of code which produced the project logs event started end: type: - number - "null" - description: A unix timestamp recording when the section of code which produced + description: + A unix timestamp recording when the section of code which produced the project logs event finished prompt_tokens: type: - integer - "null" - description: The number of tokens in the prompt used to generate the project + description: + The number of tokens in the prompt used to generate the project logs event (only set if this is an LLM span) completion_tokens: type: - integer - "null" - description: The number of tokens in the completion generated by the model (only + description: + The number of tokens in the completion generated by the model (only set if this is an LLM span) tokens: type: - integer - "null" - description: The total number of tokens in the input and output of the project + description: + The total number of tokens in the input and output of the project logs event. caller_functionname: description: Deprecated. Use `context.caller_functionname` instead. @@ -1045,7 +1073,8 @@ components: description: Deprecated. Use `context.caller_lineno` instead. additionalProperties: type: number - description: Metrics are numerical measurements tracking the execution of the + description: + Metrics are numerical measurements tracking the execution of the code that produced the project logs event. Use "start" and "end" to track the time span over which the project logs event was produced context: @@ -1069,7 +1098,8 @@ components: - "null" description: Line of code where the project logs event was created additionalProperties: {} - description: Context is additional information about the code that produced the + description: + Context is additional information about the code that produced the project logs event. It is essentially the textual counterpart to `metrics`. Use the `caller_*` attributes to track the location in code which produced the project logs event @@ -1079,7 +1109,8 @@ components: type: - string - "null" - description: A unique identifier for the project logs event. If you don't + description: + A unique identifier for the project logs event. If you don't provide one, Braintrust will generate one for you created: type: @@ -1102,7 +1133,8 @@ components: type: - boolean - "null" - description: Pass `_object_delete=true` to mark the project logs event deleted. + description: + Pass `_object_delete=true` to mark the project logs event deleted. Deleted events will not show up in subsequent fetches for this project logs _is_merge: @@ -1336,11 +1368,13 @@ components: properties: id: type: string - description: A unique identifier for the project logs event. If you don't + description: + A unique identifier for the project logs event. If you don't provide one, Braintrust will generate one for you _xact_id: type: string - description: The transaction id of an event is unique to the network operation + description: + The transaction id of an event is unique to the network operation that processed the event insertion. Transaction ids are monotonically increasing over time and can be used to retrieve a versioned snapshot of the project logs (see the `version` parameter) @@ -1348,7 +1382,8 @@ components: type: - string - "null" - description: A stable, time-ordered key that can be used to paginate over + description: + A stable, time-ordered key that can be used to paginate over project logs events. This field is auto-generated by Braintrust and only exists in Brainstore. created: @@ -1369,17 +1404,20 @@ components: - g description: A literal 'g' which identifies the log as a project log input: - description: The arguments that uniquely define a user input (an arbitrary, JSON + description: + The arguments that uniquely define a user input (an arbitrary, JSON serializable object). output: - description: The output of your application, including post-processing (an + description: + The output of your application, including post-processing (an arbitrary, JSON serializable object), that allows you to determine whether the result is correct or not. For example, in an app that generates SQL queries, the `output` should be the _result_ of the SQL query generated by the model, not the query itself, because there may be multiple valid queries that answer a single question. expected: - description: The ground truth value (an arbitrary, JSON serializable object) + description: + The ground truth value (an arbitrary, JSON serializable object) that you'd compare to `output` to determine if your `output` value is correct or not. Braintrust currently does not compare `output` to `expected` for you, since there are so many different ways to do @@ -1398,7 +1436,8 @@ components: - "null" minimum: 0 maximum: 1 - description: A dictionary of numeric values (between 0 and 1) to log. The scores + description: + A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that @@ -1418,7 +1457,8 @@ components: - "null" description: The model used for this example additionalProperties: {} - description: A dictionary with additional data about the test example, model + description: + A dictionary with additional data about the test example, model outputs, or just about anything else that's relevant, that you can use to help find and analyze examples later. For example, you could log the `prompt`, example's `id`, or anything else that would be @@ -1440,31 +1480,36 @@ components: type: - number - "null" - description: A unix timestamp recording when the section of code which produced + description: + A unix timestamp recording when the section of code which produced the project logs event started end: type: - number - "null" - description: A unix timestamp recording when the section of code which produced + description: + A unix timestamp recording when the section of code which produced the project logs event finished prompt_tokens: type: - integer - "null" - description: The number of tokens in the prompt used to generate the project + description: + The number of tokens in the prompt used to generate the project logs event (only set if this is an LLM span) completion_tokens: type: - integer - "null" - description: The number of tokens in the completion generated by the model (only + description: + The number of tokens in the completion generated by the model (only set if this is an LLM span) tokens: type: - integer - "null" - description: The total number of tokens in the input and output of the project + description: + The total number of tokens in the input and output of the project logs event. caller_functionname: description: Deprecated. Use `context.caller_functionname` instead. @@ -1474,7 +1519,8 @@ components: description: Deprecated. Use `context.caller_lineno` instead. additionalProperties: type: number - description: Metrics are numerical measurements tracking the execution of the + description: + Metrics are numerical measurements tracking the execution of the code that produced the project logs event. Use "start" and "end" to track the time span over which the project logs event was produced context: @@ -1498,13 +1544,15 @@ components: - "null" description: Line of code where the project logs event was created additionalProperties: {} - description: Context is additional information about the code that produced the + description: + Context is additional information about the code that produced the project logs event. It is essentially the textual counterpart to `metrics`. Use the `caller_*` attributes to track the location in code which produced the project logs event span_id: type: string - description: A unique identifier used to link different project logs events + description: + A unique identifier used to link different project logs events together as part of a full trace. See the [tracing guide](https://docs.braintrust.dev/instrument) for full details on tracing @@ -1514,7 +1562,8 @@ components: - "null" items: type: string - description: An array of the parent `span_ids` of this project logs event. This + description: + An array of the parent `span_ids` of this project logs event. This should be empty for the root span of a trace, and should most often contain just one parent element for subspans root_span_id: @@ -1566,7 +1615,8 @@ components: description: Stable classification identifier label: type: string - description: Original label of the classification item, which is useful for + description: + Original label of the classification item, which is useful for search and indexing purposes confidence: type: @@ -1583,7 +1633,8 @@ components: $ref: "#/components/schemas/SavedFunctionId" required: - id - description: Classifications for this event (dictionary from classification name + description: + Classifications for this event (dictionary from classification name to items) required: - id @@ -1682,7 +1733,8 @@ components: properties: id: type: string - description: The id of the project logs event to log feedback for. This is the + description: + The id of the project logs event to log feedback for. This is the row `id` returned by `POST /v1/project_logs/{project_id}/insert` scores: type: @@ -1694,11 +1746,13 @@ components: - "null" minimum: 0 maximum: 1 - description: A dictionary of numeric values (between 0 and 1) to log. These + description: + A dictionary of numeric values (between 0 and 1) to log. These scores will be merged into the existing scores for the project logs event expected: - description: The ground truth value (an arbitrary, JSON serializable object) + description: + The ground truth value (an arbitrary, JSON serializable object) that you'd compare to `output` to determine if your `output` value is correct or not comment: @@ -1711,7 +1765,8 @@ components: - object - "null" additionalProperties: {} - description: A dictionary with additional data about the feedback. If you have a + description: + A dictionary with additional data about the feedback. If you have a `user_id`, you can log it here and access it in the Braintrust UI. Note, this metadata does not correspond to the main event itself, but rather the audit log attached to the event. @@ -1724,7 +1779,8 @@ components: - api - external - null - description: The source of the feedback. Must be one of "external" (default), + description: + The source of the feedback. Must be one of "external" (default), "app", or "api" tags: type: @@ -1794,7 +1850,8 @@ components: type: - string - "null" - description: If the repo was dirty when run, this includes the diff between the + description: + If the repo was dirty when run, this includes the diff between the current state of the repo and the most recent commit. description: Metadata about the state of the repo when the experiment was created Experiment: @@ -1834,27 +1891,31 @@ components: - string - "null" format: uuid - description: Id of default base experiment to compare against when viewing this + description: + Id of default base experiment to compare against when viewing this experiment deleted_at: type: - string - "null" format: date-time - description: Date of experiment deletion, or null if the experiment is still + description: + Date of experiment deletion, or null if the experiment is still active dataset_id: type: - string - "null" format: uuid - description: Identifier of the linked dataset, or null if the experiment is not + description: + Identifier of the linked dataset, or null if the experiment is not linked to a dataset dataset_version: type: - string - "null" - description: Version number of the linked dataset the experiment was run + description: + Version number of the linked dataset the experiment was run against. This can be used to reproduce the experiment after the dataset has been modified. internal_metadata: @@ -1875,17 +1936,20 @@ components: - string - "null" format: uuid - description: Identifier of the linked saved parameters object, or null if the + description: + Identifier of the linked saved parameters object, or null if the experiment is not linked to saved parameters parameters_version: type: - string - "null" - description: Version number of the linked saved parameters object the experiment + description: + Version number of the linked saved parameters object the experiment was run against. public: type: boolean - description: Whether or not the experiment is public. Public experiments can be + description: + Whether or not the experiment is public. Public experiments can be viewed by anybody inside or outside the organization user_id: type: @@ -1936,20 +2000,23 @@ components: - string - "null" format: uuid - description: Id of default base experiment to compare against when viewing this + description: + Id of default base experiment to compare against when viewing this experiment dataset_id: type: - string - "null" format: uuid - description: Identifier of the linked dataset, or null if the experiment is not + description: + Identifier of the linked dataset, or null if the experiment is not linked to a dataset dataset_version: type: - string - "null" - description: Version number of the linked dataset the experiment was run + description: + Version number of the linked dataset the experiment was run against. This can be used to reproduce the experiment after the dataset has been modified. internal_metadata: @@ -1970,19 +2037,22 @@ components: - string - "null" format: uuid - description: Identifier of the linked saved parameters object, or null if the + description: + Identifier of the linked saved parameters object, or null if the experiment is not linked to saved parameters parameters_version: type: - string - "null" - description: Version number of the linked saved parameters object the experiment + description: + Version number of the linked saved parameters object the experiment was run against. public: type: - boolean - "null" - description: Whether or not the experiment is public. Public experiments can be + description: + Whether or not the experiment is public. Public experiments can be viewed by anybody inside or outside the organization metadata: type: @@ -2001,7 +2071,8 @@ components: type: - boolean - "null" - description: Normally, creating an experiment with the same name as an existing + description: + Normally, creating an experiment with the same name as an existing experiment will return the existing one un-modified. But if `ensure_new` is true, registration will generate a new experiment with a unique name in case of a conflict. @@ -2027,20 +2098,23 @@ components: - string - "null" format: uuid - description: Id of default base experiment to compare against when viewing this + description: + Id of default base experiment to compare against when viewing this experiment dataset_id: type: - string - "null" format: uuid - description: Identifier of the linked dataset, or null if the experiment is not + description: + Identifier of the linked dataset, or null if the experiment is not linked to a dataset dataset_version: type: - string - "null" - description: Version number of the linked dataset the experiment was run + description: + Version number of the linked dataset the experiment was run against. This can be used to reproduce the experiment after the dataset has been modified. internal_metadata: @@ -2061,19 +2135,22 @@ components: - string - "null" format: uuid - description: Identifier of the linked saved parameters object, or null if the + description: + Identifier of the linked saved parameters object, or null if the experiment is not linked to saved parameters parameters_version: type: - string - "null" - description: Version number of the linked saved parameters object the experiment + description: + Version number of the linked saved parameters object the experiment was run against. public: type: - boolean - "null" - description: Whether or not the experiment is public. Public experiments can be + description: + Whether or not the experiment is public. Public experiments can be viewed by anybody inside or outside the organization metadata: type: @@ -2092,21 +2169,24 @@ components: type: object properties: input: - description: The arguments that uniquely define a test case (an arbitrary, JSON + description: + The arguments that uniquely define a test case (an arbitrary, JSON serializable object). Later on, Braintrust will use the `input` to know whether two test cases are the same between experiments, so they should not contain experiment-specific state. A simple rule of thumb is that if you run the same experiment twice, the `input` should be identical output: - description: The output of your application, including post-processing (an + description: + The output of your application, including post-processing (an arbitrary, JSON serializable object), that allows you to determine whether the result is correct or not. For example, in an app that generates SQL queries, the `output` should be the _result_ of the SQL query generated by the model, not the query itself, because there may be multiple valid queries that answer a single question expected: - description: The ground truth value (an arbitrary, JSON serializable object) + description: + The ground truth value (an arbitrary, JSON serializable object) that you'd compare to `output` to determine if your `output` value is correct or not. Braintrust currently does not compare `output` to `expected` for you, since there are so many different ways to do @@ -2126,7 +2206,8 @@ components: - "null" minimum: 0 maximum: 1 - description: A dictionary of numeric values (between 0 and 1) to log. The scores + description: + A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that @@ -2146,7 +2227,8 @@ components: - "null" description: The model used for this example additionalProperties: {} - description: A dictionary with additional data about the test example, model + description: + A dictionary with additional data about the test example, model outputs, or just about anything else that's relevant, that you can use to help find and analyze examples later. For example, you could log the `prompt`, example's `id`, or anything else that would be @@ -2168,31 +2250,36 @@ components: type: - number - "null" - description: A unix timestamp recording when the section of code which produced + description: + A unix timestamp recording when the section of code which produced the experiment event started end: type: - number - "null" - description: A unix timestamp recording when the section of code which produced + description: + A unix timestamp recording when the section of code which produced the experiment event finished prompt_tokens: type: - integer - "null" - description: The number of tokens in the prompt used to generate the experiment + description: + The number of tokens in the prompt used to generate the experiment event (only set if this is an LLM span) completion_tokens: type: - integer - "null" - description: The number of tokens in the completion generated by the model (only + description: + The number of tokens in the completion generated by the model (only set if this is an LLM span) tokens: type: - integer - "null" - description: The total number of tokens in the input and output of the + description: + The total number of tokens in the input and output of the experiment event. caller_functionname: description: Deprecated. Use `context.caller_functionname` instead. @@ -2202,7 +2289,8 @@ components: description: Deprecated. Use `context.caller_lineno` instead. additionalProperties: type: number - description: Metrics are numerical measurements tracking the execution of the + description: + Metrics are numerical measurements tracking the execution of the code that produced the experiment event. Use "start" and "end" to track the time span over which the experiment event was produced context: @@ -2226,7 +2314,8 @@ components: - "null" description: Line of code where the experiment event was created additionalProperties: {} - description: Context is additional information about the code that produced the + description: + Context is additional information about the code that produced the experiment event. It is essentially the textual counterpart to `metrics`. Use the `caller_*` attributes to track the location in code which produced the experiment event @@ -2236,7 +2325,8 @@ components: type: - string - "null" - description: A unique identifier for the experiment event. If you don't provide + description: + A unique identifier for the experiment event. If you don't provide one, Braintrust will generate one for you created: type: @@ -2259,7 +2349,8 @@ components: type: - boolean - "null" - description: Pass `_object_delete=true` to mark the experiment event deleted. + description: + Pass `_object_delete=true` to mark the experiment event deleted. Deleted events will not show up in subsequent fetches for this experiment _is_merge: @@ -2460,11 +2551,13 @@ components: properties: id: type: string - description: A unique identifier for the experiment event. If you don't provide + description: + A unique identifier for the experiment event. If you don't provide one, Braintrust will generate one for you _xact_id: type: string - description: The transaction id of an event is unique to the network operation + description: + The transaction id of an event is unique to the network operation that processed the event insertion. Transaction ids are monotonically increasing over time and can be used to retrieve a versioned snapshot of the experiment (see the `version` parameter) @@ -2476,7 +2569,8 @@ components: type: - string - "null" - description: A stable, time-ordered key that can be used to paginate over + description: + A stable, time-ordered key that can be used to paginate over experiment events. This field is auto-generated by Braintrust and only exists in Brainstore. project_id: @@ -2488,21 +2582,24 @@ components: format: uuid description: Unique identifier for the experiment input: - description: The arguments that uniquely define a test case (an arbitrary, JSON + description: + The arguments that uniquely define a test case (an arbitrary, JSON serializable object). Later on, Braintrust will use the `input` to know whether two test cases are the same between experiments, so they should not contain experiment-specific state. A simple rule of thumb is that if you run the same experiment twice, the `input` should be identical output: - description: The output of your application, including post-processing (an + description: + The output of your application, including post-processing (an arbitrary, JSON serializable object), that allows you to determine whether the result is correct or not. For example, in an app that generates SQL queries, the `output` should be the _result_ of the SQL query generated by the model, not the query itself, because there may be multiple valid queries that answer a single question expected: - description: The ground truth value (an arbitrary, JSON serializable object) + description: + The ground truth value (an arbitrary, JSON serializable object) that you'd compare to `output` to determine if your `output` value is correct or not. Braintrust currently does not compare `output` to `expected` for you, since there are so many different ways to do @@ -2522,7 +2619,8 @@ components: - "null" minimum: 0 maximum: 1 - description: A dictionary of numeric values (between 0 and 1) to log. The scores + description: + A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that @@ -2542,7 +2640,8 @@ components: - "null" description: The model used for this example additionalProperties: {} - description: A dictionary with additional data about the test example, model + description: + A dictionary with additional data about the test example, model outputs, or just about anything else that's relevant, that you can use to help find and analyze examples later. For example, you could log the `prompt`, example's `id`, or anything else that would be @@ -2564,31 +2663,36 @@ components: type: - number - "null" - description: A unix timestamp recording when the section of code which produced + description: + A unix timestamp recording when the section of code which produced the experiment event started end: type: - number - "null" - description: A unix timestamp recording when the section of code which produced + description: + A unix timestamp recording when the section of code which produced the experiment event finished prompt_tokens: type: - integer - "null" - description: The number of tokens in the prompt used to generate the experiment + description: + The number of tokens in the prompt used to generate the experiment event (only set if this is an LLM span) completion_tokens: type: - integer - "null" - description: The number of tokens in the completion generated by the model (only + description: + The number of tokens in the completion generated by the model (only set if this is an LLM span) tokens: type: - integer - "null" - description: The total number of tokens in the input and output of the + description: + The total number of tokens in the input and output of the experiment event. caller_functionname: description: Deprecated. Use `context.caller_functionname` instead. @@ -2598,7 +2702,8 @@ components: description: Deprecated. Use `context.caller_lineno` instead. additionalProperties: type: number - description: Metrics are numerical measurements tracking the execution of the + description: + Metrics are numerical measurements tracking the execution of the code that produced the experiment event. Use "start" and "end" to track the time span over which the experiment event was produced context: @@ -2622,13 +2727,15 @@ components: - "null" description: Line of code where the experiment event was created additionalProperties: {} - description: Context is additional information about the code that produced the + description: + Context is additional information about the code that produced the experiment event. It is essentially the textual counterpart to `metrics`. Use the `caller_*` attributes to track the location in code which produced the experiment event span_id: type: string - description: A unique identifier used to link different experiment events + description: + A unique identifier used to link different experiment events together as part of a full trace. See the [tracing guide](https://docs.braintrust.dev/instrument) for full details on tracing @@ -2638,7 +2745,8 @@ components: - "null" items: type: string - description: An array of the parent `span_ids` of this experiment event. This + description: + An array of the parent `span_ids` of this experiment event. This should be empty for the root span of a trace, and should most often contain just one parent element for subspans root_span_id: @@ -2688,7 +2796,8 @@ components: description: Stable classification identifier label: type: string - description: Original label of the classification item, which is useful for + description: + Original label of the classification item, which is useful for search and indexing purposes confidence: type: @@ -2705,7 +2814,8 @@ components: $ref: "#/components/schemas/SavedFunctionId" required: - id - description: Classifications for this event (dictionary from classification name + description: + Classifications for this event (dictionary from classification name to items) required: - id @@ -2741,7 +2851,8 @@ components: properties: id: type: string - description: The id of the experiment event to log feedback for. This is the row + description: + The id of the experiment event to log feedback for. This is the row `id` returned by `POST /v1/experiment/{experiment_id}/insert` scores: type: @@ -2753,11 +2864,13 @@ components: - "null" minimum: 0 maximum: 1 - description: A dictionary of numeric values (between 0 and 1) to log. These + description: + A dictionary of numeric values (between 0 and 1) to log. These scores will be merged into the existing scores for the experiment event expected: - description: The ground truth value (an arbitrary, JSON serializable object) + description: + The ground truth value (an arbitrary, JSON serializable object) that you'd compare to `output` to determine if your `output` value is correct or not comment: @@ -2770,7 +2883,8 @@ components: - object - "null" additionalProperties: {} - description: A dictionary with additional data about the feedback. If you have a + description: + A dictionary with additional data about the feedback. If you have a `user_id`, you can log it here and access it in the Braintrust UI. Note, this metadata does not correspond to the main event itself, but rather the audit log attached to the event. @@ -2783,7 +2897,8 @@ components: - api - external - null - description: The source of the feedback. Must be one of "external" (default), + description: + The source of the feedback. Must be one of "external" (default), "app", or "api" tags: type: @@ -3026,10 +3141,12 @@ components: type: object properties: input: - description: The argument that uniquely define an input case (an arbitrary, JSON + description: + The argument that uniquely define an input case (an arbitrary, JSON serializable object) expected: - description: The output of your application, including post-processing (an + description: + The output of your application, including post-processing (an arbitrary, JSON serializable object) metadata: type: @@ -3042,7 +3159,8 @@ components: - "null" description: The model used for this example additionalProperties: {} - description: A dictionary with additional data about the test example, model + description: + A dictionary with additional data about the test example, model outputs, or just about anything else that's relevant, that you can use to help find and analyze examples later. For example, you could log the `prompt`, example's `id`, or anything else that would be @@ -3059,7 +3177,8 @@ components: type: - string - "null" - description: A unique identifier for the dataset event. If you don't provide + description: + A unique identifier for the dataset event. If you don't provide one, Braintrust will generate one for you created: type: @@ -3082,7 +3201,8 @@ components: type: - boolean - "null" - description: Pass `_object_delete=true` to mark the dataset event deleted. + description: + Pass `_object_delete=true` to mark the dataset event deleted. Deleted events will not show up in subsequent fetches for this dataset _is_merge: @@ -3283,11 +3403,13 @@ components: properties: id: type: string - description: A unique identifier for the dataset event. If you don't provide + description: + A unique identifier for the dataset event. If you don't provide one, Braintrust will generate one for you _xact_id: type: string - description: The transaction id of an event is unique to the network operation + description: + The transaction id of an event is unique to the network operation that processed the event insertion. Transaction ids are monotonically increasing over time and can be used to retrieve a versioned snapshot of the dataset (see the `version` parameter) @@ -3299,7 +3421,8 @@ components: type: - string - "null" - description: A stable, time-ordered key that can be used to paginate over + description: + A stable, time-ordered key that can be used to paginate over dataset events. This field is auto-generated by Braintrust and only exists in Brainstore. project_id: @@ -3311,10 +3434,12 @@ components: format: uuid description: Unique identifier for the dataset input: - description: The argument that uniquely define an input case (an arbitrary, JSON + description: + The argument that uniquely define an input case (an arbitrary, JSON serializable object) expected: - description: The output of your application, including post-processing (an + description: + The output of your application, including post-processing (an arbitrary, JSON serializable object) metadata: type: @@ -3327,7 +3452,8 @@ components: - "null" description: The model used for this example additionalProperties: {} - description: A dictionary with additional data about the test example, model + description: + A dictionary with additional data about the test example, model outputs, or just about anything else that's relevant, that you can use to help find and analyze examples later. For example, you could log the `prompt`, example's `id`, or anything else that would be @@ -3342,7 +3468,8 @@ components: description: A list of tags to log span_id: type: string - description: A unique identifier used to link different dataset events together + description: + A unique identifier used to link different dataset events together as part of a full trace. See the [tracing guide](https://docs.braintrust.dev/instrument) for full details on tracing @@ -3391,7 +3518,8 @@ components: description: Stable classification identifier label: type: string - description: Original label of the classification item, which is useful for + description: + Original label of the classification item, which is useful for search and indexing purposes confidence: type: @@ -3408,7 +3536,8 @@ components: $ref: "#/components/schemas/SavedFunctionId" required: - id - description: Classifications for this event (dictionary from classification name + description: + Classifications for this event (dictionary from classification name to items) required: - id @@ -3444,7 +3573,8 @@ components: properties: id: type: string - description: The id of the dataset event to log feedback for. This is the row + description: + The id of the dataset event to log feedback for. This is the row `id` returned by `POST /v1/dataset/{dataset_id}/insert` comment: type: @@ -3456,7 +3586,8 @@ components: - object - "null" additionalProperties: {} - description: A dictionary with additional data about the feedback. If you have a + description: + A dictionary with additional data about the feedback. If you have a `user_id`, you can log it here and access it in the Braintrust UI. Note, this metadata does not correspond to the main event itself, but rather the audit log attached to the event. @@ -3469,7 +3600,8 @@ components: - api - external - null - description: The source of the feedback. Must be one of "external" (default), + description: + The source of the feedback. Must be one of "external" (default), "app", or "api" tags: type: @@ -3532,11 +3664,13 @@ components: properties: rows_to_restore: type: integer - description: Number of rows that would be restored to their value at the + description: + Number of rows that would be restored to their value at the requested version rows_to_delete: type: integer - description: Number of rows created after the requested version that would be + description: + Number of rows created after the requested version that would be deleted required: - rows_to_restore @@ -3546,7 +3680,8 @@ components: properties: version: type: string - description: The dataset version to restore to, such as the `xact_id` of a + description: + The dataset version to restore to, such as the `xact_id` of a dataset snapshot required: - version @@ -3783,7 +3918,8 @@ components: type: - string - "null" - description: "Note: This is not part of the OpenAI API spec, but we added it for + description: + "Note: This is not part of the OpenAI API spec, but we added it for interoperability with multiple reasoning models." ChatCompletionMessageParam: anyOf: @@ -4238,15 +4374,18 @@ components: type: array items: type: string - description: List of valid choices without score mapping. Used by classifiers + description: + List of valid choices without score mapping. Used by classifiers that deposit output to tags. allow_no_match: type: boolean - description: If true, adds a 'No match' option. When selected, no tag is + description: + If true, adds a 'No match' option. When selected, no tag is deposited. allow_skip: type: boolean - description: If true, adds a 'Skip' option. When selected, the scorer returns + description: + If true, adds a 'Skip' option. When selected, the scorer returns null. required: - type @@ -4295,7 +4434,8 @@ components: code: type: string minLength: 1 - description: The complete JavaScript preprocessor implementation, including its + description: + The complete JavaScript preprocessor implementation, including its handler. required: - type @@ -4452,7 +4592,8 @@ components: description: Unique identifier for the prompt _xact_id: type: string - description: The transaction id of an event is unique to the network operation + description: + The transaction id of an event is unique to the network operation that processed the event insertion. Transaction ids are monotonically increasing over time and can be used to retrieve a versioned snapshot of the prompt (see the `version` parameter) @@ -4548,7 +4689,8 @@ components: - "null" items: type: string - description: A list of environment slugs to assign the prompt to. Each slug must + description: + A list of environment slugs to assign the prompt to. Each slug must reference an existing environment; if any slug does not exist, the entire request fails and the prompt is not created. required: @@ -4731,7 +4873,8 @@ components: type: - string - "null" - description: For nearly all users, this parameter should be unnecessary. But in + description: + For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the role belongs in. required: @@ -4906,7 +5049,8 @@ components: type: - string - "null" - description: For nearly all users, this parameter should be unnecessary. But in + description: + For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the group belongs in. required: @@ -4996,21 +5140,24 @@ components: - string - "null" format: date-time - description: Date of project group deletion, or null if the project group is + description: + Date of project group deletion, or null if the project group is still active member_projects: type: array items: type: string format: uuid - description: Sorted ids of active projects in this project group. Modifying + description: + Sorted ids of active projects in this project group. Modifying membership requires project_group:update on the group. required: - id - org_id - name - member_projects - description: A project group is a collection of projects which inherit access + description: + A project group is a collection of projects which inherit access from project_group_projects ACLs. The group's definition and membership are governed separately by project_group ACLs. CreateProjectGroup: @@ -5029,7 +5176,8 @@ components: type: - string - "null" - description: For nearly all users, this parameter should be unnecessary. But in + description: + For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the project group belongs in. @@ -5085,23 +5233,27 @@ components: - string - "null" format: uuid - description: Id of the user the ACL applies to. Exactly one of `user_id` and + description: + Id of the user the ACL applies to. Exactly one of `user_id` and `group_id` will be provided group_id: type: - string - "null" format: uuid - description: Id of the group the ACL applies to. Exactly one of `user_id` and + description: + Id of the group the ACL applies to. Exactly one of `user_id` and `group_id` will be provided permission: - description: Permission the ACL grants. Exactly one of `permission` and + description: + Permission the ACL grants. Exactly one of `permission` and `role_id` will be provided anyOf: - $ref: "#/components/schemas/Permission" - type: "null" restrict_object_type: - description: When setting a permission directly, optionally restricts the + description: + When setting a permission directly, optionally restricts the permission grant to just the specified object type. Cannot be set alongside a `role_id`. anyOf: @@ -5112,7 +5264,8 @@ components: - string - "null" format: uuid - description: Id of the role the ACL grants. Exactly one of `permission` and + description: + Id of the role the ACL grants. Exactly one of `permission` and `role_id` will be provided _object_org_id: type: string @@ -5157,23 +5310,27 @@ components: - string - "null" format: uuid - description: Id of the user the ACL applies to. Exactly one of `user_id` and + description: + Id of the user the ACL applies to. Exactly one of `user_id` and `group_id` will be provided group_id: type: - string - "null" format: uuid - description: Id of the group the ACL applies to. Exactly one of `user_id` and + description: + Id of the group the ACL applies to. Exactly one of `user_id` and `group_id` will be provided permission: - description: Permission the ACL grants. Exactly one of `permission` and + description: + Permission the ACL grants. Exactly one of `permission` and `role_id` will be provided anyOf: - $ref: "#/components/schemas/Permission" - type: "null" restrict_object_type: - description: When setting a permission directly, optionally restricts the + description: + When setting a permission directly, optionally restricts the permission grant to just the specified object type. Cannot be set alongside a `role_id`. anyOf: @@ -5184,7 +5341,8 @@ components: - string - "null" format: uuid - description: Id of the role the ACL grants. Exactly one of `permission` and + description: + Id of the role the ACL grants. Exactly one of `permission` and `role_id` will be provided required: - object_type @@ -5295,7 +5453,8 @@ components: description: Stable, URL-safe identifier for the agent, unique within its project. kind: type: string - description: "Agent classification: 'custom' for customer-defined agents, 'loop' + description: + "Agent classification: 'custom' for customer-defined agents, 'loop' for built-in Loop agents." description: type: @@ -5315,7 +5474,8 @@ components: - name - slug - kind - description: An agent is a project-scoped durable object that identifies an AI + description: + An agent is a project-scoped durable object that identifies an AI agent or service emitting spans CreateAgent: type: object @@ -5341,7 +5501,8 @@ components: required: - project_id - name - description: An agent is a project-scoped durable object that identifies an AI + description: + An agent is a project-scoped durable object that identifies an AI agent or service emitting spans PatchAgent: type: object @@ -5362,7 +5523,8 @@ components: - "null" additionalProperties: {} description: User-controlled metadata about the agent - description: An agent is a project-scoped durable object that identifies an AI + description: + An agent is a project-scoped durable object that identifies an AI agent or service emitting spans AutomationStatus: type: string @@ -5389,7 +5551,8 @@ components: - trace idle_seconds: type: number - description: "Consider trace complete after this many seconds of inactivity + description: + "Consider trace complete after this many seconds of inactivity (default: 30)" required: - type @@ -5412,7 +5575,8 @@ components: type: integer minimum: 1 maximum: 64 - description: "Maximum number of traces to include when constructing a group + description: + "Maximum number of traces to include when constructing a group (default/max: 64)" placement: type: string @@ -5456,7 +5620,8 @@ components: $ref: "#/components/schemas/AutomationStatus" continuous: type: boolean - description: Between scheduled runs, check for accumulated new work. The + description: + Between scheduled runs, check for accumulated new work. The executor decides how to process it. threshold: type: object @@ -5472,7 +5637,8 @@ components: btql_query: type: string minLength: 1 - description: A project-scoped BTQL or SQL query without runtime-owned evaluation + description: + A project-scoped BTQL or SQL query without runtime-owned evaluation time bounds output: type: object @@ -5549,7 +5715,8 @@ components: required: - calculation - policy - description: Optional calculation and lifecycle policy that gate scheduled + description: + Optional calculation and lifecycle policy that gate scheduled delivery window: type: object @@ -5584,19 +5751,22 @@ components: cron_expression: type: string minLength: 1 - description: A standard five-field cron expression (minute hour day-of-month + description: + A standard five-field cron expression (minute hour day-of-month month day-of-week) controlling when the automation runs timezone: type: - string - "null" minLength: 1 - description: IANA timezone used to interpret the cron expression (defaults to + description: + IANA timezone used to interpret the cron expression (defaults to UTC) required: - type - cron_expression - description: "How often the windowed automation runs: at a fixed interval or on + description: + "How often the windowed automation runs: at a fixed interval or on a cron schedule" evaluation_delay_seconds: type: integer @@ -5637,12 +5807,14 @@ components: - codex - claude-code - pi - description: Required for an explicit model selection. Currently only Codex is + description: + Required for an explicit model selection. Currently only Codex is supported. model: type: string minLength: 1 - description: Omit harness, model, and endpoint_name to inherit the organization + description: + Omit harness, model, and endpoint_name to inherit the organization default provider and its recommended execution settings. endpoint_name: type: string @@ -5756,7 +5928,8 @@ components: description: A delivery action available to an automation maxItems: 20 default: [] - description: Delivery actions exposed to Loop as tools, or run directly when + description: + Delivery actions exposed to Loop as tools, or run directly when Loop is not configured required: - event_type @@ -5812,7 +5985,8 @@ components: type: - string - "null" - description: Per-topic-map BTQL filter. For trace scope, a topic map runs when + description: + Per-topic-map BTQL filter. For trace scope, a topic map runs when max(filter) over the trace is truthy. For span scope, it runs when the current span matches. required: @@ -5931,7 +6105,8 @@ components: - number - "null" minimum: 60 - description: Deprecated. How much recent history to relabel after a new topic + description: + Deprecated. How much recent history to relabel after a new topic map version becomes active. Data planes v2.15.0 and later ignore this and apply a topic map version after the first only to traces classified once it is active. @@ -6022,7 +6197,8 @@ components: project_id: type: string format: uuid - description: Unique identifier for the project that the project automation + description: + Unique identifier for the project that the project automation belongs under user_id: type: @@ -6062,7 +6238,8 @@ components: type: number minimum: 1 maximum: 2592000 - description: Perform the triggered action at most once in this interval of + description: + Perform the triggered action at most once in this interval of seconds action: oneOf: @@ -6188,11 +6365,13 @@ components: - $ref: "#/components/schemas/TraceScope" - $ref: "#/components/schemas/GroupScope" - type: "null" - description: Execution scope for export automation. Defaults to span-level + description: + Execution scope for export automation. Defaults to span-level execution. export_path: type: string - description: The path to export the results to. It should include the storage + description: + The path to export the results to. It should include the storage protocol and prefix, e.g. s3://bucket-name/path/to/export format: type: string @@ -6204,7 +6383,8 @@ components: type: number minimum: 1 maximum: 2592000 - description: Perform the triggered action at most once in this interval of + description: + Perform the triggered action at most once in this interval of seconds credentials: oneOf: @@ -6219,7 +6399,8 @@ components: description: The ARN of the IAM role to use external_id: type: string - description: The automation-specific external id component (auto-generated by + description: + The automation-specific external id component (auto-generated by default) required: - type @@ -6237,7 +6418,8 @@ components: credential_name: type: string minLength: 1 - description: The name of a Google workload identity federation credential + description: + The name of a Google workload identity federation credential configured in this organization's AI providers. Supported data planes can use it regardless of hosting environment. If omitted, the data plane's @@ -6435,7 +6617,8 @@ components: project_id: type: string format: uuid - description: Unique identifier for the project that the project automation + description: + Unique identifier for the project that the project automation belongs under name: type: string @@ -6463,7 +6646,8 @@ components: type: number minimum: 1 maximum: 2592000 - description: Perform the triggered action at most once in this interval of + description: + Perform the triggered action at most once in this interval of seconds action: oneOf: @@ -6589,11 +6773,13 @@ components: - $ref: "#/components/schemas/TraceScope" - $ref: "#/components/schemas/GroupScope" - type: "null" - description: Execution scope for export automation. Defaults to span-level + description: + Execution scope for export automation. Defaults to span-level execution. export_path: type: string - description: The path to export the results to. It should include the storage + description: + The path to export the results to. It should include the storage protocol and prefix, e.g. s3://bucket-name/path/to/export format: type: string @@ -6605,7 +6791,8 @@ components: type: number minimum: 1 maximum: 2592000 - description: Perform the triggered action at most once in this interval of + description: + Perform the triggered action at most once in this interval of seconds credentials: oneOf: @@ -6620,7 +6807,8 @@ components: description: The ARN of the IAM role to use external_id: type: string - description: The automation-specific external id component (auto-generated by + description: + The automation-specific external id component (auto-generated by default) required: - type @@ -6638,7 +6826,8 @@ components: credential_name: type: string minLength: 1 - description: The name of a Google workload identity federation credential + description: + The name of a Google workload identity federation credential configured in this organization's AI providers. Supported data planes can use it regardless of hosting environment. If omitted, the data plane's @@ -6850,7 +7039,8 @@ components: type: number minimum: 1 maximum: 2592000 - description: Perform the triggered action at most once in this interval of + description: + Perform the triggered action at most once in this interval of seconds action: oneOf: @@ -6976,11 +7166,13 @@ components: - $ref: "#/components/schemas/TraceScope" - $ref: "#/components/schemas/GroupScope" - type: "null" - description: Execution scope for export automation. Defaults to span-level + description: + Execution scope for export automation. Defaults to span-level execution. export_path: type: string - description: The path to export the results to. It should include the storage + description: + The path to export the results to. It should include the storage protocol and prefix, e.g. s3://bucket-name/path/to/export format: type: string @@ -6992,7 +7184,8 @@ components: type: number minimum: 1 maximum: 2592000 - description: Perform the triggered action at most once in this interval of + description: + Perform the triggered action at most once in this interval of seconds credentials: oneOf: @@ -7007,7 +7200,8 @@ components: description: The ARN of the IAM role to use external_id: type: string - description: The automation-specific external id component (auto-generated by + description: + The automation-specific external id component (auto-generated by default) required: - type @@ -7025,7 +7219,8 @@ components: credential_name: type: string minLength: 1 - description: The name of a Google workload identity federation credential + description: + The name of a Google workload identity federation credential configured in this organization's AI providers. Supported data planes can use it regardless of hosting environment. If omitted, the data plane's @@ -7213,7 +7408,8 @@ components: org_id: type: string format: uuid - description: Unique identifier for the organization that the org automation + description: + Unique identifier for the organization that the org automation belongs under user_id: type: @@ -7265,7 +7461,8 @@ components: org_id: type: string format: uuid - description: Unique identifier for the organization that the org automation + description: + Unique identifier for the organization that the org automation belongs under name: type: string @@ -7410,7 +7607,8 @@ components: - type - name title: global - description: The list of functions to run for online scoring. Can include + description: + The list of functions to run for online scoring. Can include scorers, facets, or other function types. btql_filter: type: @@ -7421,7 +7619,8 @@ components: type: - boolean - "null" - description: Whether to trigger online scoring on the root span of each trace. + description: + Whether to trigger online scoring on the root span of each trace. Only applies when scope is 'span' or unset. apply_to_span_names: type: @@ -7429,7 +7628,8 @@ components: - "null" items: type: string - description: Trigger online scoring on any spans with a name in this list. Only + description: + Trigger online scoring on any spans with a name in this list. Only applies when scope is 'span' or unset. skip_logging: type: @@ -7442,7 +7642,8 @@ components: - $ref: "#/components/schemas/TraceScope" - $ref: "#/components/schemas/GroupScope" - type: "null" - description: The scope at which to run the functions. Defaults to span-level + description: + The scope at which to run the functions. Defaults to span-level execution. required: - sampling_rate @@ -7534,7 +7735,8 @@ components: project_id: type: string format: uuid - description: Unique identifier for the project that the project score belongs + description: + Unique identifier for the project that the project score belongs under user_id: type: string @@ -7563,7 +7765,8 @@ components: type: - string - "null" - description: An optional LexoRank-based string that sets the sort position for + description: + An optional LexoRank-based string that sets the sort position for the score in the UI required: - id @@ -7579,7 +7782,8 @@ components: project_id: type: string format: uuid - description: Unique identifier for the project that the project score belongs + description: + Unique identifier for the project that the project score belongs under name: type: string @@ -7661,14 +7865,16 @@ components: type: - string - "null" - description: An optional LexoRank-based string that sets the sort position for + description: + An optional LexoRank-based string that sets the sort position for the tag in the UI required: - id - project_id - user_id - name - description: A project tag is a user-configured tag for tracking and filtering + description: + A project tag is a user-configured tag for tracking and filtering your experiments, logs, and other data CreateProjectTag: type: object @@ -7739,7 +7945,8 @@ components: - string - "null" format: date-time - description: Date of span iframe deletion, or null if the span iframe is still + description: + Date of span iframe deletion, or null if the span iframe is still active name: type: string @@ -7756,7 +7963,8 @@ components: type: - boolean - "null" - description: Whether to post messages to the iframe containing the span's data. + description: + Whether to post messages to the iframe containing the span's data. This is useful when you want to render more data than fits in the URL. required: @@ -7786,7 +7994,8 @@ components: type: - boolean - "null" - description: Whether to post messages to the iframe containing the span's data. + description: + Whether to post messages to the iframe containing the span's data. This is useful when you want to render more data than fits in the URL. required: @@ -7810,7 +8019,8 @@ components: type: - boolean - "null" - description: Whether to post messages to the iframe containing the span's data. + description: + Whether to post messages to the iframe containing the span's data. This is useful when you want to render more data than fits in the URL. description: @@ -8336,7 +8546,8 @@ components: code: type: string minLength: 1 - description: The complete JavaScript preprocessor implementation, including its + description: + The complete JavaScript preprocessor implementation, including its handler. required: - type @@ -8357,7 +8568,8 @@ components: $ref: "#/components/schemas/FacetPreprocessorId" prompt: type: string - description: The prompt to use for LLM extraction. The preprocessed text will be + description: + The prompt to use for LLM extraction. The preprocessed text will be provided as context. model: type: string @@ -8367,7 +8579,8 @@ components: description: The embedding model to use for vectorizing facet results. no_match_pattern: type: string - description: Regex pattern to identify outputs that do not match the facet. If + description: + Regex pattern to identify outputs that do not match the facet. If the output matches, the facet will be saved as 'no_match' required: - type @@ -8418,7 +8631,8 @@ components: - topic_map source_facet: type: string - description: Materialized facet field name used when source_facet_function is + description: + Materialized facet field name used when source_facet_function is absent source_facet_function: allOf: @@ -8472,14 +8686,16 @@ components: $ref: "#/components/schemas/TopicMapGenerationSettings" disable_reconciliation: type: boolean - description: Whether new topic generation should ignore the previously saved + description: + Whether new topic generation should ignore the previously saved report during reconciliation. Defaults to false when omitted. reconcile_mode: type: string enum: - evolve - names_only - description: 'How reconciliation carries the previous map forward: "evolve" + description: + 'How reconciliation carries the previous map forward: "evolve" re-routes new samples into the previous topics before naming; "names_only" keeps the fresh clustering and carries only topic ids/names. Defaults to "names_only" when omitted.' @@ -8488,11 +8704,13 @@ components: description: Maximum distance to nearest centroid. If exceeded, returns no_match. btql_filter: type: string - description: Per-topic-map BTQL filter that was applied when this version was + description: + Per-topic-map BTQL filter that was applied when this version was generated. Absent on versions generated before this was recorded. automation_btql_filter: type: string - description: Automation-level BTQL filter that was applied when this version was + description: + Automation-level BTQL filter that was applied when this version was generated. Absent on versions generated before this was recorded. required: - type @@ -8517,7 +8735,8 @@ components: description: The name of the facet prompt: type: string - description: The prompt to use for LLM extraction. The preprocessed text will be + description: + The prompt to use for LLM extraction. The preprocessed text will be provided as context. model: type: string @@ -8527,7 +8746,8 @@ components: description: The embedding model to use for vectorizing facet results. no_match_pattern: type: string - description: Regex pattern to identify outputs that do not match the facet. If + description: + Regex pattern to identify outputs that do not match the facet. If the output matches, the facet will be saved as 'no_match' required: - name @@ -8550,7 +8770,8 @@ components: required: - function_name - topic_map_data - description: Topic maps that depend on facets in this batch, keyed by source + description: + Topic maps that depend on facets in this batch, keyed by source facet name. Each source facet can have multiple topic maps. required: - type @@ -8662,7 +8883,8 @@ components: - object - "null" additionalProperties: {} - description: Configuration options to pass to the global function (e.g., for + description: + Configuration options to pass to the global function (e.g., for preprocessor customization) required: - type @@ -8847,7 +9069,8 @@ components: cwd: type: string pattern: ^(?:\/|[A-Za-z]:[\\/]|\\\\) - description: Absolute working directory for the ACP session on the execution + description: + Absolute working directory for the ACP session on the execution host permissions: type: string @@ -8868,7 +9091,8 @@ components: - type - config additionalProperties: false - description: A task function that runs a conversation between an agent and a + description: + A task function that runs a conversation between an agent and a simulated user. title: simulation Function: @@ -8880,7 +9104,8 @@ components: description: Unique identifier for the prompt _xact_id: type: string - description: The transaction id of an event is unique to the network operation + description: + The transaction id of an event is unique to the network operation that processed the event insertion. Transaction ids are monotonically increasing over time and can be used to retrieve a versioned snapshot of the prompt (see the `version` parameter) @@ -8948,7 +9173,8 @@ components: type: - boolean - "null" - description: The function exists for internal purposes and should not be + description: + The function exists for internal purposes and should not be displayed in the list of functions. required: - object_type @@ -9018,7 +9244,8 @@ components: type: - boolean - "null" - description: The function exists for internal purposes and should not be + description: + The function exists for internal purposes and should not be displayed in the list of functions. required: - object_type @@ -9142,7 +9369,8 @@ components: - object - "null" additionalProperties: {} - description: Configuration options to pass to the global function (e.g., for + description: + Configuration options to pass to the global function (e.g., for preprocessor customization) required: - type @@ -9327,7 +9555,8 @@ components: cwd: type: string pattern: ^(?:\/|[A-Za-z]:[\\/]|\\\\) - description: Absolute working directory for the ACP session on the execution + description: + Absolute working directory for the ACP session on the execution host permissions: type: string @@ -9348,7 +9577,8 @@ components: - type - config additionalProperties: false - description: A task function that runs a conversation between an agent and a + description: + A task function that runs a conversation between an agent and a simulated user. title: simulation - type: "null" @@ -9420,7 +9650,8 @@ components: description: Span parent properties title: span_parent_struct - type: string - description: The parent's span identifier, created by calling `.export()` on a + description: + The parent's span identifier, created by calling `.export()` on a span description: Options for tracing the function call StreamingMode: @@ -9448,7 +9679,8 @@ components: - object - "null" additionalProperties: {} - description: Any relevant metadata. This will be logged and available as the + description: + Any relevant metadata. This will be logged and available as the `metadata` argument. tags: type: @@ -9468,7 +9700,8 @@ components: type: - boolean - "null" - description: Whether to stream the response. If true, results will be returned + description: + Whether to stream the response. If true, results will be returned in the Braintrust SSE format. mode: $ref: "#/components/schemas/StreamingMode" @@ -9476,7 +9709,8 @@ components: type: - boolean - "null" - description: If true, throw an error if one of the variables in the prompt is + description: + If true, throw an error if one of the variables in the prompt is not present in the input mcp_auth: type: object @@ -9492,7 +9726,8 @@ components: - object - "null" additionalProperties: {} - description: "Partial function definition to merge with the function being + description: + "Partial function definition to merge with the function being invoked. Fields are validated against the function type's schema at runtime. For facets: { preprocessor?, prompt?, model? }. For prompts: { model?, ... }." @@ -10014,7 +10249,8 @@ components: - click_to_load - blocked - null - description: "Controls how images are rendered in the UI: 'auto' loads images + description: + "Controls how images are rendered in the UI: 'auto' loads images automatically, 'click_to_load' shows a placeholder until clicked, 'blocked' prevents image loading entirely" Organization: @@ -10112,7 +10348,8 @@ components: type: - string - "null" - description: If invite emails failed to send for some reason, the patch + description: + If invite emails failed to send for some reason, the patch operation will still complete, but we will return an error message here added_users: @@ -10139,7 +10376,8 @@ components: - "null" required: - id - description: The users who were added by this request. api_key and token_name + description: + The users who were added by this request. api_key and token_name are only present for the inline service-account create-and-mint compatibility path. required: @@ -10182,7 +10420,8 @@ components: type: - string - "null" - description: Optional name of an initial service token to create for the new + description: + Optional name of an initial service token to create for the new service account. When set, authenticate with a UI session or service token, not a user API key. The caller must own the organization or the project group specified by @@ -10192,11 +10431,13 @@ components: - integer - "null" exclusiveMinimum: 0 - description: Number of seconds from now after which the initial service token + description: + Number of seconds from now after which the initial service token should expire. If omitted, the token never expires. required: - name - description: Service accounts to create. PATCH /v1/organization/members is the + description: + Service accounts to create. PATCH /v1/organization/members is the compatibility layer that accepts both plain service-account creation and the narrower token_name create-and-mint carve-out. send_invite_emails: @@ -10237,7 +10478,8 @@ components: - string - "null" format: uuid - description: Grants new service accounts read access to this project group. + description: + Grants new service accounts read access to this project group. Required when a project-group Owner creates service accounts. description: Users to invite to the organization remove_users: @@ -10266,7 +10508,8 @@ components: type: - string - "null" - description: For nearly all users, this parameter should be unnecessary. But in + description: + For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, or in case you want to explicitly assert the organization you are modifying, you may specify the name of the organization. @@ -10274,7 +10517,8 @@ components: type: - string - "null" - description: For nearly all users, this parameter should be unnecessary. But in + description: + For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, or in case you want to explicitly assert the organization you are modifying, you may specify the id of the organization. @@ -10378,7 +10622,8 @@ components: - string - "null" format: date-time - description: Date and time at which the service token expires. If null, the + description: + Date and time at which the service token expires. If null, the token never expires. key: type: string @@ -10433,7 +10678,8 @@ components: - string - "null" format: date-time - description: Date and time at which the service token expires. If null, the + description: + Date and time at which the service token expires. If null, the token never expires. required: - id @@ -10522,13 +10768,15 @@ components: type: - string - "null" - description: Secret value. If omitted in a PUT request, the existing secret + description: + Secret value. If omitted in a PUT request, the existing secret value will be left intact, not replaced with null. org_name: type: - string - "null" - description: For nearly all users, this parameter should be unnecessary. But in + description: + For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the AI Secret belongs in. @@ -10544,7 +10792,8 @@ components: type: - string - "null" - description: For nearly all users, this parameter should be unnecessary. But in + description: + For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the AI Secret belongs in. @@ -10622,7 +10871,8 @@ components: - object - "null" additionalProperties: {} - description: Optional metadata associated with the environment variable when + description: + Optional metadata associated with the environment variable when managed via the function secrets API preview_secret: type: @@ -10633,7 +10883,8 @@ components: type: - string - "null" - description: Optional classification for the secret (for example, the AI + description: + Optional classification for the secret (for example, the AI provider name) secret_category: type: string @@ -10643,7 +10894,8 @@ components: - sandbox_provider - automation_integration default: env_var - description: "The category of the secret: env_var for regular environment + description: + "The category of the secret: env_var for regular environment variables, ai_provider for AI provider API keys" required: - id @@ -10678,7 +10930,8 @@ components: - string - "null" format: date-time - description: Date of MCP server deletion, or null if the MCP server is still + description: + Date of MCP server deletion, or null if the MCP server is still active name: type: string @@ -10807,122 +11060,6 @@ components: - string - "null" description: Textual description of the dataset snapshot - SimulatedUserVoiceConfig: - type: object - properties: - voice_id: - type: string - format: uuid - language: - type: string - minLength: 1 - accent: - type: string - minLength: 1 - speaking_rate: - type: number - exclusiveMinimum: 0 - required: - - voice_id - additionalProperties: false - SimulatedUser: - type: object - properties: - id: - type: string - format: uuid - description: Unique identifier for the simulated user - _xact_id: - type: string - description: Legacy transaction id. Not returned by simulated user CRUD. - project_id: - type: string - format: uuid - description: Unique identifier for the project that the simulated user belongs - under - org_id: - type: string - format: uuid - description: Unique identifier for the organization - name: - type: string - minLength: 1 - description: Name of the simulated user - created: - type: - - string - - "null" - format: date-time - description: Date of simulated user creation - instructions: - type: string - minLength: 1 - description: The simulated user's role, scenario, and behavior - goal: - type: string - minLength: 1 - description: The simulated user's objective, used to decide when to end the - conversation - voice_config: - $ref: "#/components/schemas/SimulatedUserVoiceConfig" - required: - - id - - project_id - - org_id - - name - - instructions - - voice_config - AppLimit: - type: - - integer - - "null" - minimum: 0 - maximum: 1000 - default: 100 - description: Limit the number of objects to return - CreateSimulatedUser: - type: object - properties: - name: - type: string - minLength: 1 - description: Name of the simulated user - instructions: - type: string - minLength: 1 - description: The simulated user's role, scenario, and behavior - goal: - type: string - minLength: 1 - description: The simulated user's objective, used to decide when to end the - conversation - voice_config: - $ref: "#/components/schemas/SimulatedUserVoiceConfig" - required: - - name - - instructions - - voice_config - additionalProperties: false - PatchSimulatedUser: - type: object - properties: - name: - type: string - minLength: 1 - description: Name of the simulated user - instructions: - type: string - minLength: 1 - description: The simulated user's role, scenario, and behavior - goal: - type: - - string - - "null" - minLength: 1 - description: The simulated user's objective. Set to null to clear it. - voice_config: - $ref: "#/components/schemas/SimulatedUserVoiceConfig" - additionalProperties: false Environment: type: object properties: @@ -10933,14 +11070,16 @@ components: org_id: type: string format: uuid - description: Unique identifier for the organization that the environment belongs + description: + Unique identifier for the organization that the environment belongs under name: type: string description: Name of the environment slug: type: string - description: A url-friendly, unique identifier for the environment within an + description: + A url-friendly, unique identifier for the environment within an organization description: type: @@ -10958,7 +11097,8 @@ components: - string - "null" format: date-time - description: Date of environment deletion, or null if the environment is still + description: + Date of environment deletion, or null if the environment is still active required: - id @@ -10973,7 +11113,8 @@ components: description: Name of the environment slug: type: string - description: A url-friendly, unique identifier for the environment within an + description: + A url-friendly, unique identifier for the environment within an organization description: type: @@ -10984,7 +11125,8 @@ components: type: - string - "null" - description: For nearly all users, this parameter should be unnecessary. But in + description: + For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the environment belongs in. @@ -11003,7 +11145,8 @@ components: type: - string - "null" - description: A url-friendly, unique identifier for the environment within an + description: + A url-friendly, unique identifier for the environment within an organization description: type: @@ -11058,7 +11201,8 @@ components: items: $ref: "#/components/schemas/FeedbackExperimentItem" description: A list of experiment feedback items - description: A mapping from experiment id to a set of log events and feedback + description: + A mapping from experiment id to a set of log events and feedback items to insert dataset: type: @@ -11081,7 +11225,8 @@ components: items: $ref: "#/components/schemas/FeedbackDatasetItem" description: A list of dataset feedback items - description: A mapping from dataset id to a set of log events and feedback items + description: + A mapping from dataset id to a set of log events and feedback items to insert project_logs: type: @@ -11104,7 +11249,8 @@ components: items: $ref: "#/components/schemas/FeedbackProjectLogsItem" description: A list of project logs feedback items - description: A mapping from project id to a set of log events and feedback items + description: + A mapping from project id to a set of log events and feedback items to insert PromptData: type: object @@ -11257,7 +11403,8 @@ components: properties: global_function: type: string - description: The name of the global function. Currently, the global namespace + description: + The name of the global function. Currently, the global namespace includes the functions in autoevals function_type: $ref: "#/components/schemas/FunctionTypeEnum" @@ -11304,7 +11451,8 @@ components: function_type: allOf: - $ref: "#/components/schemas/FunctionTypeEnum" - - description: The function type for inline code. Required when invoking inline + - description: + The function type for inline code. Required when invoking inline preprocessors. name: type: @@ -11378,7 +11526,8 @@ components: required: - collect additionalProperties: false - description: Optional settings for collecting git metadata. By default, will + description: + Optional settings for collecting git metadata. By default, will collect git metadata fields allowed in org-level settings, excluding diff content unless the org opts in. RunEval: @@ -11402,7 +11551,8 @@ components: type: - string - "null" - description: The environment tag that resolves to the dataset version to + description: + The environment tag that resolves to the dataset version to evaluate _internal_btql: type: @@ -11428,7 +11578,8 @@ components: type: - string - "null" - description: The environment tag that resolves to the dataset version to + description: + The environment tag that resolves to the dataset version to evaluate _internal_btql: type: @@ -11447,7 +11598,8 @@ components: items: {} source_dataset_id: type: string - description: The saved dataset these rows came from. Its project scopes saved + description: + The saved dataset these rows came from. Its project scopes saved simulated-user references; the caller must have read access to the dataset and source project. required: @@ -11460,7 +11612,8 @@ components: type: string required: - experiment_name - description: Experiment whose inputs and outputs should be used as dataset + description: + Experiment whose inputs and outputs should be used as dataset inputs and expected values title: experiment_name description: The dataset to use @@ -11482,13 +11635,15 @@ components: description: The functions to score the eval on experiment_name: type: string - description: An optional name for the experiment created by this eval. If it + description: + An optional name for the experiment created by this eval. If it conflicts with an existing experiment, it will be suffixed with a unique identifier. metadata: type: object additionalProperties: {} - description: Optional experiment-level metadata to store about the evaluation. + description: + Optional experiment-level metadata to store about the evaluation. You can later use this to slice & dice across experiments. parent: allOf: @@ -11496,7 +11651,8 @@ components: - description: Options for tracing the evaluation stream: type: boolean - description: "Whether to stream the results of the eval. If true, the request + description: + "Whether to stream the results of the eval. If true, the request will return two events: one to indicate the experiment has started, and another upon completion. If false, the request will return the evaluation's summary upon completion." @@ -11504,7 +11660,8 @@ components: type: - number - "null" - description: The number of times to run the evaluator per input. This is useful + description: + The number of times to run the evaluator per input. This is useful for evaluating applications that have non-deterministic behavior and gives you both a stronger aggregate measure and a sense of the variance in the results. @@ -11517,40 +11674,46 @@ components: type: - number - "null" - description: The maximum duration, in milliseconds, to run the evaluation. There + description: + The maximum duration, in milliseconds, to run the evaluation. There is no timeout by default. max_concurrency: type: - number - "null" default: 10 - description: The maximum number of tasks/scorers that will be run concurrently. + description: + The maximum number of tasks/scorers that will be run concurrently. Defaults to 10. If null is provided, no max concurrency will be used. base_experiment_name: type: - string - "null" - description: An optional experiment name to use as a base. If specified, the new + description: + An optional experiment name to use as a base. If specified, the new experiment will be summarized and compared to this experiment. base_experiment_id: type: - string - "null" - description: An optional experiment id to use as a base. If specified, the new + description: + An optional experiment id to use as a base. If specified, the new experiment will be summarized and compared to this experiment. git_metadata_settings: $ref: "#/components/schemas/GitMetadataSettings" repo_info: allOf: - $ref: "#/components/schemas/RepoInfo" - - description: Optionally explicitly specify the git metadata for this experiment. + - description: + Optionally explicitly specify the git metadata for this experiment. This takes precedence over `gitMetadataSettings` if specified. strict: type: - boolean - "null" - description: If true, throw an error if one of the variables in the prompt is + description: + If true, throw an error if one of the variables in the prompt is not present in the input stop_token: type: @@ -11559,7 +11722,8 @@ components: description: The token to stop the run extra_messages: type: string - description: A template path of extra messages to append to the conversion. + description: + A template path of extra messages to append to the conversion. These messages will be appended to the end of the conversation, after the last message. tags: @@ -11980,7 +12144,8 @@ components: schema: $ref: "#/components/schemas/Ids" required: false - description: Filter search results to a particular set of object IDs. To specify + description: + Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times name: ids in: query @@ -12134,7 +12299,8 @@ components: schema: $ref: "#/components/schemas/SummarizeScores" required: false - description: Whether to summarize the scores and metrics. If false (or omitted), + description: + Whether to summarize the scores and metrics. If false (or omitted), only the metadata will be returned. name: summarize_scores in: query @@ -12152,7 +12318,8 @@ components: schema: $ref: "#/components/schemas/SummarizeData" required: false - description: Whether to summarize the data. If false (or omitted), only the + description: + Whether to summarize the data. If false (or omitted), only the metadata will be returned. name: summarize_data in: query @@ -12193,7 +12360,8 @@ components: schema: $ref: "#/components/schemas/UserEmail" required: false - description: Email of the user to search for. You may pass the param multiple + description: + Email of the user to search for. You may pass the param multiple times to filter for more than one email name: email in: query @@ -12230,7 +12398,8 @@ components: schema: $ref: "#/components/schemas/AclListUserId" required: false - description: Id of the user the ACL applies to. Exactly one of `user_id` and + description: + Id of the user the ACL applies to. Exactly one of `user_id` and `group_id` will be provided name: user_id in: query @@ -12238,7 +12407,8 @@ components: schema: $ref: "#/components/schemas/AclListGroupId" required: false - description: Id of the group the ACL applies to. Exactly one of `user_id` and + description: + Id of the group the ACL applies to. Exactly one of `user_id` and `group_id` will be provided name: group_id in: query @@ -12266,7 +12436,8 @@ components: schema: $ref: "#/components/schemas/AclListRoleId" required: false - description: Id of the role the ACL grants. Exactly one of `permission` and + description: + Id of the role the ACL grants. Exactly one of `permission` and `role_id` will be provided name: role_id in: query @@ -12311,7 +12482,8 @@ paths: - bearerAuth: [] - {} operationId: postProject - description: Create a new project. If there is an existing project with the same + description: + Create a new project. If there is an existing project with the same name as the one specified in the request, will return the existing project unmodified summary: Create project @@ -12330,7 +12502,8 @@ paths: schema: $ref: "#/components/schemas/Project" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -12355,7 +12528,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -12379,7 +12553,8 @@ paths: operationId: getProject tags: - Projects - description: List out all projects. The projects are sorted by creation date, + description: + List out all projects. The projects are sorted by creation date, with the most recently-created projects coming first summary: List projects security: @@ -12409,7 +12584,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -12434,7 +12610,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -12474,7 +12651,8 @@ paths: schema: $ref: "#/components/schemas/Project" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -12499,7 +12677,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -12523,7 +12702,8 @@ paths: operationId: patchProjectId tags: - Projects - description: Partially update a project object. Specify the fields to update in + description: + Partially update a project 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. @@ -12548,7 +12728,8 @@ paths: schema: $ref: "#/components/schemas/Project" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -12573,7 +12754,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -12612,7 +12794,8 @@ paths: schema: $ref: "#/components/schemas/Project" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -12637,7 +12820,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -12684,7 +12868,8 @@ paths: schema: $ref: "#/components/schemas/InsertEventsResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -12709,7 +12894,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -12734,7 +12920,8 @@ paths: operationId: postProjectLogsIdFetch tags: - Logs - description: Fetch the events in a project logs. Equivalent to the GET form of + description: + Fetch the events in a project logs. Equivalent to the GET form of the same path, but with the parameters in the request body rather than in the URL query. For more complex queries, use the `POST /btql` endpoint. @@ -12759,7 +12946,8 @@ paths: schema: $ref: "#/components/schemas/FetchProjectLogsEventsResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -12784,7 +12972,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -12808,7 +12997,8 @@ paths: operationId: getProjectLogsIdFetch tags: - Logs - description: Fetch the events in a project logs. Equivalent to the POST form of + description: + Fetch the events in a project logs. Equivalent to the POST form of the same path, but with the parameters in the URL query rather than in the request body. For more complex queries, use the `POST /btql` endpoint. @@ -12830,7 +13020,8 @@ paths: schema: $ref: "#/components/schemas/FetchProjectLogsEventsResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -12855,7 +13046,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -12902,7 +13094,8 @@ paths: schema: $ref: "#/components/schemas/FeedbackResponseSchema" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -12927,7 +13120,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -12955,7 +13149,8 @@ paths: - bearerAuth: [] - {} operationId: postExperiment - description: Create a new experiment. If there is an existing experiment in the + description: + Create a new experiment. If there is an existing experiment in the project with the same name as the one specified in the request, will return the existing experiment unmodified summary: Create experiment @@ -12974,7 +13169,8 @@ paths: schema: $ref: "#/components/schemas/Experiment" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -12999,7 +13195,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13023,7 +13220,8 @@ paths: operationId: getExperiment tags: - Experiments - description: List out all experiments. The experiments are sorted by creation + description: + List out all experiments. The experiments are sorted by creation date, with the most recently-created experiments coming first summary: List experiments security: @@ -13055,7 +13253,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13080,7 +13279,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13120,7 +13320,8 @@ paths: schema: $ref: "#/components/schemas/Experiment" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13145,7 +13346,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13169,7 +13371,8 @@ paths: operationId: patchExperimentId tags: - Experiments - description: Partially update an experiment object. Specify the fields to update + description: + Partially update an experiment 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. @@ -13194,7 +13397,8 @@ paths: schema: $ref: "#/components/schemas/Experiment" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13219,7 +13423,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13258,7 +13463,8 @@ paths: schema: $ref: "#/components/schemas/Experiment" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13283,7 +13489,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13330,7 +13537,8 @@ paths: schema: $ref: "#/components/schemas/InsertEventsResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13355,7 +13563,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13380,7 +13589,8 @@ paths: operationId: postExperimentIdFetch tags: - Experiments - description: Fetch the events in an experiment. Equivalent to the GET form of + description: + Fetch the events in an experiment. Equivalent to the GET form of the same path, but with the parameters in the request body rather than in the URL query. For more complex queries, use the `POST /btql` endpoint. @@ -13405,7 +13615,8 @@ paths: schema: $ref: "#/components/schemas/FetchExperimentEventsResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13430,7 +13641,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13454,7 +13666,8 @@ paths: operationId: getExperimentIdFetch tags: - Experiments - description: Fetch the events in an experiment. Equivalent to the POST form of + description: + Fetch the events in an experiment. Equivalent to the POST form of the same path, but with the parameters in the URL query rather than in the request body. For more complex queries, use the `POST /btql` endpoint. @@ -13476,7 +13689,8 @@ paths: schema: $ref: "#/components/schemas/FetchExperimentEventsResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13501,7 +13715,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13548,7 +13763,8 @@ paths: schema: $ref: "#/components/schemas/FeedbackResponseSchema" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13573,7 +13789,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13619,7 +13836,8 @@ paths: schema: $ref: "#/components/schemas/SummarizeExperimentResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13644,7 +13862,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13691,7 +13910,8 @@ paths: schema: $ref: "#/components/schemas/Dataset" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13716,7 +13936,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13740,7 +13961,8 @@ paths: operationId: getDataset tags: - Datasets - description: List out all datasets. The datasets are sorted by creation date, + description: + List out all datasets. The datasets are sorted by creation date, with the most recently-created datasets coming first summary: List datasets security: @@ -13772,7 +13994,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13797,7 +14020,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13837,7 +14061,8 @@ paths: schema: $ref: "#/components/schemas/Dataset" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13862,7 +14087,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13886,7 +14112,8 @@ paths: operationId: patchDatasetId tags: - Datasets - description: Partially update a dataset object. Specify the fields to update in + description: + Partially update a dataset 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. @@ -13911,7 +14138,8 @@ paths: schema: $ref: "#/components/schemas/Dataset" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -13936,7 +14164,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -13975,7 +14204,8 @@ paths: schema: $ref: "#/components/schemas/Dataset" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14000,7 +14230,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14047,7 +14278,8 @@ paths: schema: $ref: "#/components/schemas/InsertEventsResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14072,7 +14304,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14097,7 +14330,8 @@ paths: operationId: postDatasetIdFetch tags: - Datasets - description: Fetch the events in a dataset. Equivalent to the GET form of the + description: + Fetch the events in a dataset. Equivalent to the GET form of the same path, but with the parameters in the request body rather than in the URL query. For more complex queries, use the `POST /btql` endpoint. summary: Fetch dataset (POST form) @@ -14121,7 +14355,8 @@ paths: schema: $ref: "#/components/schemas/FetchDatasetEventsResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14146,7 +14381,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14170,7 +14406,8 @@ paths: operationId: getDatasetIdFetch tags: - Datasets - description: Fetch the events in a dataset. Equivalent to the POST form of the + description: + Fetch the events in a dataset. Equivalent to the POST form of the same path, but with the parameters in the URL query rather than in the request body. For more complex queries, use the `POST /btql` endpoint. summary: Fetch dataset (GET form) @@ -14191,7 +14428,8 @@ paths: schema: $ref: "#/components/schemas/FetchDatasetEventsResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14216,7 +14454,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14263,7 +14502,8 @@ paths: schema: $ref: "#/components/schemas/FeedbackResponseSchema" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14288,7 +14528,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14330,7 +14571,8 @@ paths: schema: $ref: "#/components/schemas/SummarizeDatasetResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14355,7 +14597,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14404,7 +14647,8 @@ paths: schema: $ref: "#/components/schemas/DatasetRestorePreviewResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14429,7 +14673,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14479,7 +14724,8 @@ paths: schema: $ref: "#/components/schemas/DatasetRestoreResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14504,7 +14750,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14532,7 +14779,8 @@ paths: - bearerAuth: [] - {} operationId: postPrompt - description: Create a new prompt. If there is an existing prompt in the project + description: + Create a new prompt. If there is an existing prompt in the project with the same slug as the one specified in the request, a new version of the prompt will be appended and returned summary: Create prompt @@ -14551,7 +14799,8 @@ paths: schema: $ref: "#/components/schemas/Prompt" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14576,7 +14825,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14603,7 +14853,8 @@ paths: - bearerAuth: [] - {} operationId: putPrompt - description: Create or replace prompt. If there is an existing prompt in the + description: + Create or replace prompt. If there is an existing prompt in the project with the same slug as the one specified in the request, a new version of the prompt will be appended and returned summary: Create or replace prompt @@ -14622,7 +14873,8 @@ paths: schema: $ref: "#/components/schemas/Prompt" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14647,7 +14899,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14671,7 +14924,8 @@ paths: operationId: getPrompt tags: - Prompts - description: List out all prompts. The prompts are sorted by creation date, with + description: + List out all prompts. The prompts are sorted by creation date, with the most recently-created prompts coming first summary: List prompts security: @@ -14706,7 +14960,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14731,7 +14986,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14773,7 +15029,8 @@ paths: schema: $ref: "#/components/schemas/Prompt" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14798,7 +15055,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14822,7 +15080,8 @@ paths: operationId: patchPromptId tags: - Prompts - description: Partially update a prompt object. Specify the fields to update in + description: + 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. @@ -14847,7 +15106,8 @@ paths: schema: $ref: "#/components/schemas/Prompt" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14872,7 +15132,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14911,7 +15172,8 @@ paths: schema: $ref: "#/components/schemas/Prompt" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -14936,7 +15198,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -14964,7 +15227,8 @@ paths: - bearerAuth: [] - {} operationId: postRole - description: Create a new role. If there is an existing role with the same name + description: + Create a new role. If there is an existing role with the same name as the one specified in the request, will return the existing role unmodified summary: Create role @@ -14983,7 +15247,8 @@ paths: schema: $ref: "#/components/schemas/Role" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15008,7 +15273,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15035,7 +15301,8 @@ paths: - bearerAuth: [] - {} operationId: putRole - description: Create or replace role. If there is an existing role with the same + description: + Create or replace role. If there is an existing role with the same name as the one specified in the request, will replace the existing role with the provided fields summary: Create or replace role @@ -15054,7 +15321,8 @@ paths: schema: $ref: "#/components/schemas/Role" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15079,7 +15347,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15103,7 +15372,8 @@ paths: operationId: getRole tags: - Roles - description: List out all roles. The roles are sorted by creation date, with the + description: + List out all roles. The roles are sorted by creation date, with the most recently-created roles coming first summary: List roles security: @@ -15133,7 +15403,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15158,7 +15429,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15198,7 +15470,8 @@ paths: schema: $ref: "#/components/schemas/Role" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15223,7 +15496,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15247,7 +15521,8 @@ paths: operationId: patchRoleId tags: - Roles - description: Partially update a role object. Specify the fields to update in the + description: + Partially update a role 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. @@ -15272,7 +15547,8 @@ paths: schema: $ref: "#/components/schemas/Role" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15297,7 +15573,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15336,7 +15613,8 @@ paths: schema: $ref: "#/components/schemas/Role" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15361,7 +15639,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15389,7 +15668,8 @@ paths: - bearerAuth: [] - {} operationId: postGroup - description: Create a new group. If there is an existing group with the same + description: + Create a new group. If there is an existing group with the same name as the one specified in the request, will return the existing group unmodified summary: Create group @@ -15408,7 +15688,8 @@ paths: schema: $ref: "#/components/schemas/Group" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15433,7 +15714,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15460,7 +15742,8 @@ paths: - bearerAuth: [] - {} operationId: putGroup - description: Create or replace group. If there is an existing group with the + description: + Create or replace group. If there is an existing group with the same name as the one specified in the request, will replace the existing group with the provided fields summary: Create or replace group @@ -15479,7 +15762,8 @@ paths: schema: $ref: "#/components/schemas/Group" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15504,7 +15788,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15528,7 +15813,8 @@ paths: operationId: getGroup tags: - Groups - description: List out all groups. The groups are sorted by creation date, with + description: + List out all groups. The groups are sorted by creation date, with the most recently-created groups coming first summary: List groups security: @@ -15558,7 +15844,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15583,7 +15870,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15623,7 +15911,8 @@ paths: schema: $ref: "#/components/schemas/Group" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15648,7 +15937,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15672,7 +15962,8 @@ paths: operationId: patchGroupId tags: - Groups - description: Partially update a group object. Specify the fields to update in + description: + Partially update a group 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. @@ -15697,7 +15988,8 @@ paths: schema: $ref: "#/components/schemas/Group" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15722,7 +16014,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15761,7 +16054,8 @@ paths: schema: $ref: "#/components/schemas/Group" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15786,7 +16080,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15814,7 +16109,8 @@ paths: - bearerAuth: [] - {} operationId: postProjectGroup - description: Create a new project group. If there is an existing project group + description: + Create a new project group. If there is an existing project group with the same name as the one specified in the request, will return the existing project group unmodified summary: Create project group @@ -15833,7 +16129,8 @@ paths: schema: $ref: "#/components/schemas/ProjectGroup" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15858,7 +16155,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15885,7 +16183,8 @@ paths: - bearerAuth: [] - {} operationId: putProjectGroup - description: Create or replace project group. If there is an existing project + description: + Create or replace project group. If there is an existing project group with the same name as the one specified in the request, will replace the existing project group with the provided fields summary: Create or replace project group @@ -15904,7 +16203,8 @@ paths: schema: $ref: "#/components/schemas/ProjectGroup" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -15929,7 +16229,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -15984,7 +16285,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16009,7 +16311,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16049,7 +16352,8 @@ paths: schema: $ref: "#/components/schemas/ProjectGroup" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16074,7 +16378,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16098,7 +16403,8 @@ paths: operationId: patchProjectGroupId tags: - ProjectGroups - description: Partially update a project group object. Specify the fields to + description: + Partially update a project group 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. @@ -16123,7 +16429,8 @@ paths: schema: $ref: "#/components/schemas/ProjectGroup" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16148,7 +16455,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16187,7 +16495,8 @@ paths: schema: $ref: "#/components/schemas/ProjectGroup" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16212,7 +16521,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16259,7 +16569,8 @@ paths: schema: $ref: "#/components/schemas/Acl" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16284,7 +16595,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16328,7 +16640,8 @@ paths: schema: $ref: "#/components/schemas/Acl" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16353,7 +16666,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16377,7 +16691,8 @@ paths: operationId: getAcl tags: - Acls - description: List out all ACLs. The ACLs are sorted by creation date, with the + description: + List out all ACLs. The ACLs are sorted by creation date, with the most recently-created ACLs coming first summary: List ACLs security: @@ -16412,7 +16727,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16437,7 +16753,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16477,7 +16794,8 @@ paths: schema: $ref: "#/components/schemas/Acl" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16502,7 +16820,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16541,7 +16860,8 @@ paths: schema: $ref: "#/components/schemas/Acl" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16566,7 +16886,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16591,7 +16912,8 @@ paths: operationId: aclBatchUpdate tags: - Acls - description: Batch update ACLs. This operation is idempotent, so adding ACLs + description: + Batch update ACLs. This operation is idempotent, so adding ACLs which already exist will have no effect, and removing ACLs which do not exist will have no effect. summary: Batch update ACLs @@ -16613,7 +16935,8 @@ paths: schema: $ref: "#/components/schemas/AclBatchUpdateResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16638,7 +16961,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16663,7 +16987,8 @@ paths: operationId: aclListOrg tags: - Acls - description: List all ACLs in the org. This query requires the caller to have + description: + List all ACLs in the org. This query requires the caller to have `read_acls` permission at the organization level summary: List org ACLs security: @@ -16692,7 +17017,8 @@ paths: items: $ref: "#/components/schemas/Acl" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16717,7 +17043,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16742,7 +17069,8 @@ paths: operationId: getUser tags: - Users - description: List out all users. The users are sorted by creation date, with the + description: + List out all users. The users are sorted by creation date, with the most recently-created users coming first summary: List users security: @@ -16774,7 +17102,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16799,7 +17128,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16839,7 +17169,8 @@ paths: schema: $ref: "#/components/schemas/User" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16864,7 +17195,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16892,7 +17224,8 @@ paths: - bearerAuth: [] - {} operationId: postAgent - description: Create a new agent. If there is an existing agent with the same + description: + Create a new agent. If there is an existing agent with the same name as the one specified in the request, will return the existing agent unmodified summary: Create agent @@ -16911,7 +17244,8 @@ paths: schema: $ref: "#/components/schemas/Agent" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -16936,7 +17270,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -16963,7 +17298,8 @@ paths: - bearerAuth: [] - {} operationId: putAgent - description: Create or replace agent. If there is an existing agent with the + description: + Create or replace agent. If there is an existing agent with the same name as the one specified in the request, will replace the existing agent with the provided fields summary: Create or replace agent @@ -16982,7 +17318,8 @@ paths: schema: $ref: "#/components/schemas/Agent" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17007,7 +17344,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17031,7 +17369,8 @@ paths: operationId: getAgent tags: - Agents - description: List out all agents. The agents are sorted by creation date, with + description: + List out all agents. The agents are sorted by creation date, with the most recently-created agents coming first summary: List agents security: @@ -17061,7 +17400,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17086,7 +17426,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17126,7 +17467,8 @@ paths: schema: $ref: "#/components/schemas/Agent" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17151,7 +17493,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17175,7 +17518,8 @@ paths: operationId: patchAgentId tags: - Agents - description: Partially update an agent object. Specify the fields to update in + description: + Partially update an agent 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. @@ -17200,7 +17544,8 @@ paths: schema: $ref: "#/components/schemas/Agent" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17225,7 +17570,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17264,7 +17610,8 @@ paths: schema: $ref: "#/components/schemas/Agent" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17289,7 +17636,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17317,7 +17665,8 @@ paths: - bearerAuth: [] - {} operationId: postProjectAutomation - description: Create a new project automation. If there is an existing project + description: + Create a new project automation. If there is an existing project automation with the same name as the one specified in the request, will return the existing project automation unmodified summary: Create project automation @@ -17336,7 +17685,8 @@ paths: schema: $ref: "#/components/schemas/ProjectAutomation" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17361,7 +17711,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17408,7 +17759,8 @@ paths: schema: $ref: "#/components/schemas/ProjectAutomation" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17433,7 +17785,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17488,7 +17841,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17513,7 +17867,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17553,7 +17908,8 @@ paths: schema: $ref: "#/components/schemas/ProjectAutomation" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17578,7 +17934,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17602,7 +17959,8 @@ paths: operationId: patchProjectAutomationId tags: - ProjectAutomations - description: Partially update a project automation object. Specify the fields to + description: + Partially update a project automation 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. @@ -17627,7 +17985,8 @@ paths: schema: $ref: "#/components/schemas/ProjectAutomation" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17652,7 +18011,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17691,7 +18051,8 @@ paths: schema: $ref: "#/components/schemas/ProjectAutomation" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17716,7 +18077,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17744,7 +18106,8 @@ paths: - bearerAuth: [] - {} operationId: postOrgAutomation - description: Create a new org automation. If there is an existing org automation + description: + Create a new org automation. If there is an existing org automation with the same name as the one specified in the request, will return the existing org automation unmodified summary: Create org automation @@ -17763,7 +18126,8 @@ paths: schema: $ref: "#/components/schemas/OrgAutomation" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17788,7 +18152,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17834,7 +18199,8 @@ paths: schema: $ref: "#/components/schemas/OrgAutomation" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17859,7 +18225,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17883,7 +18250,8 @@ paths: operationId: getOrgAutomation tags: - OrgAutomations - description: List out all org automations. The org automations are sorted by + description: + List out all org automations. The org automations are sorted by creation date, with the most recently-created org automations coming first summary: List org automations @@ -17914,7 +18282,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -17939,7 +18308,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -17979,7 +18349,8 @@ paths: schema: $ref: "#/components/schemas/OrgAutomation" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18004,7 +18375,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18028,7 +18400,8 @@ paths: operationId: patchOrgAutomationId tags: - OrgAutomations - description: Partially update an org automation object. Specify the fields to + description: + Partially update an org automation 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. @@ -18053,7 +18426,8 @@ paths: schema: $ref: "#/components/schemas/OrgAutomation" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18078,7 +18452,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18117,7 +18492,8 @@ paths: schema: $ref: "#/components/schemas/OrgAutomation" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18142,7 +18518,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18170,7 +18547,8 @@ paths: - bearerAuth: [] - {} operationId: postProjectScore - description: Create a new project score. If there is an existing project score + description: + Create a new project score. If there is an existing project score in the project with the same name as the one specified in the request, will return the existing project score unmodified summary: Create project score @@ -18189,7 +18567,8 @@ paths: schema: $ref: "#/components/schemas/ProjectScore" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18214,7 +18593,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18241,7 +18621,8 @@ paths: - bearerAuth: [] - {} operationId: putProjectScore - description: Create or replace project score. If there is an existing project + description: + Create or replace project score. If there is an existing project score in the project with the same name as the one specified in the request, will replace the existing project score with the provided fields @@ -18261,7 +18642,8 @@ paths: schema: $ref: "#/components/schemas/ProjectScore" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18286,7 +18668,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18344,7 +18727,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18369,7 +18753,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18409,7 +18794,8 @@ paths: schema: $ref: "#/components/schemas/ProjectScore" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18434,7 +18820,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18458,7 +18845,8 @@ paths: operationId: patchProjectScoreId tags: - ProjectScores - description: Partially update a project score object. Specify the fields to + description: + Partially update a project score 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. @@ -18483,7 +18871,8 @@ paths: schema: $ref: "#/components/schemas/ProjectScore" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18508,7 +18897,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18547,7 +18937,8 @@ paths: schema: $ref: "#/components/schemas/ProjectScore" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18572,7 +18963,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18600,7 +18992,8 @@ paths: - bearerAuth: [] - {} operationId: postProjectTag - description: Create a new project tag. If there is an existing project tag in + description: + Create a new project tag. If there is an existing project tag in the project with the same name as the one specified in the request, will return the existing project tag unmodified summary: Create project tag @@ -18619,7 +19012,8 @@ paths: schema: $ref: "#/components/schemas/ProjectTag" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18644,7 +19038,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18671,7 +19066,8 @@ paths: - bearerAuth: [] - {} operationId: putProjectTag - description: Create or replace project tag. If there is an existing project tag + description: + Create or replace project tag. If there is an existing project tag in the project with the same name as the one specified in the request, will replace the existing project tag with the provided fields summary: Create or replace project tag @@ -18690,7 +19086,8 @@ paths: schema: $ref: "#/components/schemas/ProjectTag" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18715,7 +19112,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18739,7 +19137,8 @@ paths: operationId: getProjectTag tags: - ProjectTags - description: List out all project tags. The project tags are sorted by creation + description: + List out all project tags. The project tags are sorted by creation date, with the most recently-created project tags coming first summary: List project tags security: @@ -18771,7 +19170,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18796,7 +19196,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18836,7 +19237,8 @@ paths: schema: $ref: "#/components/schemas/ProjectTag" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18861,7 +19263,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18885,7 +19288,8 @@ paths: operationId: patchProjectTagId tags: - ProjectTags - description: Partially update a project tag object. Specify the fields to update + description: + Partially update a project tag 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. @@ -18910,7 +19314,8 @@ paths: schema: $ref: "#/components/schemas/ProjectTag" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18935,7 +19340,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -18974,7 +19380,8 @@ paths: schema: $ref: "#/components/schemas/ProjectTag" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -18999,7 +19406,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19027,7 +19435,8 @@ paths: - bearerAuth: [] - {} operationId: postSpanIframe - description: Create a new span iframe. If there is an existing span iframe with + description: + Create a new span iframe. If there is an existing span iframe with the same name as the one specified in the request, will return the existing span iframe unmodified summary: Create span iframe @@ -19046,7 +19455,8 @@ paths: schema: $ref: "#/components/schemas/SpanIFrame" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19071,7 +19481,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19098,7 +19509,8 @@ paths: - bearerAuth: [] - {} operationId: putSpanIframe - description: Create or replace span iframe. If there is an existing span iframe + description: + Create or replace span iframe. If there is an existing span iframe with the same name as the one specified in the request, will replace the existing span iframe with the provided fields summary: Create or replace span iframe @@ -19117,7 +19529,8 @@ paths: schema: $ref: "#/components/schemas/SpanIFrame" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19142,7 +19555,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19166,7 +19580,8 @@ paths: operationId: getSpanIframe tags: - SpanIframes - description: List out all span iframes. The span iframes are sorted by creation + description: + List out all span iframes. The span iframes are sorted by creation date, with the most recently-created span iframes coming first summary: List span iframes security: @@ -19196,7 +19611,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19221,7 +19637,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19261,7 +19678,8 @@ paths: schema: $ref: "#/components/schemas/SpanIFrame" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19286,7 +19704,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19310,7 +19729,8 @@ paths: operationId: patchSpanIframeId tags: - SpanIframes - description: Partially update a span iframe object. Specify the fields to update + description: + Partially update a span iframe 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. @@ -19335,7 +19755,8 @@ paths: schema: $ref: "#/components/schemas/SpanIFrame" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19360,7 +19781,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19399,7 +19821,8 @@ paths: schema: $ref: "#/components/schemas/SpanIFrame" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19424,7 +19847,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19452,7 +19876,8 @@ paths: - bearerAuth: [] - {} operationId: postFunction - description: Create a new function. If there is an existing function in the + description: + Create a new function. If there is an existing function in the project with the same slug as the one specified in the request, a new version of the function will be appended and returned summary: Create function @@ -19471,7 +19896,8 @@ paths: schema: $ref: "#/components/schemas/Function" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19496,7 +19922,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19523,7 +19950,8 @@ paths: - bearerAuth: [] - {} operationId: putFunction - description: Create or replace function. If there is an existing function in the + description: + Create or replace function. If there is an existing function in the project with the same slug as the one specified in the request, a new version of the function will be appended and returned summary: Create or replace function @@ -19542,7 +19970,8 @@ paths: schema: $ref: "#/components/schemas/Function" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19567,7 +19996,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19591,7 +20021,8 @@ paths: operationId: getFunction tags: - Functions - description: List out all functions. The functions are sorted by creation date, + description: + List out all functions. The functions are sorted by creation date, with the most recently-created functions coming first summary: List functions security: @@ -19626,7 +20057,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19651,7 +20083,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19693,7 +20126,8 @@ paths: schema: $ref: "#/components/schemas/Function" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19718,7 +20152,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19742,7 +20177,8 @@ paths: operationId: patchFunctionId tags: - Functions - description: Partially update a function object. Specify the fields to update in + description: + Partially update a function 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. @@ -19767,7 +20203,8 @@ paths: schema: $ref: "#/components/schemas/Function" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19792,7 +20229,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19831,7 +20269,8 @@ paths: schema: $ref: "#/components/schemas/Function" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19856,7 +20295,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19881,7 +20321,8 @@ paths: operationId: postFunctionIdInvoke tags: - Functions - description: Run the specified function with the provided input and return its + description: + Run the specified function with the provided input and return its result. Use `version` to select a specific function version, `parent` to attach the call to a trace, and `stream` to receive results in the Braintrust SSE format. @@ -19913,7 +20354,8 @@ paths: - bearerAuth: [] - {} operationId: postView - description: Create a new view. If there is an existing view with the same name + description: + Create a new view. If there is an existing view with the same name as the one specified in the request, will return the existing view unmodified summary: Create view @@ -19932,7 +20374,8 @@ paths: schema: $ref: "#/components/schemas/View" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -19957,7 +20400,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -19984,7 +20428,8 @@ paths: - bearerAuth: [] - {} operationId: putView - description: Create or replace view. If there is an existing view with the same + description: + Create or replace view. If there is an existing view with the same name as the one specified in the request, will replace the existing view with the provided fields summary: Create or replace view @@ -20003,7 +20448,8 @@ paths: schema: $ref: "#/components/schemas/View" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20028,7 +20474,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20052,7 +20499,8 @@ paths: operationId: getView tags: - Views - description: List out all views. The views are sorted by creation date, with the + description: + List out all views. The views are sorted by creation date, with the most recently-created views coming first summary: List views security: @@ -20084,7 +20532,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20109,7 +20558,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20151,7 +20601,8 @@ paths: schema: $ref: "#/components/schemas/View" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20176,7 +20627,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20200,7 +20652,8 @@ paths: operationId: patchViewId tags: - Views - description: Partially update a view object. Specify the fields to update in the + description: + Partially update a view 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. @@ -20225,7 +20678,8 @@ paths: schema: $ref: "#/components/schemas/View" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20250,7 +20704,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20296,7 +20751,8 @@ paths: schema: $ref: "#/components/schemas/View" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20321,7 +20777,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20375,7 +20832,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20400,7 +20858,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20440,7 +20899,8 @@ paths: schema: $ref: "#/components/schemas/Organization" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20465,7 +20925,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20489,7 +20950,8 @@ paths: operationId: patchOrganizationId tags: - Organizations - description: Partially update an organization object. Specify the fields to + description: + Partially update an organization 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. @@ -20514,7 +20976,8 @@ paths: schema: $ref: "#/components/schemas/Organization" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20539,7 +21002,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20584,7 +21048,8 @@ paths: schema: $ref: "#/components/schemas/PatchOrganizationMembersOutput" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20609,7 +21074,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20634,7 +21100,8 @@ paths: operationId: getOrganizationApiKeys tags: - Organizations - description: List all API keys associated with users in an organization, sorted + description: + List all API keys associated with users in an organization, sorted by creation date with the newest keys first. An organization-scoped API key determines the organization; otherwise, provide `org_id`. If `org_id` does not match the organization-scoped key's organization, or @@ -20671,7 +21138,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20696,7 +21164,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20757,7 +21226,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20782,7 +21252,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20822,7 +21293,8 @@ paths: schema: $ref: "#/components/schemas/ApiKey" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20847,7 +21319,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20886,7 +21359,8 @@ paths: schema: $ref: "#/components/schemas/ApiKey" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -20911,7 +21385,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -20967,13 +21442,15 @@ paths: type: - string - "null" - description: For nearly all users, this parameter should be unnecessary. But in + description: + For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the Service token belongs in. service_account_id: type: string - description: The ID of the service account to which the token should belong. To + description: + The ID of the service account to which the token should belong. To create a service account, visit [**Settings > Service tokens**](https://www.braintrust.dev/app/~/configuration/org/service-tokens) in the Braintrust UI or call [`PATCH @@ -20983,21 +21460,24 @@ paths: - integer - "null" exclusiveMinimum: 0 - description: Number of seconds from now after which the service token should + description: + Number of seconds from now after which the service token should expire. If omitted, the token never expires. required: - name - service_account_id responses: "200": - description: Returns an object containing the raw service token. This is the + description: + Returns an object containing the raw service token. This is the only time the raw API key will be exposed content: application/json: schema: $ref: "#/components/schemas/CreateServiceTokenOutput" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21022,7 +21502,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21049,7 +21530,8 @@ paths: - bearerAuth: [] - {} operationId: putServiceToken - description: Create or replace service token. If there is an existing service + description: + Create or replace service token. If there is an existing service token with the same name as the one specified in the request, will replace the existing service token with the provided fields summary: Create or replace service token @@ -21068,13 +21550,15 @@ paths: type: - string - "null" - description: For nearly all users, this parameter should be unnecessary. But in + description: + For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the Service token belongs in. service_account_id: type: string - description: The ID of the service account to which the token should belong. To + description: + The ID of the service account to which the token should belong. To create a service account, visit [**Settings > Service tokens**](https://www.braintrust.dev/app/~/configuration/org/service-tokens) in the Braintrust UI or call [`PATCH @@ -21084,21 +21568,24 @@ paths: - integer - "null" exclusiveMinimum: 0 - description: Number of seconds from now after which the service token should + description: + Number of seconds from now after which the service token should expire. If omitted, the token never expires. required: - name - service_account_id responses: "200": - description: Returns an object containing the raw service token. This is the + description: + Returns an object containing the raw service token. This is the only time the raw API key will be exposed content: application/json: schema: $ref: "#/components/schemas/CreateServiceTokenOutput" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21123,7 +21610,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21167,7 +21655,8 @@ paths: schema: $ref: "#/components/schemas/ServiceToken" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21192,7 +21681,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21248,7 +21738,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21273,7 +21764,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21313,7 +21805,8 @@ paths: schema: $ref: "#/components/schemas/ServiceToken" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21338,7 +21831,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21377,7 +21871,8 @@ paths: schema: $ref: "#/components/schemas/ServiceToken" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21402,7 +21897,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21430,7 +21926,8 @@ paths: - bearerAuth: [] - {} operationId: postAiSecret - description: Create a new AI secret. If there is an existing AI secret with the + description: + Create a new AI secret. If there is an existing AI secret with the same name as the one specified in the request, will return the existing AI secret unmodified summary: Create AI secret @@ -21449,7 +21946,8 @@ paths: schema: $ref: "#/components/schemas/AISecret" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21474,7 +21972,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21501,7 +22000,8 @@ paths: - bearerAuth: [] - {} operationId: putAiSecret - description: Create or replace AI secret. If there is an existing AI secret with + description: + Create or replace AI secret. If there is an existing AI secret with the same name as the one specified in the request, will replace the existing AI secret with the provided fields summary: Create or replace AI secret @@ -21520,7 +22020,8 @@ paths: schema: $ref: "#/components/schemas/AISecret" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21545,7 +22046,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21589,7 +22091,8 @@ paths: schema: $ref: "#/components/schemas/AISecret" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21614,7 +22117,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21638,7 +22142,8 @@ paths: operationId: getAiSecret tags: - AiSecrets - description: List out all AI secrets. The AI secrets are sorted by creation + description: + List out all AI secrets. The AI secrets are sorted by creation date, with the most recently-created AI secrets coming first summary: List AI secrets security: @@ -21669,7 +22174,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21694,7 +22200,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21734,7 +22241,8 @@ paths: schema: $ref: "#/components/schemas/AISecret" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21759,7 +22267,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21783,7 +22292,8 @@ paths: operationId: patchAiSecretId tags: - AiSecrets - description: Partially update an AI secret object. Specify the fields to update + description: + Partially update an AI secret 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. @@ -21808,7 +22318,8 @@ paths: schema: $ref: "#/components/schemas/AISecret" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21833,7 +22344,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21872,7 +22384,8 @@ paths: schema: $ref: "#/components/schemas/AISecret" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -21897,7 +22410,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -21925,7 +22439,8 @@ paths: - bearerAuth: [] - {} operationId: postEnvVar - description: Create a new env var. If there is an existing env var with the same + description: + Create a new env var. If there is an existing env var with the same name as the one specified in the request, will return the existing env var unmodified summary: Create env var @@ -21962,13 +22477,15 @@ paths: - object - "null" additionalProperties: {} - description: Optional metadata associated with the environment variable when + description: + Optional metadata associated with the environment variable when managed via the function secrets API secret_type: type: - string - "null" - description: Optional classification for the secret (for example, the AI + description: + Optional classification for the secret (for example, the AI provider name) required: - object_type @@ -21982,7 +22499,8 @@ paths: schema: $ref: "#/components/schemas/EnvVar" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22007,7 +22525,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22034,7 +22553,8 @@ paths: - bearerAuth: [] - {} operationId: putEnvVar - description: Create or replace env var. If there is an existing env var with the + description: + Create or replace env var. If there is an existing env var with the same name as the one specified in the request, will replace the existing env var with the provided fields summary: Create or replace env var @@ -22071,13 +22591,15 @@ paths: - object - "null" additionalProperties: {} - description: Optional metadata associated with the environment variable when + description: + Optional metadata associated with the environment variable when managed via the function secrets API secret_type: type: - string - "null" - description: Optional classification for the secret (for example, the AI + description: + Optional classification for the secret (for example, the AI provider name) required: - object_type @@ -22091,7 +22613,8 @@ paths: schema: $ref: "#/components/schemas/EnvVar" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22116,7 +22639,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22140,7 +22664,8 @@ paths: operationId: getEnvVar tags: - EnvVars - description: List out all env vars. The env vars are sorted by creation date, + description: + List out all env vars. The env vars are sorted by creation date, with the most recently-created env vars coming first summary: List env vars security: @@ -22169,7 +22694,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22194,7 +22720,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22234,7 +22761,8 @@ paths: schema: $ref: "#/components/schemas/EnvVar" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22259,7 +22787,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22283,7 +22812,8 @@ paths: operationId: patchEnvVarId tags: - EnvVars - description: Partially update an env var object. Specify the fields to update in + description: + Partially update an env var 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. @@ -22314,13 +22844,15 @@ paths: - object - "null" additionalProperties: {} - description: Optional metadata associated with the environment variable when + description: + Optional metadata associated with the environment variable when managed via the function secrets API secret_type: type: - string - "null" - description: Optional classification for the secret (for example, the AI + description: + Optional classification for the secret (for example, the AI provider name) required: - name @@ -22332,7 +22864,8 @@ paths: schema: $ref: "#/components/schemas/EnvVar" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22357,7 +22890,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22396,7 +22930,8 @@ paths: schema: $ref: "#/components/schemas/EnvVar" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22421,7 +22956,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22449,7 +22985,8 @@ paths: - bearerAuth: [] - {} operationId: postMcpServer - description: Create a new MCP server. If there is an existing MCP server with + description: + Create a new MCP server. If there is an existing MCP server with the same name as the one specified in the request, will return the existing MCP server unmodified summary: Create MCP server @@ -22468,7 +23005,8 @@ paths: schema: $ref: "#/components/schemas/MCPServer" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22493,7 +23031,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22520,7 +23059,8 @@ paths: - bearerAuth: [] - {} operationId: putMcpServer - description: Create or replace MCP server. If there is an existing MCP server + description: + Create or replace MCP server. If there is an existing MCP server with the same name as the one specified in the request, will replace the existing MCP server with the provided fields summary: Create or replace MCP server @@ -22539,7 +23079,8 @@ paths: schema: $ref: "#/components/schemas/MCPServer" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22564,7 +23105,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22588,7 +23130,8 @@ paths: operationId: getMcpServer tags: - McpServers - description: List out all MCP servers. The MCP servers are sorted by creation + description: + List out all MCP servers. The MCP servers are sorted by creation date, with the most recently-created MCP servers coming first summary: List MCP servers security: @@ -22618,7 +23161,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22643,7 +23187,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22683,7 +23228,8 @@ paths: schema: $ref: "#/components/schemas/MCPServer" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22708,7 +23254,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22732,7 +23279,8 @@ paths: operationId: patchMcpServerId tags: - McpServers - description: Partially update an MCP server object. Specify the fields to update + description: + Partially update an MCP server 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. @@ -22757,7 +23305,8 @@ paths: schema: $ref: "#/components/schemas/MCPServer" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22782,7 +23331,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22821,7 +23371,8 @@ paths: schema: $ref: "#/components/schemas/MCPServer" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22846,7 +23397,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22874,7 +23426,8 @@ paths: - bearerAuth: [] - {} operationId: postDatasetSnapshot - description: Create a new dataset snapshot. If there is an existing dataset + description: + Create a new dataset snapshot. If there is an existing dataset snapshot with the same name as the one specified in the request, will return the existing dataset snapshot unmodified summary: Create dataset snapshot @@ -22893,7 +23446,8 @@ paths: schema: $ref: "#/components/schemas/DatasetSnapshot" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22918,7 +23472,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -22945,7 +23500,8 @@ paths: - bearerAuth: [] - {} operationId: putDatasetSnapshot - description: Create or replace dataset snapshot. If there is an existing dataset + description: + Create or replace dataset snapshot. If there is an existing dataset snapshot with the same name as the one specified in the request, will replace the existing dataset snapshot with the provided fields summary: Create or replace dataset snapshot @@ -22964,7 +23520,8 @@ paths: schema: $ref: "#/components/schemas/DatasetSnapshot" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -22989,7 +23546,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -23013,7 +23571,8 @@ paths: operationId: getDatasetSnapshot tags: - DatasetSnapshots - description: List out all dataset snapshots. The dataset snapshots are sorted by + description: + List out all dataset snapshots. The dataset snapshots are sorted by creation date, with the most recently-created dataset snapshots coming first summary: List dataset snapshots @@ -23044,7 +23603,8 @@ paths: - objects additionalProperties: false "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -23069,7 +23629,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -23109,7 +23670,8 @@ paths: schema: $ref: "#/components/schemas/DatasetSnapshot" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -23134,7 +23696,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -23158,7 +23721,8 @@ paths: operationId: patchDatasetSnapshotId tags: - DatasetSnapshots - description: Partially update a dataset snapshot object. Specify the fields to + description: + Partially update a dataset snapshot 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. @@ -23183,7 +23747,8 @@ paths: schema: $ref: "#/components/schemas/DatasetSnapshot" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -23208,7 +23773,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -23247,347 +23813,8 @@ paths: schema: $ref: "#/components/schemas/DatasetSnapshot" "400": - description: The request was unacceptable, often due to missing a required - parameter - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "401": - description: No valid API key provided - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "403": - description: The API key doesn’t have permissions to perform the request - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "429": - description: Too many requests hit the API too quickly. We recommend an - exponential backoff of your requests - headers: - Retry-After: - schema: - type: string - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "500": - description: Something went wrong on Braintrust's end. (These are rare.) - content: - text/plain: - schema: - type: string - application/json: - schema: {} - /v1/project/{project_id}/simulated_user: - get: - operationId: listSimulatedUsers - summary: List simulated users - description: List simulated users in a project, ordered by UUID. Requires - project read permission. - tags: - - Simulated users - security: - - bearerAuth: [] - - {} - parameters: - - schema: - type: string - format: uuid - required: true - name: project_id - in: path - - schema: - anyOf: - - type: string - format: uuid - - type: array - items: - type: string - format: uuid - maxItems: 1000 - required: false - name: ids - in: query - - schema: - type: string - required: false - name: simulated_user_name - in: query - - schema: - $ref: "#/components/schemas/AppLimit" - required: false - description: Limit the number of objects to return - name: limit - in: query - - $ref: "#/components/parameters/StartingAfter" - - $ref: "#/components/parameters/EndingBefore" - responses: - "200": - description: The matching simulated users - content: - application/json: - schema: - type: object - properties: - objects: - type: array - items: - $ref: "#/components/schemas/SimulatedUser" - required: - - objects - "400": - description: The request was unacceptable, often due to missing a required - parameter - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "401": - description: No valid API key provided - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "403": - description: The API key doesn’t have permissions to perform the request - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "429": - description: Too many requests hit the API too quickly. We recommend an - exponential backoff of your requests - headers: - Retry-After: - schema: - type: string - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "500": - description: Something went wrong on Braintrust's end. (These are rare.) - content: - text/plain: - schema: - type: string - application/json: - schema: {} - post: - operationId: createSimulatedUser - summary: Create simulated user - description: Create a simulated user with a new UUID. Display names may repeat. - Requires project update permission. - tags: - - Simulated users - security: - - bearerAuth: [] - - {} - parameters: - - schema: - type: string - format: uuid - required: true - name: project_id - in: path - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/CreateSimulatedUser" - responses: - "200": - description: The simulated user, including its stable UUID - content: - application/json: - schema: - $ref: "#/components/schemas/SimulatedUser" - "400": - description: The request was unacceptable, often due to missing a required - parameter - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "401": - description: No valid API key provided - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "403": - description: The API key doesn’t have permissions to perform the request - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "429": - description: Too many requests hit the API too quickly. We recommend an - exponential backoff of your requests - headers: - Retry-After: - schema: - type: string - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "500": - description: Something went wrong on Braintrust's end. (These are rare.) - content: - text/plain: - schema: - type: string - application/json: - schema: {} - /v1/project/{project_id}/simulated_user/{id}: - get: - operationId: getSimulatedUser - summary: Get simulated user - description: Retrieve a simulated user by its UUID within the specified project. - Requires project read permission. - tags: - - Simulated users - security: - - bearerAuth: [] - - {} - parameters: - - schema: - type: string - format: uuid - required: true - name: project_id - in: path - - schema: - type: string - format: uuid - required: true - name: id - in: path - responses: - "200": - description: The simulated user, including its stable UUID - content: - application/json: - schema: - $ref: "#/components/schemas/SimulatedUser" - "400": - description: The request was unacceptable, often due to missing a required - parameter - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "401": - description: No valid API key provided - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "403": - description: The API key doesn’t have permissions to perform the request - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "429": - description: Too many requests hit the API too quickly. We recommend an - exponential backoff of your requests - headers: - Retry-After: - schema: - type: string - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "500": - description: Something went wrong on Braintrust's end. (These are rare.) - content: - text/plain: - schema: - type: string - application/json: - schema: {} - patch: - operationId: patchSimulatedUser - summary: Update simulated user - description: Update an existing simulated user while preserving its UUID. - Supplied voice_config replaces the entire voice configuration. Set goal - to null to clear it. Requires project update permission and project read - permission because the response includes the stored simulated user. - tags: - - Simulated users - security: - - bearerAuth: [] - - {} - parameters: - - schema: - type: string - format: uuid - required: true - name: project_id - in: path - - schema: - type: string - format: uuid - required: true - name: id - in: path - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/PatchSimulatedUser" - responses: - "200": - description: The simulated user, including its stable UUID - content: - application/json: - schema: - $ref: "#/components/schemas/SimulatedUser" - "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -23612,84 +23839,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an - exponential backoff of your requests - headers: - Retry-After: - schema: - type: string - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "500": - description: Something went wrong on Braintrust's end. (These are rare.) - content: - text/plain: - schema: - type: string - application/json: - schema: {} - delete: - operationId: deleteSimulatedUser - summary: Delete simulated user - description: Delete an existing simulated user in the specified project. - Requires project update permission and project read permission because - the response includes the stored simulated user. - tags: - - Simulated users - security: - - bearerAuth: [] - - {} - parameters: - - schema: - type: string - format: uuid - required: true - name: project_id - in: path - - schema: - type: string - format: uuid - required: true - name: id - in: path - responses: - "200": - description: The simulated user, including its stable UUID - content: - application/json: - schema: - $ref: "#/components/schemas/SimulatedUser" - "400": - description: The request was unacceptable, often due to missing a required - parameter - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "401": - description: No valid API key provided - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "403": - description: The API key doesn’t have permissions to perform the request - content: - text/plain: - schema: - type: string - application/json: - schema: {} - "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -23713,7 +23864,8 @@ paths: get: operationId: listEnvironments summary: List environments - description: List out all environments. The environments are sorted by creation + description: + List out all environments. The environments are sorted by creation date, with the most recently-created environments first. tags: - Environments @@ -23755,7 +23907,8 @@ paths: required: - objects "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -23780,7 +23933,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -23822,7 +23976,8 @@ paths: schema: $ref: "#/components/schemas/Environment" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -23847,7 +24002,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -23892,7 +24048,8 @@ paths: schema: $ref: "#/components/schemas/Environment" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -23917,7 +24074,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -23967,7 +24125,8 @@ paths: schema: $ref: "#/components/schemas/Environment" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -23992,7 +24151,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -24036,7 +24196,8 @@ paths: schema: $ref: "#/components/schemas/Environment" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -24061,7 +24222,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -24098,7 +24260,8 @@ paths: schema: type: string "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -24138,7 +24301,8 @@ paths: schema: $ref: "#/components/schemas/CrossObjectInsertResponse" "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -24163,7 +24327,8 @@ paths: application/json: schema: {} "429": - description: Too many requests hit the API too quickly. We recommend an + description: + Too many requests hit the API too quickly. We recommend an exponential backoff of your requests headers: Retry-After: @@ -24188,7 +24353,8 @@ paths: operationId: proxychatCompletions tags: - Proxy - description: Proxy a chat/completions request to the specified model, converting + description: + Proxy a chat/completions request to the specified model, converting its format as needed. Will cache if temperature=0 or seed is set. summary: Proxy chat/completions security: @@ -24213,7 +24379,8 @@ paths: operationId: proxycompletions tags: - Proxy - description: Proxy a completions request to the specified model, converting its + description: + Proxy a completions request to the specified model, converting its format as needed. Will cache if temperature=0 or seed is set. summary: Proxy completions security: @@ -24262,7 +24429,8 @@ paths: operationId: proxyembeddings tags: - Proxy - description: Proxy an embeddings request to the specified model, converting its + description: + Proxy an embeddings request to the specified model, converting its format as needed. Will cache automatically. summary: Proxy embeddings security: @@ -24287,7 +24455,8 @@ paths: operationId: proxycredentials tags: - Proxy - description: Create a temporary credential which can access the proxy for a + description: + Create a temporary credential which can access the proxy for a limited time. The temporary credential will be allowed to make requests on behalf of the Braintrust API key (or model provider API key) provided in the `Authorization` header. See @@ -24298,7 +24467,8 @@ paths: - bearerAuth: [] - {} requestBody: - description: The temporary credential will be restricted according to the + description: + The temporary credential will be restricted according to the request body. required: true content: @@ -24328,7 +24498,8 @@ paths: default: true required: - project_name - description: If present, proxy will log requests to the given Braintrust project + description: + If present, proxy will log requests to the given Braintrust project name. description: Payload for requesting temporary credentials. responses: @@ -24344,7 +24515,8 @@ paths: required: - key "400": - description: The request was unacceptable, often due to missing a required + description: + The request was unacceptable, often due to missing a required parameter content: text/plain: @@ -24355,7 +24527,8 @@ paths: operationId: proxy{path+} tags: - Proxy - description: Any requests which do not match the above paths will be proxied + description: + Any requests which do not match the above paths will be proxied directly to the OpenAI API. summary: Proxy any OpenAI request (fallback) parameters: @@ -24387,7 +24560,8 @@ paths: operationId: evalLaunch tags: - Evals - description: Launch an evaluation. This is the API-equivalent of the `Eval` + description: + Launch an evaluation. This is the API-equivalent of the `Eval` function that is built into the Braintrust SDK. In the Eval API, you provide pointers to a dataset, task function, and scoring functions. The API will then run the evaluation, create an experiment, and return the @@ -24412,4 +24586,3 @@ paths: schema: $ref: "#/components/schemas/SummarizeExperimentResponse" webhooks: {} -