@relevanceai/sdk 1.66.0 → 1.68.0

package/dist-types/generated/_DiscoveryApiSchemaTypes.d.ts

@@ -7,112 +7,592 @@ interface definitions {
  */
 export interface paths {
     "/deployables/create": {
-        /** Create a private deployable. */
+        /**
+         * Create a private deployable.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "deployables:write",
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "body": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CreateDeployable"];
     };
     "/deployables/{deployable_id}/get": {
-        /** Get a deployable. */
+        /**
+         * Get a deployable.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "deployables:read"
+         *     ],
+         *     "deployables": [
+         *       {
+         *         "params": "deployable_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["GetDeployable"];
     };
     "/deployables/{deployable_id}/update": {
-        /** Update a deployable */
+        /**
+         * Update a deployable
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "deployables:write"
+         *     ],
+         *     "deployables": [
+         *       {
+         *         "params": "deployable_id"
+         *       }
+         *     ]
+         *   },
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "body": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["UpdateDeployable"];
     };
     "/deployables/delete": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "deployables:write"
+         *     ],
+         *     "deployables": [
+         *       {
+         *         "body": "id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteDeployable"];
     };
     "/deployables/{deployable_id}/share": {
-        /** Share a private deployable. */
+        /**
+         * Share a private deployable.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "sharing:write",
+         *       "deployables:read"
+         *     ],
+         *     "deployables": [
+         *       {
+         *         "params": "deployable_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CreateDeployableKey"];
     };
     "/deployables/{deployable_id}/invite": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "users:write",
+         *       "deployables:read"
+         *     ],
+         *     "deployables": [
+         *       {
+         *         "params": "deployable_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CreateDeployableInvite"];
     };
     "/deployables/{deployable_id}/users/{user_id}/update": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "users:write",
+         *       "deployables:read"
+         *     ],
+         *     "deployables": [
+         *       {
+         *         "params": "deployable_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["UpdateUsersDeployablePermissions"];
     };
     "/deployables/{deployable_id}/private": {
-        /** Unshare a shared deployable, making it private. */
+        /**
+         * Unshare a shared deployable, making it private.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "sharing:write",
+         *       "deployables:read"
+         *     ],
+         *     "deployables": [
+         *       {
+         *         "params": "deployable_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteDeployableKey"];
     };
     "/deployables/list": {
-        /** List all deployables. */
+        /**
+         * List all deployables.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": []
+         *   }
+         * ]
+         */
         get: operations["ListDeployables"];
     };
+    "/deployablegroups/{deployablegroup_id}/delete": {
+        /**
+         * ### Required permissions
+         * > []
+         */
+        post: operations["DeleteDeployableGroup"];
+    };
+    "/deployablegroups/list": {
+        /**
+         * ### Required permissions
+         * > []
+         */
+        post: operations["ListDeployableGroups"];
+    };
+    "/deployablegroups/create": {
+        /**
+         * ### Required permissions
+         * > []
+         */
+        post: operations["CreateDeployableGroup"];
+    };
+    "/deployablegroups/{deployablegroup_id}/get": {
+        /**
+         * ### Required permissions
+         * > []
+         */
+        get: operations["GetDeployableGroup"];
+    };
+    "/deployablegroups/{deployablegroup_id}/update": {
+        /**
+         * ### Required permissions
+         * > []
+         */
+        post: operations["UpdateDeployableGroup"];
+    };
+    "/deployablegroups/{deployablegroup_id}/share": {
+        /**
+         * Share a private deployable group. Required read access to all deployables that are shared, and the datasets deployables are tied to.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "sharing:write"
+         *     ]
+         *   }
+         * ]
+         */
+        post: operations["CreateDeployableGroupKey"];
+    };
+    "/deployablegroups/{deployablegroup_id}/private": {
+        /**
+         * Unshare a shared deployable group, making it private.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "sharing:write"
+         *     ]
+         *   }
+         * ]
+         */
+        post: operations["DeleteDeployableGroupKey"];
+    };
     "/projects/create": {
-        /** Create a new Project that your user will have access to */
+        /**
+         * Create a new Project that your user will have access to
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "organizations:write"
+         *     ],
+         *     "organizations": [
+         *       {
+         *         "body": "organization_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CreateProject"];
     };
     "/projects/update": {
-        /** Update metadata of a Project */
+        /**
+         * Update metadata of a Project
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "admin"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["UpdateProject"];
     };
     "/projects/transfer_to_organization": {
-        /** Tie a project to an organization. This requires admin privileges over project and organization. */
+        /**
+         * Tie a project to an organization. This requires admin privileges over project and organization.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "admin"
+         *     ],
+         *     "projects": [
+         *       {
+         *         "user_info": "username"
+         *       }
+         *     ]
+         *   },
+         *   {
+         *     "actions": [
+         *       "organizations:write"
+         *     ],
+         *     "organizations": [
+         *       {
+         *         "body": "organization_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["TransferProjectToOrganization"];
     };
     "/projects/list": {
-        /** List all projects and their metadata */
+        /**
+         * List all projects and their metadata
+         *
+         * ### Required permissions
+         * > []
+         */
         get: operations["ListProjects"];
     };
     "/auth/users/create": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "users:write"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CreateUser"];
     };
     "/auth/users/list": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": []
+         *   }
+         * ]
+         */
         post: operations["ListUsers"];
     };
     "/auth/is_authorized": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["IsUserAuthorized"];
     };
     "/auth/info": {
-        /** Get user_id, key_id and permissions from an auth header. */
+        /**
+         * Get user_id, key_id and permissions from an auth header.
+         *
+         * ### Required permissions
+         * > []
+         */
         get: operations["GetAuthHeaderInfo"];
     };
     "/auth/invite/create": {
-        /** Invite a user to a project using either their email or their user_id */
+        /**
+         * Invite a user to a project using either their email or their user_id
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "users:write"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CreateProjectInvite"];
     };
     "/auth/invite/list": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["ListProjectInvites"];
     };
     "/auth/invite/accept": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["AcceptProjectInvite"];
     };
     "/auth/invite/delete": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "users:write"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteProjectInvite"];
     };
     "/auth/invite/resend": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "users:write"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["ResendProjectInvite"];
     };
     "/auth/users/{user_id}": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "users": [
+         *       {
+         *         "params": "user_id"
+         *       }
+         *     ],
+         *     "actions": [
+         *       "users:read"
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["GetUser"];
     };
     "/auth/users/{user_id}/update": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "users": [
+         *       {
+         *         "params": "user_id"
+         *       }
+         *     ],
+         *     "actions": [
+         *       "users:write"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["UpdateUser"];
     };
     "/auth/users/{user_id}/delete": {
-        /** Deletes a User from ONLY your project. If they have permissions for other projects, they will still have acces to them. */
+        /**
+         * Deletes a User from ONLY your project. If they have permissions for other projects, they will still have acces to them.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "users": [
+         *       {
+         *         "params": "user_id"
+         *       }
+         *     ],
+         *     "actions": [
+         *       "users:write"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteUser"];
     };
     "/auth/users/{user_id}/keys/create": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "users": [
+         *       {
+         *         "params": "user_id"
+         *       }
+         *     ],
+         *     "actions": [
+         *       "users:write"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CreateUserKey"];
     };
     "/auth/users/{user_id}/keys/list": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "users": [
+         *       {
+         *         "params": "user_id"
+         *       }
+         *     ],
+         *     "actions": [
+         *       "users:read"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["ListUserKeys"];
     };
     "/auth/users/{user_id}/keys/delete": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "users": [
+         *       {
+         *         "params": "user_id"
+         *       }
+         *     ],
+         *     "actions": [
+         *       "users:write"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteUserKey"];
     };
     "/datasets/{dataset_id}/cluster/centroids/insert": {
-        /** Insert your own cluster centroids for it to be used in approximate search settings and cluster aggregations. */
+        /**
+         * Insert your own cluster centroids for it to be used in approximate search settings and cluster aggregations.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["InsertClusterCentroids"];
     };
     "/datasets/{dataset_id}/cluster/centroids/update": {
-        /** Update your own cluster centroids for it to be used in approximate search settings and cluster aggregations. Will merge rather than replace centroids. */
+        /**
+         * Update your own cluster centroids for it to be used in approximate search settings and cluster aggregations. Will merge rather than replace centroids.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["UpdateClusterCentroids"];
     };
     "/datasets/{dataset_id}/cluster/centroids/compare_centroids": {
-        /** For each centroid in a list of centroids, find the closest centroids in another set of centroids. */
+        /**
+         * For each centroid in a list of centroids, find the closest centroids in another set of centroids.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       },
+         *       {
+         *         "body": "comparison_centroids.dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CompareClusterCentroids"];
     };
     "/datasets/{dataset_id}/aggregate": {
@@ -171,78 +651,402 @@ export interface paths {
          *     {"title": {"title": "books", "frequency": 200, "documents": [{...}, {...}]}, {"title": "books", "frequency": 100, "documents": [{...}, {...}]}}
          *
          * For array-aggregations, you can add "agg": "array" into the aggregation query.
+         *
+         *
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         post: operations["Aggregate"];
     };
     "/datasets/{dataset_id}/cluster/aggregate": {
-        /** Takes an aggregation query and gets the aggregate of each cluster in a collection. This helps you interpret each cluster and what is in them. */
+        /**
+         * Takes an aggregation query and gets the aggregate of each cluster in a collection. This helps you interpret each cluster and what is in them.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["AggregateClusters"];
     };
     "/datasets/{dataset_id}/cluster/facets": {
-        /** Takes a high level aggregation of every field and every cluster in a collection. This helps you interpret each cluster and what is in them. */
+        /**
+         * Takes a high level aggregation of every field and every cluster in a collection. This helps you interpret each cluster and what is in them.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["ListClusterFacets"];
     };
     "/datasets/{dataset_id}/cluster/centroids/list_closest_to_center": {
-        /** List documents with vector fields closest to centroids. */
+        /**
+         * List documents with vector fields closest to centroids.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["ListClosestToCentroids"];
     };
     "/datasets/{dataset_id}/cluster/centroids/list_furthest_from_center": {
-        /** List documents with vector fields furthest from centroids. */
+        /**
+         * List documents with vector fields furthest from centroids.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["ListFurthestFromCentroids"];
     };
     "/datasets/{dataset_id}/cluster/centroids/documents": {
-        /** List centroids, optionally filtering by their ids. */
+        /**
+         * List centroids, optionally filtering by their ids.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["ListCentroids"];
     };
     "/datasets/{dataset_id}/cluster/centroids/configs/list": {
-        /** List centroids configs for a dataset. */
+        /**
+         * List centroids configs for a dataset.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["ListCentroidConfigs"];
     };
     "/datasets/{dataset_id}/cluster/centroids/{centroid_id}/delete": {
-        /** Delete a centroid by ID */
+        /**
+         * Delete a centroid by ID
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteCentroid"];
     };
     "/datasets/{dataset_id}/cluster/realtime": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "body": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["RealtimeClustering"];
     };
     "/datasets/{dataset_id}/cluster/merge": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["MergeClusters"];
     };
     "/datasets/{dataset_id}/cluster/centroids/summaries/create": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read",
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CreateClusterSummaries"];
     };
     "/datasets/{dataset_id}/cluster/centroids/summaries/list": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["ListClusterSummaries"];
     };
     "/datasets/{dataset_id}/cluster/centroids/summaries/bulk_delete": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteClusterSummaries"];
     };
     "/organizations/create": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["CreateOrganization"];
     };
     "/organizations/{organization_id}/update": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "organizations:write"
+         *     ],
+         *     "organizations": [
+         *       {
+         *         "params": "organization_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["UpdateOrganization"];
     };
     "/admin/organizations/{organization_id}/update": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "support:write"
+         *     ],
+         *     "organizations": [
+         *       {
+         *         "params": "organization_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["UpdateOrganizationAdmin"];
     };
     "/organizations/list": {
-        /** List all organizations and their metadata */
+        /**
+         * List all organizations and their metadata
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "organizations:read"
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["ListOrganizations"];
     };
     "/organizations/{organization_id}/delete": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "organizations:write"
+         *     ],
+         *     "organizations": [
+         *       {
+         *         "params": "organization_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteOrganization"];
     };
     "/organizations/{organization_id}/get": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "organizations:read"
+         *     ],
+         *     "organizations": [
+         *       {
+         *         "params": "organization_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["GetOrganization"];
     };
     "/organizations/{organization_id}/usage/get": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "organizations:read"
+         *     ],
+         *     "organizations": [
+         *       {
+         *         "params": "organization_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["GetOrganizationUsage"];
     };
     "/organizations/{organization_id}/users/list": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "organizations:read"
+         *     ],
+         *     "organizations": [
+         *       {
+         *         "params": "organization_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["ListUsersInOrganization"];
     };
     "/organizations/{organization_id}/projects/list": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "organizations:read"
+         *     ],
+         *     "organizations": [
+         *       {
+         *         "params": "organization_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["ListProjectsInOrganization"];
     };
     "/datasets/{dataset_id}/documents/insert": {
@@ -255,6 +1059,21 @@ export interface paths {
          *
          *     If inserting many items in a short timespan, use bulkInsert, or set update_schema to false.
          *     Every insert api call temporarily locks and updates the schema, so will slow down with many inserts in quick succession.
+         *
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         post: operations["Insert"];
     };
@@ -272,31 +1091,132 @@ export interface paths {
          * If the provided dataset doesn't exist, one will be automatically created.
          *
          * Limit the payload of documents to a maximum 100MB for optimal performance.
+         *
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         post: operations["BulkInsert"];
     };
     "/datasets/{dataset_id}/get_file_upload_urls": {
-        /** specify a list of file paths. For each file path, a url upload_url is returned. files can be POSTed on upload_url to upload them. They can then be accessed on url. Upon dataset deletion, these files will be deleted. */
+        /**
+         * specify a list of file paths. For each file path, a url upload_url is returned. files can be POSTed on upload_url to upload them. They can then be accessed on url. Upon dataset deletion, these files will be deleted.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["GetFileUploadUrlsForDataset"];
     };
     "/datasets/{dataset_id}/list_file_uploads": {
-        /** Return up to 1000 files uploaded for a dataset. */
+        /**
+         * Return up to 1000 files uploaded for a dataset.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["ListFileUploadsForDataset"];
     };
     "/datasets/{dataset_id}/parse_blob": {
-        /** Bulk insert a large number of documents by downloading a file using "download url". This bypasses the need to directly send documents to the api, as happens in BulkInsert. */
+        /**
+         * Bulk insert a large number of documents by downloading a file using "download url". This bypasses the need to directly send documents to the api, as happens in BulkInsert.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["ParseBlob"];
     };
     "/admin/copy_foreign_dataset": {
-        /** Copy a dataset from another users projects into your project. This is considered a project job. */
+        /**
+         * Copy a dataset from another users projects into your project. This is considered a project job.
+         *
+         * ### Required permissions
+         * > []
+         */
         post: operations["CopyForeignDataset"];
     };
     "/admin/request_read_api_key": {
-        /** Creates a read only key for your project. Make sure to save the api key somewhere safe. When doing a search the admin username should still be used. */
+        /**
+         * Creates a read only key for your project. Make sure to save the api key somewhere safe. When doing a search the admin username should still be used.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "users:write",
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "raw": "*"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CreateProjectReadKey"];
     };
     "/datasets/{dataset_id}/delete": {
-        /** Delete a dataset. */
+        /**
+         * Delete a dataset.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteDataset"];
     };
     "/datasets/create": {
@@ -334,40 +1254,183 @@ export interface paths {
          *
          * For more information about vectors check out the 'Vectorizing' section, **\/services/search/vector** or out blog at [https://relevance.ai/blog](https://relevance.ai/blog).
          * For more information about chunks and chunk vectors check out **\/services/search/chunk**.
+         *
+         *
+         *
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "body": "id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         post: operations["CreateDataset"];
     };
     "/datasets/{dataset_id}/schema": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["GetSchema"];
     };
     "/datasets/list": {
-        /** List all datasets in a project that you are authorized to read/write. */
+        /**
+         * List all datasets in a project that you are authorized to read/write.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": []
+         *   }
+         * ]
+         */
         get: operations["ListDatasets"];
     };
     "/datasets/combine": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "body": "dataset_ids"
+         *       }
+         *     ]
+         *   },
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "body": "new_dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CombineDatasets"];
     };
     "/datasets/combine/{job_id}/get": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["GetCombineJobStatus"];
     };
     "/datasets/search": {
-        /** Search all datasets in a project that you are authorized to read/write. */
+        /**
+         * Search all datasets in a project that you are authorized to read/write.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": []
+         *   }
+         * ]
+         */
         get: operations["SearchDatasets"];
     };
     "/datasets/{dataset_id}/monitor/health": {
-        /** Gives you a summary of the health of your vectors, e.g. how many documents with vectors are missing, how many documents with zero vectors */
+        /**
+         * Gives you a summary of the health of your vectors, e.g. how many documents with vectors are missing, how many documents with zero vectors
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["GetFieldHealth"];
     };
     "/datasets/{dataset_id}/monitor/stats": {
-        /** View the usage statistics of a dataset. */
+        /**
+         * View the usage statistics of a dataset.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["GetDatasetStats"];
     };
     "/datasets/{dataset_id}/monitor/usage": {
-        /** View api call usage statistics for a dataset. */
+        /**
+         * View api call usage statistics for a dataset.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["GetDatasetUsage"];
     };
     "/datasets/{dataset_id}/vector_mappings": {
-        /** DEPRECATED !!!! Retrieve the mapping of vectors generated through fields, dictionary, array, etc */
+        /**
+         * DEPRECATED !!!! Retrieve the mapping of vectors generated through fields, dictionary, array, etc
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["GetVectorMappings"];
     };
     "/datasets/{dataset_id}/details": {
@@ -382,6 +1445,21 @@ export interface paths {
          * | vector_health   | Number of zero vectors stored. (returns same data as **\/dataset/{dataset_id}/monitor/health**) |
          * | schema_stats   | Fields and number of documents missing/not missing for that field. (returns same data as **\/dataset/{dataset_id}/monitor/stats**) |
          * | active_jobs   | All active jobs/tasks on the dataset. (returns same data as **\/dataset/{dataset_id}/tasks/list**) |
+         *
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         post: operations["GetDatasetDetails"];
     };
@@ -390,6 +1468,21 @@ export interface paths {
          * Retrieve a document by its `_id`.
          *
          * This is the most performant method to get a document or check if it exists, faster than filtering a dataset for by an `_id`.
+         *
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         get: operations["GetDocument"];
     };
@@ -398,19 +1491,98 @@ export interface paths {
          * Delete a document by its `_id` and remove it from the dataset.
          *
          * Support for deleting many documents at once is available through [`/bulk_delete`](/reference/bulk_delete_api_datasets__dataset_id__documents_bulk_delete_post).
+         *
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         post: operations["DeleteDocument"];
     };
     "/datasets/{dataset_id}/settings": {
-        /** Retreives settings for dataset. */
+        /**
+         * Retreives settings for dataset.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["GetDatasetSettings"];
-        /** Add and overwrite settings about a dataset. Notably description, data source, etc. */
+        /**
+         * Add and overwrite settings about a dataset. Notably description, data source, etc.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["UpsertDatasetSettings"];
     };
     "/datasets/{dataset_id}/metadata": {
-        /** Retreives metadata about a dataset. Notably description, data source, etc */
+        /**
+         * Retreives metadata about a dataset. Notably description, data source, etc
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["GetDatasetMetadata"];
-        /** Retreives metadata about a dataset. Notably description, data source, etc */
+        /**
+         * Retreives metadata about a dataset. Notably description, data source, etc
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["UpsertDatasetMetadata"];
     };
     "/datasets/{dataset_id}/documents/update": {
@@ -422,11 +1594,42 @@ export interface paths {
          * If the provided `_id` has no matching document in the dataset, a new document will be created. Likewise, if the provided `dataset_id` does not match a dataset in your project a new one will be created.
          *
          * Support for updating many documents at once with a filter condition is available through [`/update_where`](/reference/updatewhere).
+         *
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         post: operations["Update"];
     };
     "/datasets/{dataset_id}/documents/delete_fields": {
-        /** Delete fields in a document in a dataset by its id. */
+        /**
+         * Delete fields in a document in a dataset by its id.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteDocumentFields"];
     };
     "/datasets/{dataset_id}/documents/bulk_update": {
@@ -436,6 +1639,21 @@ export interface paths {
          *     If updating many items in a short timespan, please use BulkUpdate.
          *
          *     Every update api call temporarily locks and updates the schema, so will slow down with many updates in quick succession.
+         *
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         post: operations["BulkUpdate"];
     };
@@ -446,11 +1664,42 @@ export interface paths {
          * This method supports a partial update so you may add new fields or update only those you need. Other fields will remain unaffected.
          *
          * If the provided `dataset_id` does not match a dataset in your project, a new one will be created.
+         *
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         post: operations["UpdateWhere"];
     };
     "/datasets/{dataset_id}/facets": {
-        /** Takes a high level aggregation of every field, return their unique values and frequencies. This is used to help create the filter bar for search. */
+        /**
+         * Takes a high level aggregation of every field, return their unique values and frequencies. This is used to help create the filter bar for search.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["ListFacets"];
     };
     "/datasets/{dataset_id}/documents/get_where": {
@@ -458,6 +1707,20 @@ export interface paths {
          * Retrieve documents with filters.
          * afterId is provided to retrieve even more documents. Loop through it to retrieve all documents in the database.
          * Filter is used to retrieve documents that match the conditions set in a filter query.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         post: operations["GetWhere"];
     };
@@ -466,15 +1729,61 @@ export interface paths {
          * Retrieve documents with filters.
          * afterId is provided to retrieve even more documents. Loop through it to retrieve all documents in the database.
          * Filter is used to retrieve documents that match the conditions set in a filter query.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         post: operations["PaginateDocuments"];
     };
     "/datasets/{dataset_id}/documents/bulk_get": {
-        /** Retrieve documents by their IDs ("_id" field). This will retrieve the documents faster than a filter applied on the "_id" field. For single id lookup version of this request use /datasets/{dataset_id}/documents/get. */
+        /**
+         * Retrieve documents by their IDs ("_id" field). This will retrieve the documents faster than a filter applied on the "_id" field. For single id lookup version of this request use /datasets/{dataset_id}/documents/get.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["BulkGetDocuments"];
     };
     "/datasets/{dataset_id}/documents/bulk_delete": {
-        /** Delete a list of documents by their IDs. For deleting a single document refer to /datasets/{dataset_id}/documents/delete or deleting documents by filters refer to /datasets/{dataset_id}/documents/delete_where. */
+        /**
+         * Delete a list of documents by their IDs. For deleting a single document refer to /datasets/{dataset_id}/documents/delete or deleting documents by filters refer to /datasets/{dataset_id}/documents/delete_where.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["BulkDeleteDocuments"];
     };
     "/datasets/{dataset_id}/documents/list": {
@@ -482,86 +1791,375 @@ export interface paths {
          * Retrieve documents with filters.
          * afterId is provided to retrieve even more documents. Loop through it to retrieve all documents in the database.
          * Filter is used to retrieve documents that match the conditions set in a filter query.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
          */
         get: operations["ListDocuments"];
     };
     "/datasets/{dataset_id}/documents/delete_where": {
-        /** Delete documents that match on a filters. At least one filter must be provided. */
+        /**
+         * Delete documents that match on a filters. At least one filter must be provided.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteWhere"];
     };
     "/datasets/{dataset_id}/simple_search": {
-        /** SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results. */
+        /**
+         * SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["SimpleSearchPost"];
     };
     "/datasets/{dataset_id}/search": {
-        /** SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results. */
+        /**
+         * SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["Search"];
     };
     "/datasets/{dataset_id}/recommend": {
-        /** Recommend documents similar to specific documents. Specify which vector field must be used for recommendation using  the documentsToRecommend property. */
+        /**
+         * Recommend documents similar to specific documents. Specify which vector field must be used for recommendation using  the documentsToRecommend property.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["Recommend"];
     };
     "/datasets/{dataset_id}/clone": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   },
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "body": "new_dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["CloneDataset"];
     };
     "/services/prediction/regression/knn": {
-        /** Predict using KNN regression. */
+        /**
+         * Predict using KNN regression.
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "body": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["PredictKNNRegression"];
     };
     "/services/prediction/knn_from_results": {
-        /** Predict using KNN regression from search results. */
+        /**
+         * Predict using KNN regression from search results.
+         *
+         * ### Required permissions
+         * > []
+         */
         post: operations["PredictKNNFromResults"];
     };
     "/services/evaluation/bias": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["BiasEvaluation"];
     };
     "/services/vectorize": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["Vectorize"];
     };
     "/services/vectorize/{dataset_id}/vectorize_and_insert": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["VectorizeAndInsert"];
     };
     "/services/vectorize/{dataset_id}": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "params": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["VectorizeField"];
     };
     "/workflows/trigger": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read",
+         *       "datasets:write"
+         *     ],
+         *     "datasets": [
+         *       {
+         *         "body": "dataset_id"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["TriggerWorkflow"];
     };
     "/workflows/list": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ]
+         *   }
+         * ]
+         */
         get: operations["ListWorkflows"];
     };
     "/workflows/{workflow_id}/get": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:read"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["GetWorkflowStatus"];
     };
     "/workflows/{workflow_id}/delete": {
+        /**
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["DeleteWorkflowStatus"];
     };
     "/workflows/{workflow_id}/metadata": {
-        /** Update metadata for a workflow run */
+        /**
+         * Update metadata for a workflow run
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["UpsertWorkflowMetadata"];
     };
     "/workflows/{workflow_id}/status": {
-        /** Update status for a workflow run */
+        /**
+         * Update status for a workflow run
+         *
+         * ### Required permissions
+         * > [
+         *   {
+         *     "actions": [
+         *       "datasets:write"
+         *     ]
+         *   }
+         * ]
+         */
         post: operations["UpsertWorkflowStatus"];
     };
     "/datasets/{dataset_id}/field_children/{fieldchildren_id}/delete": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["DeleteFieldChildren"];
     };
     "/datasets/{dataset_id}/field_children/list": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["ListFieldChildrens"];
     };
     "/datasets/{dataset_id}/field_children/{fieldchildren_id}/update": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["UpdateFieldChildren"];
     };
     "/workflows/favourites/{favouriteworkflow_id}/delete": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["DeleteFavouriteWorkflow"];
     };
     "/workflows/favourites/list": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["ListFavouriteWorkflows"];
     };
     "/workflows/favourites/{favouriteworkflow_id}/update": {
+        /**
+         * ### Required permissions
+         * > []
+         */
         post: operations["UpdateFavouriteWorkflow"];
     };
+    "/savedfilters/{savedfilter_id}/delete": {
+        /**
+         * ### Required permissions
+         * > []
+         */
+        post: operations["DeleteSavedFilter"];
+    };
+    "/savedfilters/list": {
+        /**
+         * ### Required permissions
+         * > []
+         */
+        post: operations["ListSavedFilters"];
+    };
+    "/savedfilters/{savedfilter_id}/update": {
+        /**
+         * ### Required permissions
+         * > []
+         */
+        post: operations["UpdateSavedFilter"];
+    };
+    "/savedfilters/{savedfilter_id}/get": {
+        /**
+         * ### Required permissions
+         * > []
+         */
+        get: operations["GetSavedFilter"];
+    };
+    "/savedfilters/create": {
+        /**
+         * ### Required permissions
+         * > []
+         */
+        post: operations["CreateSavedFilter"];
+    };
 }
 export interface components {
     schemas: {
@@ -653,10 +2251,70 @@ export interface components {
                     [key: string]: unknown;
                 };
                 private?: boolean;
-                updated_at?: string;
+                updated_at?: string;
+            }[];
+            count: number;
+        };
+        DeleteDeployableGroupInput: unknown;
+        DeleteDeployableGroupOutput: unknown;
+        ListDeployableGroupsInput: {
+            [key: string]: unknown;
+        };
+        ListDeployableGroupsOutput: {
+            results: {
+                _id?: string;
+                name?: string;
+                description?: string;
+                deployables?: {
+                    id: string;
+                    name?: string;
+                    api_key?: string;
+                    private?: boolean;
+                }[];
+            }[];
+        };
+        CreateDeployableGroupInput: {
+            _id?: string;
+            name?: string;
+            description?: string;
+            deployables?: {
+                id: string;
+                name?: string;
+                api_key?: string;
+                private?: boolean;
+            }[];
+        };
+        CreateDeployableGroupOutput: {
+            id: string;
+        };
+        GetDeployableGroupInput: unknown;
+        GetDeployableGroupOutput: {
+            _id?: string;
+            name?: string;
+            description?: string;
+            deployables?: {
+                id: string;
+                name?: string;
+                api_key?: string;
+                private?: boolean;
+            }[];
+        };
+        UpdateDeployableGroupInput: {
+            _id?: string;
+            name?: string;
+            description?: string;
+            deployables?: {
+                id: string;
+                name?: string;
+                api_key?: string;
+                private?: boolean;
             }[];
-            count: number;
         };
+        UpdateDeployableGroupOutput: unknown;
+        CreateDeployableGroupKeyInput: unknown;
+        CreateDeployableGroupKeyOutput: unknown;
+        DeleteDeployableGroupKeyInput: unknown;
+        DeleteDeployableGroupKeyOutput: unknown;
         CreateProjectInput: {
             /** @description The name of the project */
             name?: string;
@@ -1092,6 +2750,8 @@ export interface components {
         ListUserKeysOutput: {
             results: {
                 _id: string;
+                label?: string;
+                notes?: string;
             }[];
         };
         DeleteUserKeyInput: {
@@ -4012,7 +5672,7 @@ export interface components {
                 /** @description The model url to use */
                 model_url?: string;
                 /** @description The model name to use. */
-                model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
+                model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers" | "similarity-all-mpnet-base-v2";
                 /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
                 body?: string;
                 /** @description The document field to encode. */
@@ -4084,7 +5744,7 @@ export interface components {
                 /** @description The model url to use */
                 model_url?: string;
                 /** @description The model name to use. */
-                model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
+                model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers" | "similarity-all-mpnet-base-v2";
                 /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
                 body?: string;
                 /** @description The document field to encode. */
@@ -4824,7 +6484,7 @@ export interface components {
                 /** @description The model url to use */
                 model_url?: string;
                 /** @description The model name to use. */
-                model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
+                model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers" | "similarity-all-mpnet-base-v2";
                 /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
                 body?: string;
                 /** @description The document field to encode. */
@@ -4909,7 +6569,7 @@ export interface components {
                 /** @description The model url to use */
                 model_url?: string;
                 /** @description The model name to use. */
-                model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
+                model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers" | "similarity-all-mpnet-base-v2";
                 /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
                 body?: string;
                 /** @description The document field to encode. */
@@ -7436,7 +9096,7 @@ export interface components {
                 /** @description The model url to use */
                 model_url?: string;
                 /** @description The model name to use. */
-                model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
+                model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers" | "similarity-all-mpnet-base-v2";
                 /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
                 body?: string;
                 /** @description The document field to encode. */
@@ -7454,7 +9114,7 @@ export interface components {
             /** @description The model url to use */
             model_url?: string;
             /** @description The model name to use. */
-            model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
+            model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers" | "similarity-all-mpnet-base-v2";
             /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
             body?: string;
             /** @description The document field to encode. */
@@ -7481,7 +9141,7 @@ export interface components {
             /** @description The model url to use */
             model_url?: string;
             /** @description The model name to use. */
-            model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
+            model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers" | "similarity-all-mpnet-base-v2";
             /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
             body?: string;
             /** @description The document field to encode. */
@@ -7521,7 +9181,7 @@ export interface components {
             /** @description The model url to use */
             model_url?: string;
             /** @description The model name to use. */
-            model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers";
+            model_name?: "image_text" | "text_image" | "all-mpnet-base-v2" | "clip-vit-b-32-image" | "clip-vit-b-32-text" | "sentence-transformers" | "similarity-all-mpnet-base-v2";
             /** @description Can be 'url' or 'text'. Use 'url' for image models and 'text' for text models. */
             body?: string;
             /** @description The document field to encode. */
@@ -7551,6 +9211,7 @@ export interface components {
             notebook_path: string;
             instance_type?: string;
             dataset_id: string;
+            workflow_id?: string;
         };
         TriggerWorkflowOutput: {
             job_id: string;
@@ -7566,6 +9227,7 @@ export interface components {
                     [key: string]: unknown;
                 };
                 _id?: string;
+                workflow_id?: string;
                 metadata?: {
                     [key: string]: unknown;
                 };
@@ -7586,6 +9248,7 @@ export interface components {
                 [key: string]: unknown;
             };
             _id?: string;
+            workflow_id?: string;
             metadata?: {
                 [key: string]: unknown;
             };
@@ -7635,6 +9298,7 @@ export interface components {
                 metadata?: {
                     [key: string]: unknown;
                 };
+                category?: string;
             }[];
         };
         UpdateFieldChildrenInput: {
@@ -7644,6 +9308,7 @@ export interface components {
             metadata?: {
                 [key: string]: unknown;
             };
+            category?: string;
         };
         UpdateFieldChildrenOutput: unknown;
         DeleteFavouriteWorkflowInput: unknown;
@@ -7660,10 +9325,71 @@ export interface components {
             _id?: string;
         };
         UpdateFavouriteWorkflowOutput: unknown;
+        DeleteSavedFilterInput: unknown;
+        DeleteSavedFilterOutput: unknown;
+        ListSavedFiltersInput: {
+            [key: string]: unknown;
+        };
+        ListSavedFiltersOutput: {
+            results: {
+                _id?: string;
+                filters?: {
+                    [key: string]: unknown;
+                };
+                label?: string;
+                name?: string;
+            }[];
+        };
+        UpdateSavedFilterInput: {
+            _id?: string;
+            filters?: {
+                [key: string]: unknown;
+            };
+            label?: string;
+            name?: string;
+        };
+        UpdateSavedFilterOutput: unknown;
+        GetSavedFilterInput: unknown;
+        GetSavedFilterOutput: {
+            _id?: string;
+            filters?: {
+                [key: string]: unknown;
+            };
+            label?: string;
+            name?: string;
+        };
+        CreateSavedFilterInput: {
+            _id?: string;
+            filters?: {
+                [key: string]: unknown;
+            };
+            label?: string;
+            name?: string;
+        };
+        CreateSavedFilterOutput: {
+            id: string;
+        };
     };
 }
 export interface operations {
-    /** Create a private deployable. */
+    /**
+     * Create a private deployable.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "deployables:write",
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "body": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     CreateDeployable: {
         parameters: {};
         responses: {
@@ -7680,7 +9406,23 @@ export interface operations {
             };
         };
     };
-    /** Get a deployable. */
+    /**
+     * Get a deployable.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "deployables:read"
+     *     ],
+     *     "deployables": [
+     *       {
+     *         "params": "deployable_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     GetDeployable: {
         parameters: {
             path: {
@@ -7697,7 +9439,33 @@ export interface operations {
             };
         };
     };
-    /** Update a deployable */
+    /**
+     * Update a deployable
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "deployables:write"
+     *     ],
+     *     "deployables": [
+     *       {
+     *         "params": "deployable_id"
+     *       }
+     *     ]
+     *   },
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "body": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     UpdateDeployable: {
         parameters: {
             path: {
@@ -7719,6 +9487,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "deployables:write"
+     *     ],
+     *     "deployables": [
+     *       {
+     *         "body": "id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     DeleteDeployable: {
         parameters: {};
         responses: {
@@ -7735,7 +9518,24 @@ export interface operations {
             };
         };
     };
-    /** Share a private deployable. */
+    /**
+     * Share a private deployable.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "sharing:write",
+     *       "deployables:read"
+     *     ],
+     *     "deployables": [
+     *       {
+     *         "params": "deployable_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     CreateDeployableKey: {
         parameters: {
             path: {
@@ -7757,6 +9557,22 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "users:write",
+     *       "deployables:read"
+     *     ],
+     *     "deployables": [
+     *       {
+     *         "params": "deployable_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     CreateDeployableInvite: {
         parameters: {
             path: {
@@ -7778,6 +9594,22 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "users:write",
+     *       "deployables:read"
+     *     ],
+     *     "deployables": [
+     *       {
+     *         "params": "deployable_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     UpdateUsersDeployablePermissions: {
         parameters: {
             path: {
@@ -7801,7 +9633,24 @@ export interface operations {
             };
         };
     };
-    /** Unshare a shared deployable, making it private. */
+    /**
+     * Unshare a shared deployable, making it private.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "sharing:write",
+     *       "deployables:read"
+     *     ],
+     *     "deployables": [
+     *       {
+     *         "params": "deployable_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     DeleteDeployableKey: {
         parameters: {
             path: {
@@ -7823,7 +9672,16 @@ export interface operations {
             };
         };
     };
-    /** List all deployables. */
+    /**
+     * List all deployables.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": []
+     *   }
+     * ]
+     */
     ListDeployables: {
         parameters: {
             query: {
@@ -7844,7 +9702,199 @@ export interface operations {
             };
         };
     };
-    /** Create a new Project that your user will have access to */
+    /**
+     * ### Required permissions
+     * > []
+     */
+    DeleteDeployableGroup: {
+        parameters: {
+            path: {
+                /** ID of deployablegroup */
+                deployablegroup_id: string;
+            };
+        };
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["DeleteDeployableGroupOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DeleteDeployableGroupInput"];
+            };
+        };
+    };
+    /**
+     * ### Required permissions
+     * > []
+     */
+    ListDeployableGroups: {
+        parameters: {};
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["ListDeployableGroupsOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ListDeployableGroupsInput"];
+            };
+        };
+    };
+    /**
+     * ### Required permissions
+     * > []
+     */
+    CreateDeployableGroup: {
+        parameters: {};
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["CreateDeployableGroupOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateDeployableGroupInput"];
+            };
+        };
+    };
+    /**
+     * ### Required permissions
+     * > []
+     */
+    GetDeployableGroup: {
+        parameters: {
+            path: {
+                /** ID of deployablegroup */
+                deployablegroup_id: string;
+            };
+        };
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["GetDeployableGroupOutput"];
+                };
+            };
+        };
+    };
+    /**
+     * ### Required permissions
+     * > []
+     */
+    UpdateDeployableGroup: {
+        parameters: {
+            path: {
+                /** ID of deployablegroup */
+                deployablegroup_id: string;
+            };
+        };
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["UpdateDeployableGroupOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateDeployableGroupInput"];
+            };
+        };
+    };
+    /**
+     * Share a private deployable group. Required read access to all deployables that are shared, and the datasets deployables are tied to.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "sharing:write"
+     *     ]
+     *   }
+     * ]
+     */
+    CreateDeployableGroupKey: {
+        parameters: {
+            path: {
+                /** ID of deployablegroup */
+                deployablegroup_id: string;
+            };
+        };
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["CreateDeployableGroupKeyOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateDeployableGroupKeyInput"];
+            };
+        };
+    };
+    /**
+     * Unshare a shared deployable group, making it private.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "sharing:write"
+     *     ]
+     *   }
+     * ]
+     */
+    DeleteDeployableGroupKey: {
+        parameters: {
+            path: {
+                /** ID of deployablegroup */
+                deployablegroup_id: string;
+            };
+        };
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["DeleteDeployableGroupKeyOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DeleteDeployableGroupKeyInput"];
+            };
+        };
+    };
+    /**
+     * Create a new Project that your user will have access to
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "organizations:write"
+     *     ],
+     *     "organizations": [
+     *       {
+     *         "body": "organization_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     CreateProject: {
         parameters: {};
         responses: {
@@ -7861,7 +9911,18 @@ export interface operations {
             };
         };
     };
-    /** Update metadata of a Project */
+    /**
+     * Update metadata of a Project
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "admin"
+     *     ]
+     *   }
+     * ]
+     */
     UpdateProject: {
         parameters: {};
         responses: {
@@ -7878,7 +9939,33 @@ export interface operations {
             };
         };
     };
-    /** Tie a project to an organization. This requires admin privileges over project and organization. */
+    /**
+     * Tie a project to an organization. This requires admin privileges over project and organization.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "admin"
+     *     ],
+     *     "projects": [
+     *       {
+     *         "user_info": "username"
+     *       }
+     *     ]
+     *   },
+     *   {
+     *     "actions": [
+     *       "organizations:write"
+     *     ],
+     *     "organizations": [
+     *       {
+     *         "body": "organization_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     TransferProjectToOrganization: {
         parameters: {};
         responses: {
@@ -7895,7 +9982,12 @@ export interface operations {
             };
         };
     };
-    /** List all projects and their metadata */
+    /**
+     * List all projects and their metadata
+     *
+     * ### Required permissions
+     * > []
+     */
     ListProjects: {
         parameters: {};
         responses: {
@@ -7907,6 +9999,16 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "users:write"
+     *     ]
+     *   }
+     * ]
+     */
     CreateUser: {
         parameters: {};
         responses: {
@@ -7923,6 +10025,14 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": []
+     *   }
+     * ]
+     */
     ListUsers: {
         parameters: {};
         responses: {
@@ -7939,6 +10049,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     IsUserAuthorized: {
         parameters: {};
         responses: {
@@ -7955,7 +10069,12 @@ export interface operations {
             };
         };
     };
-    /** Get user_id, key_id and permissions from an auth header. */
+    /**
+     * Get user_id, key_id and permissions from an auth header.
+     *
+     * ### Required permissions
+     * > []
+     */
     GetAuthHeaderInfo: {
         parameters: {};
         responses: {
@@ -7967,7 +10086,18 @@ export interface operations {
             };
         };
     };
-    /** Invite a user to a project using either their email or their user_id */
+    /**
+     * Invite a user to a project using either their email or their user_id
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "users:write"
+     *     ]
+     *   }
+     * ]
+     */
     CreateProjectInvite: {
         parameters: {};
         responses: {
@@ -7984,6 +10114,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     ListProjectInvites: {
         parameters: {};
         responses: {
@@ -8000,6 +10134,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     AcceptProjectInvite: {
         parameters: {};
         responses: {
@@ -8016,6 +10154,16 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "users:write"
+     *     ]
+     *   }
+     * ]
+     */
     DeleteProjectInvite: {
         parameters: {};
         responses: {
@@ -8032,6 +10180,16 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "users:write"
+     *     ]
+     *   }
+     * ]
+     */
     ResendProjectInvite: {
         parameters: {};
         responses: {
@@ -8048,6 +10206,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "users": [
+     *       {
+     *         "params": "user_id"
+     *       }
+     *     ],
+     *     "actions": [
+     *       "users:read"
+     *     ]
+     *   }
+     * ]
+     */
     GetUser: {
         parameters: {
             path: {
@@ -8064,6 +10237,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "users": [
+     *       {
+     *         "params": "user_id"
+     *       }
+     *     ],
+     *     "actions": [
+     *       "users:write"
+     *     ]
+     *   }
+     * ]
+     */
     UpdateUser: {
         parameters: {
             path: {
@@ -8085,7 +10273,23 @@ export interface operations {
             };
         };
     };
-    /** Deletes a User from ONLY your project. If they have permissions for other projects, they will still have acces to them. */
+    /**
+     * Deletes a User from ONLY your project. If they have permissions for other projects, they will still have acces to them.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "users": [
+     *       {
+     *         "params": "user_id"
+     *       }
+     *     ],
+     *     "actions": [
+     *       "users:write"
+     *     ]
+     *   }
+     * ]
+     */
     DeleteUser: {
         parameters: {
             path: {
@@ -8107,6 +10311,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "users": [
+     *       {
+     *         "params": "user_id"
+     *       }
+     *     ],
+     *     "actions": [
+     *       "users:write"
+     *     ]
+     *   }
+     * ]
+     */
     CreateUserKey: {
         parameters: {
             path: {
@@ -8128,6 +10347,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "users": [
+     *       {
+     *         "params": "user_id"
+     *       }
+     *     ],
+     *     "actions": [
+     *       "users:read"
+     *     ]
+     *   }
+     * ]
+     */
     ListUserKeys: {
         parameters: {
             path: {
@@ -8149,6 +10383,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "users": [
+     *       {
+     *         "params": "user_id"
+     *       }
+     *     ],
+     *     "actions": [
+     *       "users:write"
+     *     ]
+     *   }
+     * ]
+     */
     DeleteUserKey: {
         parameters: {
             path: {
@@ -8170,7 +10419,23 @@ export interface operations {
             };
         };
     };
-    /** Insert your own cluster centroids for it to be used in approximate search settings and cluster aggregations. */
+    /**
+     * Insert your own cluster centroids for it to be used in approximate search settings and cluster aggregations.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     InsertClusterCentroids: {
         parameters: {
             path: {
@@ -8192,7 +10457,23 @@ export interface operations {
             };
         };
     };
-    /** Update your own cluster centroids for it to be used in approximate search settings and cluster aggregations. Will merge rather than replace centroids. */
+    /**
+     * Update your own cluster centroids for it to be used in approximate search settings and cluster aggregations. Will merge rather than replace centroids.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     UpdateClusterCentroids: {
         parameters: {
             path: {
@@ -8214,7 +10495,26 @@ export interface operations {
             };
         };
     };
-    /** For each centroid in a list of centroids, find the closest centroids in another set of centroids. */
+    /**
+     * For each centroid in a list of centroids, find the closest centroids in another set of centroids.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       },
+     *       {
+     *         "body": "comparison_centroids.dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     CompareClusterCentroids: {
         parameters: {
             path: {
@@ -8291,6 +10591,22 @@ export interface operations {
      *     {"title": {"title": "books", "frequency": 200, "documents": [{...}, {...}]}, {"title": "books", "frequency": 100, "documents": [{...}, {...}]}}
      *
      * For array-aggregations, you can add "agg": "array" into the aggregation query.
+     *
+     *
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     Aggregate: {
         parameters: {
@@ -8313,7 +10629,23 @@ export interface operations {
             };
         };
     };
-    /** Takes an aggregation query and gets the aggregate of each cluster in a collection. This helps you interpret each cluster and what is in them. */
+    /**
+     * Takes an aggregation query and gets the aggregate of each cluster in a collection. This helps you interpret each cluster and what is in them.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     AggregateClusters: {
         parameters: {
             path: {
@@ -8335,7 +10667,23 @@ export interface operations {
             };
         };
     };
-    /** Takes a high level aggregation of every field and every cluster in a collection. This helps you interpret each cluster and what is in them. */
+    /**
+     * Takes a high level aggregation of every field and every cluster in a collection. This helps you interpret each cluster and what is in them.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     ListClusterFacets: {
         parameters: {
             path: {
@@ -8357,7 +10705,23 @@ export interface operations {
             };
         };
     };
-    /** List documents with vector fields closest to centroids. */
+    /**
+     * List documents with vector fields closest to centroids.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     ListClosestToCentroids: {
         parameters: {
             path: {
@@ -8379,7 +10743,23 @@ export interface operations {
             };
         };
     };
-    /** List documents with vector fields furthest from centroids. */
+    /**
+     * List documents with vector fields furthest from centroids.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     ListFurthestFromCentroids: {
         parameters: {
             path: {
@@ -8401,7 +10781,23 @@ export interface operations {
             };
         };
     };
-    /** List centroids, optionally filtering by their ids. */
+    /**
+     * List centroids, optionally filtering by their ids.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     ListCentroids: {
         parameters: {
             path: {
@@ -8423,7 +10819,23 @@ export interface operations {
             };
         };
     };
-    /** List centroids configs for a dataset. */
+    /**
+     * List centroids configs for a dataset.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     ListCentroidConfigs: {
         parameters: {
             path: {
@@ -8440,7 +10852,23 @@ export interface operations {
             };
         };
     };
-    /** Delete a centroid by ID */
+    /**
+     * Delete a centroid by ID
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     DeleteCentroid: {
         parameters: {
             path: {
@@ -8464,6 +10892,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "body": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     RealtimeClustering: {
         parameters: {
             path: {
@@ -8485,6 +10928,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     MergeClusters: {
         parameters: {
             path: {
@@ -8506,6 +10964,22 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read",
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     CreateClusterSummaries: {
         parameters: {
             path: {
@@ -8527,6 +11001,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     ListClusterSummaries: {
         parameters: {
             path: {
@@ -8548,6 +11037,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     DeleteClusterSummaries: {
         parameters: {
             path: {
@@ -8569,6 +11073,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     CreateOrganization: {
         parameters: {};
         responses: {
@@ -8585,6 +11093,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "organizations:write"
+     *     ],
+     *     "organizations": [
+     *       {
+     *         "params": "organization_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     UpdateOrganization: {
         parameters: {
             path: {
@@ -8606,6 +11129,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "support:write"
+     *     ],
+     *     "organizations": [
+     *       {
+     *         "params": "organization_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     UpdateOrganizationAdmin: {
         parameters: {
             path: {
@@ -8627,7 +11165,18 @@ export interface operations {
             };
         };
     };
-    /** List all organizations and their metadata */
+    /**
+     * List all organizations and their metadata
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "organizations:read"
+     *     ]
+     *   }
+     * ]
+     */
     ListOrganizations: {
         parameters: {};
         responses: {
@@ -8639,6 +11188,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "organizations:write"
+     *     ],
+     *     "organizations": [
+     *       {
+     *         "params": "organization_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     DeleteOrganization: {
         parameters: {
             path: {
@@ -8660,6 +11224,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "organizations:read"
+     *     ],
+     *     "organizations": [
+     *       {
+     *         "params": "organization_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     GetOrganization: {
         parameters: {
             path: {
@@ -8676,6 +11255,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "organizations:read"
+     *     ],
+     *     "organizations": [
+     *       {
+     *         "params": "organization_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     GetOrganizationUsage: {
         parameters: {
             path: {
@@ -8692,6 +11286,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "organizations:read"
+     *     ],
+     *     "organizations": [
+     *       {
+     *         "params": "organization_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     ListUsersInOrganization: {
         parameters: {
             path: {
@@ -8708,6 +11317,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "organizations:read"
+     *     ],
+     *     "organizations": [
+     *       {
+     *         "params": "organization_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     ListProjectsInOrganization: {
         parameters: {
             path: {
@@ -8733,6 +11357,21 @@ export interface operations {
      *
      *     If inserting many items in a short timespan, use bulkInsert, or set update_schema to false.
      *     Every insert api call temporarily locks and updates the schema, so will slow down with many inserts in quick succession.
+     *
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     Insert: {
         parameters: {
@@ -8768,6 +11407,21 @@ export interface operations {
      * If the provided dataset doesn't exist, one will be automatically created.
      *
      * Limit the payload of documents to a maximum 100MB for optimal performance.
+     *
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     BulkInsert: {
         parameters: {
@@ -8790,7 +11444,23 @@ export interface operations {
             };
         };
     };
-    /** specify a list of file paths. For each file path, a url upload_url is returned. files can be POSTed on upload_url to upload them. They can then be accessed on url. Upon dataset deletion, these files will be deleted. */
+    /**
+     * specify a list of file paths. For each file path, a url upload_url is returned. files can be POSTed on upload_url to upload them. They can then be accessed on url. Upon dataset deletion, these files will be deleted.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     GetFileUploadUrlsForDataset: {
         parameters: {
             path: {
@@ -8812,7 +11482,23 @@ export interface operations {
             };
         };
     };
-    /** Return up to 1000 files uploaded for a dataset. */
+    /**
+     * Return up to 1000 files uploaded for a dataset.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     ListFileUploadsForDataset: {
         parameters: {
             path: {
@@ -8829,7 +11515,23 @@ export interface operations {
             };
         };
     };
-    /** Bulk insert a large number of documents by downloading a file using "download url". This bypasses the need to directly send documents to the api, as happens in BulkInsert. */
+    /**
+     * Bulk insert a large number of documents by downloading a file using "download url". This bypasses the need to directly send documents to the api, as happens in BulkInsert.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     ParseBlob: {
         parameters: {
             path: {
@@ -8851,7 +11553,12 @@ export interface operations {
             };
         };
     };
-    /** Copy a dataset from another users projects into your project. This is considered a project job. */
+    /**
+     * Copy a dataset from another users projects into your project. This is considered a project job.
+     *
+     * ### Required permissions
+     * > []
+     */
     CopyForeignDataset: {
         parameters: {};
         responses: {
@@ -8868,7 +11575,24 @@ export interface operations {
             };
         };
     };
-    /** Creates a read only key for your project. Make sure to save the api key somewhere safe. When doing a search the admin username should still be used. */
+    /**
+     * Creates a read only key for your project. Make sure to save the api key somewhere safe. When doing a search the admin username should still be used.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "users:write",
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "raw": "*"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     CreateProjectReadKey: {
         parameters: {};
         responses: {
@@ -8885,7 +11609,23 @@ export interface operations {
             };
         };
     };
-    /** Delete a dataset. */
+    /**
+     * Delete a dataset.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     DeleteDataset: {
         parameters: {
             path: {
@@ -8941,6 +11681,23 @@ export interface operations {
      *
      * For more information about vectors check out the 'Vectorizing' section, **\/services/search/vector** or out blog at [https://relevance.ai/blog](https://relevance.ai/blog).
      * For more information about chunks and chunk vectors check out **\/services/search/chunk**.
+     *
+     *
+     *
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "body": "id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     CreateDataset: {
         parameters: {};
@@ -8958,6 +11715,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     GetSchema: {
         parameters: {
             path: {
@@ -8974,7 +11746,16 @@ export interface operations {
             };
         };
     };
-    /** List all datasets in a project that you are authorized to read/write. */
+    /**
+     * List all datasets in a project that you are authorized to read/write.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": []
+     *   }
+     * ]
+     */
     ListDatasets: {
         parameters: {};
         responses: {
@@ -8986,6 +11767,31 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "body": "dataset_ids"
+     *       }
+     *     ]
+     *   },
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "body": "new_dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     CombineDatasets: {
         parameters: {};
         responses: {
@@ -9002,6 +11808,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     GetCombineJobStatus: {
         parameters: {
             path: {
@@ -9023,7 +11833,16 @@ export interface operations {
             };
         };
     };
-    /** Search all datasets in a project that you are authorized to read/write. */
+    /**
+     * Search all datasets in a project that you are authorized to read/write.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": []
+     *   }
+     * ]
+     */
     SearchDatasets: {
         parameters: {
             query: {
@@ -9044,7 +11863,23 @@ export interface operations {
             };
         };
     };
-    /** Gives you a summary of the health of your vectors, e.g. how many documents with vectors are missing, how many documents with zero vectors */
+    /**
+     * Gives you a summary of the health of your vectors, e.g. how many documents with vectors are missing, how many documents with zero vectors
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     GetFieldHealth: {
         parameters: {
             path: {
@@ -9061,7 +11896,23 @@ export interface operations {
             };
         };
     };
-    /** View the usage statistics of a dataset. */
+    /**
+     * View the usage statistics of a dataset.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     GetDatasetStats: {
         parameters: {
             path: {
@@ -9078,7 +11929,23 @@ export interface operations {
             };
         };
     };
-    /** View api call usage statistics for a dataset. */
+    /**
+     * View api call usage statistics for a dataset.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     GetDatasetUsage: {
         parameters: {
             path: {
@@ -9100,7 +11967,23 @@ export interface operations {
             };
         };
     };
-    /** DEPRECATED !!!! Retrieve the mapping of vectors generated through fields, dictionary, array, etc */
+    /**
+     * DEPRECATED !!!! Retrieve the mapping of vectors generated through fields, dictionary, array, etc
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     GetVectorMappings: {
         parameters: {
             path: {
@@ -9128,6 +12011,21 @@ export interface operations {
      * | vector_health   | Number of zero vectors stored. (returns same data as **\/dataset/{dataset_id}/monitor/health**) |
      * | schema_stats   | Fields and number of documents missing/not missing for that field. (returns same data as **\/dataset/{dataset_id}/monitor/stats**) |
      * | active_jobs   | All active jobs/tasks on the dataset. (returns same data as **\/dataset/{dataset_id}/tasks/list**) |
+     *
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     GetDatasetDetails: {
         parameters: {
@@ -9154,6 +12052,21 @@ export interface operations {
      * Retrieve a document by its `_id`.
      *
      * This is the most performant method to get a document or check if it exists, faster than filtering a dataset for by an `_id`.
+     *
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     GetDocument: {
         parameters: {
@@ -9181,6 +12094,21 @@ export interface operations {
      * Delete a document by its `_id` and remove it from the dataset.
      *
      * Support for deleting many documents at once is available through [`/bulk_delete`](/reference/bulk_delete_api_datasets__dataset_id__documents_bulk_delete_post).
+     *
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     DeleteDocument: {
         parameters: {
@@ -9203,7 +12131,23 @@ export interface operations {
             };
         };
     };
-    /** Retreives settings for dataset. */
+    /**
+     * Retreives settings for dataset.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     GetDatasetSettings: {
         parameters: {
             path: {
@@ -9220,7 +12164,23 @@ export interface operations {
             };
         };
     };
-    /** Add and overwrite settings about a dataset. Notably description, data source, etc. */
+    /**
+     * Add and overwrite settings about a dataset. Notably description, data source, etc.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     UpsertDatasetSettings: {
         parameters: {
             path: {
@@ -9242,7 +12202,23 @@ export interface operations {
             };
         };
     };
-    /** Retreives metadata about a dataset. Notably description, data source, etc */
+    /**
+     * Retreives metadata about a dataset. Notably description, data source, etc
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     GetDatasetMetadata: {
         parameters: {
             path: {
@@ -9259,7 +12235,23 @@ export interface operations {
             };
         };
     };
-    /** Retreives metadata about a dataset. Notably description, data source, etc */
+    /**
+     * Retreives metadata about a dataset. Notably description, data source, etc
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     UpsertDatasetMetadata: {
         parameters: {
             path: {
@@ -9289,6 +12281,21 @@ export interface operations {
      * If the provided `_id` has no matching document in the dataset, a new document will be created. Likewise, if the provided `dataset_id` does not match a dataset in your project a new one will be created.
      *
      * Support for updating many documents at once with a filter condition is available through [`/update_where`](/reference/updatewhere).
+     *
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     Update: {
         parameters: {
@@ -9311,7 +12318,23 @@ export interface operations {
             };
         };
     };
-    /** Delete fields in a document in a dataset by its id. */
+    /**
+     * Delete fields in a document in a dataset by its id.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     DeleteDocumentFields: {
         parameters: {
             path: {
@@ -9339,6 +12362,21 @@ export interface operations {
      *     If updating many items in a short timespan, please use BulkUpdate.
      *
      *     Every update api call temporarily locks and updates the schema, so will slow down with many updates in quick succession.
+     *
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     BulkUpdate: {
         parameters: {
@@ -9367,6 +12405,21 @@ export interface operations {
      * This method supports a partial update so you may add new fields or update only those you need. Other fields will remain unaffected.
      *
      * If the provided `dataset_id` does not match a dataset in your project, a new one will be created.
+     *
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     UpdateWhere: {
         parameters: {
@@ -9389,7 +12442,23 @@ export interface operations {
             };
         };
     };
-    /** Takes a high level aggregation of every field, return their unique values and frequencies. This is used to help create the filter bar for search. */
+    /**
+     * Takes a high level aggregation of every field, return their unique values and frequencies. This is used to help create the filter bar for search.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     ListFacets: {
         parameters: {
             path: {
@@ -9415,6 +12484,20 @@ export interface operations {
      * Retrieve documents with filters.
      * afterId is provided to retrieve even more documents. Loop through it to retrieve all documents in the database.
      * Filter is used to retrieve documents that match the conditions set in a filter query.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     GetWhere: {
         parameters: {
@@ -9441,6 +12524,20 @@ export interface operations {
      * Retrieve documents with filters.
      * afterId is provided to retrieve even more documents. Loop through it to retrieve all documents in the database.
      * Filter is used to retrieve documents that match the conditions set in a filter query.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     PaginateDocuments: {
         parameters: {
@@ -9463,7 +12560,23 @@ export interface operations {
             };
         };
     };
-    /** Retrieve documents by their IDs ("_id" field). This will retrieve the documents faster than a filter applied on the "_id" field. For single id lookup version of this request use /datasets/{dataset_id}/documents/get. */
+    /**
+     * Retrieve documents by their IDs ("_id" field). This will retrieve the documents faster than a filter applied on the "_id" field. For single id lookup version of this request use /datasets/{dataset_id}/documents/get.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     BulkGetDocuments: {
         parameters: {
             path: {
@@ -9485,7 +12598,23 @@ export interface operations {
             };
         };
     };
-    /** Delete a list of documents by their IDs. For deleting a single document refer to /datasets/{dataset_id}/documents/delete or deleting documents by filters refer to /datasets/{dataset_id}/documents/delete_where. */
+    /**
+     * Delete a list of documents by their IDs. For deleting a single document refer to /datasets/{dataset_id}/documents/delete or deleting documents by filters refer to /datasets/{dataset_id}/documents/delete_where.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     BulkDeleteDocuments: {
         parameters: {
             path: {
@@ -9511,6 +12640,20 @@ export interface operations {
      * Retrieve documents with filters.
      * afterId is provided to retrieve even more documents. Loop through it to retrieve all documents in the database.
      * Filter is used to retrieve documents that match the conditions set in a filter query.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
      */
     ListDocuments: {
         parameters: {
@@ -9781,7 +12924,23 @@ export interface operations {
             };
         };
     };
-    /** Delete documents that match on a filters. At least one filter must be provided. */
+    /**
+     * Delete documents that match on a filters. At least one filter must be provided.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     DeleteWhere: {
         parameters: {
             path: {
@@ -9803,7 +12962,23 @@ export interface operations {
             };
         };
     };
-    /** SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results. */
+    /**
+     * SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     SimpleSearchPost: {
         parameters: {
             path: {
@@ -9825,7 +13000,23 @@ export interface operations {
             };
         };
     };
-    /** SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results. */
+    /**
+     * SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     Search: {
         parameters: {
             path: {
@@ -9847,7 +13038,23 @@ export interface operations {
             };
         };
     };
-    /** Recommend documents similar to specific documents. Specify which vector field must be used for recommendation using  the documentsToRecommend property. */
+    /**
+     * Recommend documents similar to specific documents. Specify which vector field must be used for recommendation using  the documentsToRecommend property.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     Recommend: {
         parameters: {
             path: {
@@ -9869,6 +13076,31 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   },
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "body": "new_dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     CloneDataset: {
         parameters: {
             path: {
@@ -9890,7 +13122,23 @@ export interface operations {
             };
         };
     };
-    /** Predict using KNN regression. */
+    /**
+     * Predict using KNN regression.
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "body": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     PredictKNNRegression: {
         parameters: {};
         responses: {
@@ -9907,7 +13155,12 @@ export interface operations {
             };
         };
     };
-    /** Predict using KNN regression from search results. */
+    /**
+     * Predict using KNN regression from search results.
+     *
+     * ### Required permissions
+     * > []
+     */
     PredictKNNFromResults: {
         parameters: {};
         responses: {
@@ -9924,6 +13177,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     BiasEvaluation: {
         parameters: {};
         responses: {
@@ -9940,6 +13197,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     Vectorize: {
         parameters: {};
         responses: {
@@ -9956,6 +13217,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     VectorizeAndInsert: {
         parameters: {
             path: {
@@ -9977,6 +13253,21 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "params": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     VectorizeField: {
         parameters: {
             path: {
@@ -9998,6 +13289,22 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read",
+     *       "datasets:write"
+     *     ],
+     *     "datasets": [
+     *       {
+     *         "body": "dataset_id"
+     *       }
+     *     ]
+     *   }
+     * ]
+     */
     TriggerWorkflow: {
         parameters: {};
         responses: {
@@ -10014,6 +13321,16 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ]
+     *   }
+     * ]
+     */
     ListWorkflows: {
         parameters: {
             query: {
@@ -10044,6 +13361,16 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:read"
+     *     ]
+     *   }
+     * ]
+     */
     GetWorkflowStatus: {
         parameters: {
             path: {
@@ -10065,6 +13392,16 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ]
+     *   }
+     * ]
+     */
     DeleteWorkflowStatus: {
         parameters: {
             path: {
@@ -10086,7 +13423,18 @@ export interface operations {
             };
         };
     };
-    /** Update metadata for a workflow run */
+    /**
+     * Update metadata for a workflow run
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ]
+     *   }
+     * ]
+     */
     UpsertWorkflowMetadata: {
         parameters: {
             path: {
@@ -10108,7 +13456,18 @@ export interface operations {
             };
         };
     };
-    /** Update status for a workflow run */
+    /**
+     * Update status for a workflow run
+     *
+     * ### Required permissions
+     * > [
+     *   {
+     *     "actions": [
+     *       "datasets:write"
+     *     ]
+     *   }
+     * ]
+     */
     UpsertWorkflowStatus: {
         parameters: {
             path: {
@@ -10130,6 +13489,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     DeleteFieldChildren: {
         parameters: {
             path: {
@@ -10153,6 +13516,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     ListFieldChildrens: {
         parameters: {
             path: {
@@ -10174,6 +13541,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     UpdateFieldChildren: {
         parameters: {
             path: {
@@ -10197,6 +13568,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     DeleteFavouriteWorkflow: {
         parameters: {
             path: {
@@ -10218,6 +13593,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     ListFavouriteWorkflows: {
         parameters: {};
         responses: {
@@ -10234,6 +13613,10 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
     UpdateFavouriteWorkflow: {
         parameters: {
             path: {
@@ -10255,6 +13638,116 @@ export interface operations {
             };
         };
     };
+    /**
+     * ### Required permissions
+     * > []
+     */
+    DeleteSavedFilter: {
+        parameters: {
+            path: {
+                /** ID of savedfilter */
+                savedfilter_id: string;
+            };
+        };
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["DeleteSavedFilterOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DeleteSavedFilterInput"];
+            };
+        };
+    };
+    /**
+     * ### Required permissions
+     * > []
+     */
+    ListSavedFilters: {
+        parameters: {};
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["ListSavedFiltersOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ListSavedFiltersInput"];
+            };
+        };
+    };
+    /**
+     * ### Required permissions
+     * > []
+     */
+    UpdateSavedFilter: {
+        parameters: {
+            path: {
+                /** ID of savedfilter */
+                savedfilter_id: string;
+            };
+        };
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["UpdateSavedFilterOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateSavedFilterInput"];
+            };
+        };
+    };
+    /**
+     * ### Required permissions
+     * > []
+     */
+    GetSavedFilter: {
+        parameters: {
+            path: {
+                /** ID of savedfilter */
+                savedfilter_id: string;
+            };
+        };
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["GetSavedFilterOutput"];
+                };
+            };
+        };
+    };
+    /**
+     * ### Required permissions
+     * > []
+     */
+    CreateSavedFilter: {
+        parameters: {};
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["CreateSavedFilterOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateSavedFilterInput"];
+            };
+        };
+    };
 }
 export interface external {
 }