@breign/client 1.0.158 → 1.0.160

package/dist/openapi.json

@@ -11751,6 +11751,168 @@
         "tags" : [ "tools" ]
       }
     },
+    "/tools/{toolId}/mcp/logs" : {
+      "delete" : {
+        "description" : "Drops every trace of this tool. The way out when payload capture was left on and recorded\nsomething it should not have.\n",
+        "operationId" : "deleteMcpCallLogs",
+        "parameters" : [ {
+          "description" : "Tool identifier",
+          "in" : "path",
+          "name" : "toolId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/McpCallLogsDeletedResponse"
+                }
+              }
+            },
+            "description" : "Traces erased"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "Tool not found"
+          }
+        },
+        "summary" : "Erase the MCP traces of a tool",
+        "tags" : [ "tools" ]
+      },
+      "get" : {
+        "description" : "Traces of the exchanges with the MCP server of this tool, most recent first: connections,\ntoken refreshes, tool calls, and the configuration changes an administrator made.\nReserved to administrators of the organisation owning the tool — a trace names the methods\ncalled and, when payload capture is on, carries an excerpt of the exchange.\n\nPaging walks backwards through time with a composite cursor. Both halves of `nextCursor`\nmust be sent back together: a date alone cannot separate two traces written in the same\nmillisecond.\n",
+        "operationId" : "listMcpCallLogs",
+        "parameters" : [ {
+          "description" : "Tool identifier",
+          "in" : "path",
+          "name" : "toolId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Keeps only the traces of that kind.",
+          "in" : "query",
+          "name" : "event",
+          "required" : false,
+          "schema" : {
+            "$ref" : "#/components/schemas/McpCallLogEvent"
+          }
+        }, {
+          "description" : "Keeps only the traces that succeeded, or only those that failed.",
+          "in" : "query",
+          "name" : "status",
+          "required" : false,
+          "schema" : {
+            "$ref" : "#/components/schemas/McpCallLogStatus"
+          }
+        }, {
+          "description" : "Page size, clamped server-side.",
+          "in" : "query",
+          "name" : "limit",
+          "required" : false,
+          "schema" : {
+            "default" : 50,
+            "maximum" : 200,
+            "minimum" : 1,
+            "type" : "integer"
+          }
+        }, {
+          "description" : "Date half of the cursor, sent back from `nextCursor` along with `beforeId`.",
+          "in" : "query",
+          "name" : "beforeCreatedAt",
+          "required" : false,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Identifier half of the cursor, sent back from `nextCursor` along with `beforeCreatedAt`.",
+          "in" : "query",
+          "name" : "beforeId",
+          "required" : false,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/McpCallLogsResponse"
+                }
+              }
+            },
+            "description" : "A page of traces"
+          },
+          "400" : {
+            "description" : "Unknown event or status filter"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "Tool not found"
+          }
+        },
+        "summary" : "Read the MCP traces of a tool",
+        "tags" : [ "tools" ]
+      }
+    },
+    "/tools/{toolId}/mcp/logs/settings" : {
+      "put" : {
+        "description" : "Whether the arguments and responses of the calls to this tool are kept in its traces.\n\nOff by default, and deliberately its own endpoint rather than a field of the tool: the\narguments of an MCP call carry whatever the user asked for, so switching capture on is a\ndebugging act an administrator takes knowingly, and the tool edit form can never reset it\nby accident.\n",
+        "operationId" : "updateMcpLogsSettings",
+        "parameters" : [ {
+          "description" : "Tool identifier",
+          "in" : "path",
+          "name" : "toolId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/McpLogsSettingsRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/McpLogsSettingsResponse"
+                }
+              }
+            },
+            "description" : "Capture setting applied"
+          },
+          "400" : {
+            "description" : "Invalid body"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "Tool not found"
+          }
+        },
+        "summary" : "Turn MCP payload capture on or off for a tool",
+        "tags" : [ "tools" ]
+      }
+    },
     "/tools/{toolId}/connection-status" : {
       "get" : {
         "description" : "For organization-scoped tools, returns whether the shared connection is set up.\nFor user-scoped tools, returns whether the caller has connected their own account.\n",
@@ -13382,6 +13544,155 @@
         "tags" : [ "prompts" ]
       }
     },
+    "/agents/{agentId}/prompts/rate-limit" : {
+      "get" : {
+        "description" : "Returns the current prompt rate-limit quota for the authenticated subject on the given agent, without consuming a slot.\n",
+        "operationId" : "getPromptRateLimit",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/PromptRateLimitResponse"
+                }
+              }
+            },
+            "description" : "Current prompt rate-limit usage",
+            "headers" : {
+              "X-RateLimit-Limit-Prompts" : {
+                "description" : "Max prompts in the sliding window",
+                "schema" : {
+                  "type" : "integer"
+                }
+              },
+              "X-RateLimit-Remaining-Prompts" : {
+                "description" : "Remaining prompts in the sliding window",
+                "schema" : {
+                  "type" : "integer"
+                }
+              },
+              "X-RateLimit-Reset-Prompts" : {
+                "description" : "Seconds until the window slides",
+                "schema" : {
+                  "type" : "integer"
+                }
+              }
+            }
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User cannot access this agent"
+          },
+          "404" : {
+            "description" : "Agent not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Get prompt rate-limit usage",
+        "tags" : [ "prompts" ]
+      }
+    },
+    "/organizations/{organizationId}/agents/rate-limit/settings" : {
+      "get" : {
+        "description" : "Organization admin settings for agent chat anti-abuse limits.",
+        "operationId" : "getAgentRateLimitSettings",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/AgentRateLimitSettings"
+                }
+              }
+            },
+            "description" : "Current settings"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Get agent chat rate limit settings",
+        "tags" : [ "prompts" ]
+      },
+      "put" : {
+        "description" : "Organization admin can set per-org chat agent rate limits.",
+        "operationId" : "updateAgentRateLimitSettings",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/AgentRateLimitSettingsUpdateRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/AgentRateLimitSettings"
+                }
+              }
+            },
+            "description" : "Updated settings"
+          },
+          "400" : {
+            "description" : "Invalid request"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Update agent chat rate limit settings",
+        "tags" : [ "prompts" ]
+      }
+    },
     "/agents/{agentId}/prompts" : {
       "post" : {
         "description" : "Starts a new conversation session for the specified agent",
@@ -15056,7 +15367,94 @@
             "description" : "Forbidden — the caller is not an admin of the organization"
           }
         },
-        "summary" : "Get AI gateway usage metrics",
+        "summary" : "Get AI gateway usage metrics",
+        "tags" : [ "ai-gateway" ]
+      }
+    },
+    "/organizations/{organizationId}/ai-gateway/settings" : {
+      "get" : {
+        "description" : "Organization admin settings for gateway RPM and per-model token quotas.",
+        "operationId" : "getAiGatewaySettings",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/AiGatewaySettings"
+                }
+              }
+            },
+            "description" : "Current settings"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Get AI Gateway limits settings",
+        "tags" : [ "ai-gateway" ]
+      },
+      "put" : {
+        "description" : "Organization admin can set gateway RPM and per-model token quotas.",
+        "operationId" : "updateAiGatewaySettings",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/AiGatewaySettingsUpdateRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/AiGatewaySettings"
+                }
+              }
+            },
+            "description" : "Updated settings"
+          },
+          "400" : {
+            "description" : "Invalid request"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Update AI Gateway limits settings",
         "tags" : [ "ai-gateway" ]
       }
     },
@@ -22471,6 +22869,197 @@
         "title" : "ToolAllowedToolsResponse",
         "type" : "object"
       },
+      "McpCallLogEvent" : {
+        "description" : "Which moment of the exchange the trace covers. Three are network — opening the connection, renewing the tokens, calling the tool — and the fourth is an administrator changing the configuration, without which \"it worked yesterday\" stays unverifiable.",
+        "enum" : [ "connect", "auth_refresh", "tool_call", "config_change" ],
+        "title" : "McpCallLogEvent",
+        "type" : "string"
+      },
+      "McpCallLogStatus" : {
+        "enum" : [ "ok", "error" ],
+        "title" : "McpCallLogStatus",
+        "type" : "string"
+      },
+      "McpCallLogsResponse" : {
+        "additionalProperties" : false,
+        "properties" : {
+          "logs" : {
+            "items" : {
+              "$ref" : "#/components/schemas/McpCallLog"
+            },
+            "type" : "array"
+          },
+          "nextCursor" : {
+            "allOf" : [ {
+              "$ref" : "#/components/schemas/McpCallLogCursor"
+            } ],
+            "description" : "Null once the last page has been served.",
+            "nullable" : true
+          },
+          "payloadLogging" : {
+            "description" : "Whether this tool is currently capturing arguments and responses.",
+            "type" : "boolean"
+          },
+          "verboseLogging" : {
+            "description" : "Whether this tool records all of its activity. Off by default: only failures and configuration changes are kept, which is what an investigation actually reads.",
+            "type" : "boolean"
+          },
+          "retentionDays" : {
+            "description" : "How long traces are kept before the nightly purge drops them.",
+            "type" : "integer"
+          }
+        },
+        "required" : [ "logs", "nextCursor", "payloadLogging", "retentionDays", "verboseLogging" ],
+        "title" : "McpCallLogsResponse",
+        "type" : "object"
+      },
+      "McpCallLog" : {
+        "additionalProperties" : false,
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "orgId" : {
+            "type" : "string"
+          },
+          "toolId" : {
+            "type" : "string"
+          },
+          "toolName" : {
+            "description" : "Name of the tool when the call happened; it survives a later rename.",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "event" : {
+            "$ref" : "#/components/schemas/McpCallLogEvent"
+          },
+          "method" : {
+            "description" : "MCP method called, or the configuration action for a `config_change`.",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "status" : {
+            "$ref" : "#/components/schemas/McpCallLogStatus"
+          },
+          "durationMs" : {
+            "nullable" : true,
+            "type" : "integer"
+          },
+          "serverUrl" : {
+            "description" : "Server URL without its query string, which can carry a token.",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "scope" : {
+            "enum" : [ "organization", "user" ],
+            "type" : "string"
+          },
+          "authType" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "userId" : {
+            "description" : "Whoever the exchange was made for — the owner of the credentials used. On a `config_change` it is the author of the change instead.",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "agentId" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "conversationId" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "httpStatus" : {
+            "nullable" : true,
+            "type" : "integer"
+          },
+          "errorCode" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "errorMessage" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "retried" : {
+            "description" : "The call was replayed on a fresh connection after a first failure.",
+            "type" : "boolean"
+          },
+          "requestPreview" : {
+            "description" : "Captured only while payload capture is on, secrets redacted and size bounded.",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "responsePreview" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "createdAt" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "createdAt", "event", "id", "orgId", "retried", "scope", "status", "toolId" ],
+        "title" : "McpCallLog",
+        "type" : "object"
+      },
+      "McpCallLogCursor" : {
+        "additionalProperties" : false,
+        "properties" : {
+          "createdAt" : {
+            "type" : "string"
+          },
+          "id" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "createdAt", "id" ],
+        "title" : "McpCallLogCursor",
+        "type" : "object"
+      },
+      "McpCallLogsDeletedResponse" : {
+        "additionalProperties" : false,
+        "properties" : {
+          "deleted" : {
+            "type" : "integer"
+          }
+        },
+        "required" : [ "deleted" ],
+        "title" : "McpCallLogsDeletedResponse",
+        "type" : "object"
+      },
+      "McpLogsSettingsRequest" : {
+        "additionalProperties" : false,
+        "description" : "At least one switch. Whichever is omitted keeps its current value, so the screen can flip one without resetting the other.",
+        "minProperties" : 1,
+        "properties" : {
+          "payloads" : {
+            "description" : "Keep the arguments and responses of the calls that get recorded.",
+            "type" : "boolean"
+          },
+          "verbose" : {
+            "description" : "Record all activity, not only failures and configuration changes.",
+            "type" : "boolean"
+          }
+        },
+        "title" : "McpLogsSettingsRequest",
+        "type" : "object"
+      },
+      "McpLogsSettingsResponse" : {
+        "additionalProperties" : false,
+        "properties" : {
+          "payloads" : {
+            "type" : "boolean"
+          },
+          "verbose" : {
+            "type" : "boolean"
+          }
+        },
+        "required" : [ "payloads", "verbose" ],
+        "title" : "McpLogsSettingsResponse",
+        "type" : "object"
+      },
       "ToolConnectionStatusResponse" : {
         "additionalProperties" : false,
         "properties" : {
@@ -23390,6 +23979,96 @@
         "required" : [ "conversationId", "messageId", "text" ],
         "type" : "object"
       },
+      "PromptRateLimitResponse" : {
+        "description" : "Current prompt rate-limit usage for the calling subject on an agent",
+        "properties" : {
+          "limit" : {
+            "description" : "Max prompts allowed in the sliding window",
+            "type" : "integer"
+          },
+          "used" : {
+            "description" : "Prompts already consumed in the current window",
+            "type" : "integer"
+          },
+          "remaining" : {
+            "description" : "Prompts left before rate limiting",
+            "type" : "integer"
+          },
+          "resetSeconds" : {
+            "description" : "Seconds until the oldest event in the window expires",
+            "type" : "integer"
+          }
+        },
+        "required" : [ "limit", "remaining", "resetSeconds", "used" ],
+        "type" : "object"
+      },
+      "AgentRateLimitSettings" : {
+        "properties" : {
+          "organizationId" : {
+            "format" : "uuid",
+            "type" : "string"
+          },
+          "enabled" : {
+            "description" : "Enable agent chat rate limiting for this organization",
+            "type" : "boolean"
+          },
+          "maxConcurrentTurnsPerSubject" : {
+            "description" : "Max concurrent agent turns per user (chat agent)",
+            "minimum" : 1,
+            "type" : "integer"
+          },
+          "maxConversationCreatesPerSubjectPerMinute" : {
+            "description" : "Max new conversations per user per minute",
+            "minimum" : 1,
+            "type" : "integer"
+          },
+          "maxPromptsPerSubjectPerAgentPerMinute" : {
+            "description" : "Max prompts (messages) per user per agent per minute",
+            "minimum" : 1,
+            "type" : "integer"
+          },
+          "windowMs" : {
+            "description" : "Platform-fixed sliding window for prompt and conversation counters (milliseconds). Not configurable per organization.",
+            "minimum" : 1000,
+            "type" : "integer"
+          },
+          "concurrencyLeaseMs" : {
+            "description" : "Platform-fixed max duration of a concurrency slot if release is never called (milliseconds). Not configurable per organization.",
+            "minimum" : 1000,
+            "type" : "integer"
+          },
+          "updatedAt" : {
+            "format" : "date-time",
+            "type" : "string"
+          },
+          "updatedBy" : {
+            "nullable" : true,
+            "type" : "string"
+          }
+        },
+        "required" : [ "concurrencyLeaseMs", "enabled", "maxConcurrentTurnsPerSubject", "maxConversationCreatesPerSubjectPerMinute", "maxPromptsPerSubjectPerAgentPerMinute", "organizationId", "updatedAt", "windowMs" ],
+        "type" : "object"
+      },
+      "AgentRateLimitSettingsUpdateRequest" : {
+        "properties" : {
+          "enabled" : {
+            "type" : "boolean"
+          },
+          "maxConcurrentTurnsPerSubject" : {
+            "minimum" : 1,
+            "type" : "integer"
+          },
+          "maxConversationCreatesPerSubjectPerMinute" : {
+            "minimum" : 1,
+            "type" : "integer"
+          },
+          "maxPromptsPerSubjectPerAgentPerMinute" : {
+            "minimum" : 1,
+            "type" : "integer"
+          }
+        },
+        "type" : "object"
+      },
       "PromptCreateRequest" : {
         "allOf" : [ {
           "$ref" : "#/components/schemas/PromptFlowCreateRequest"
@@ -24175,6 +24854,78 @@
         "required" : [ "inputTokens", "key", "label", "outputTokens", "requests", "totalTokens" ],
         "type" : "object"
       },
+      "AiGatewaySettings" : {
+        "properties" : {
+          "organizationId" : {
+            "format" : "uuid",
+            "type" : "string"
+          },
+          "gatewayRpm" : {
+            "description" : "Max requests per minute per subject; null means unlimited",
+            "nullable" : true,
+            "type" : "integer"
+          },
+          "modelTokenQuotas" : {
+            "items" : {
+              "$ref" : "#/components/schemas/AiGatewayModelTokenQuota"
+            },
+            "type" : "array"
+          },
+          "updatedAt" : {
+            "format" : "date-time",
+            "type" : "string"
+          },
+          "updatedBy" : {
+            "nullable" : true,
+            "type" : "string"
+          }
+        },
+        "required" : [ "gatewayRpm", "modelTokenQuotas", "organizationId", "updatedAt" ],
+        "type" : "object"
+      },
+      "AiGatewayModelTokenQuota" : {
+        "properties" : {
+          "userId" : {
+            "description" : "Breign user id this quota applies to",
+            "type" : "string"
+          },
+          "model" : {
+            "description" : "Bare model id or qualified providerId/modelId",
+            "type" : "string"
+          },
+          "providerId" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "limit" : {
+            "description" : "Token cap for this user and period (input + output + reasoning)",
+            "minimum" : 1,
+            "type" : "integer"
+          },
+          "period" : {
+            "enum" : [ "day", "month" ],
+            "type" : "string"
+          }
+        },
+        "required" : [ "limit", "model", "period", "userId" ],
+        "type" : "object"
+      },
+      "AiGatewaySettingsUpdateRequest" : {
+        "properties" : {
+          "gatewayRpm" : {
+            "minimum" : 1,
+            "nullable" : true,
+            "type" : "integer"
+          },
+          "modelTokenQuotas" : {
+            "items" : {
+              "$ref" : "#/components/schemas/AiGatewayModelTokenQuota"
+            },
+            "type" : "array"
+          }
+        },
+        "type" : "object"
+      },
       "AiGatewayV1ModelList" : {
         "properties" : {
           "object" : {