{"note":"OpenAPI conversion -- returning structured metadata","name":"weaviate","description":"Weaviate REST API","version":"1.37.0-rc.0","base_url":"","endpoints":107,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Weaviate REST API\n@version 1.37.0-rc.0\n@auth OAuth2\n@endpoints 107\n@hint download_for_search\n@toc root(1), .well-known(3), replication(10), users(8), authz(18), objects(19), batch(3), graphql(2), meta(1), tokenize(1), schema(17), aliases(5), backups(7), export(3), cluster(1), nodes(2), tasks(1), classifications(2), mcp(3)\n\n@group root\n@endpoint GET /\n@desc List available endpoints\n@returns(200) Weaviate is alive and ready.\n\n@endgroup\n\n@group .well-known\n@endpoint GET /.well-known/live\n@desc Check application liveness\n@returns(200) The application is alive and responding to HTTP requests.\n\n@endpoint GET /.well-known/ready\n@desc Check application readiness\n@returns(200) The application is ready to serve traffic.\n@errors {503: The application is not ready to serve traffic. Traffic should be directed to other available replicas if applicable.}\n\n@endpoint GET /.well-known/openid-configuration\n@desc Get OIDC configuration\n@returns(200) OIDC configuration details returned successfully.\n@errors {404: OIDC provider is not configured for this Weaviate instance., 500: An internal server error occurred while retrieving OIDC configuration. Check the ErrorResponse for details.}\n\n@endgroup\n\n@group replication\n@endpoint POST /replication/replicate\n@desc Initiate a replica movement\n@required {body: map}\n@returns(200) Replication operation registered successfully. ID of the operation is returned.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error., 501: Replica movement operations are disabled.}\n\n@endpoint DELETE /replication/replicate\n@desc Delete all replication operations\n@returns(204) Replication operation registered successfully\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error., 501: Replica movement operations are disabled.}\n\n@endpoint POST /replication/replicate/force-delete\n@desc Force delete replication operations\n@optional {body: map}\n@returns(200) Replication operations force deleted successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint GET /replication/replicate/{id}\n@desc Retrieve a replication operation\n@required {id: any # The ID of the replication operation to get details for.}\n@optional {includeHistory: any # Whether to include the history of the replication operation.}\n@returns(200) The details of the replication operation.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden., 404: Shard replica operation not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error., 501: Replica movement operations are disabled.}\n\n@endpoint DELETE /replication/replicate/{id}\n@desc Delete a replication operation\n@required {id: any # The ID of the replication operation to delete.}\n@returns(204) Successfully deleted.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden., 404: Shard replica operation not found., 409: The operation is not in a deletable state, e.g. it is a MOVE op in the DEHYDRATING state., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error., 501: Replica movement operations are disabled.}\n\n@endpoint GET /replication/replicate/list\n@desc List replication operations\n@optional {targetNode: any # The name of the target node to get details for., collection: any # The name of the collection to get details for., shard: any # The shard to get details for., includeHistory: any # Whether to include the history of the replication operation.}\n@returns(200) The details of the replication operations.\n@errors {400: Bad request., 401: Unauthorized or invalid credentials., 403: Forbidden, 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error., 501: Replica movement operations are disabled.}\n\n@endpoint POST /replication/replicate/{id}/cancel\n@desc Cancel a replication operation\n@required {id: any # The ID of the replication operation to cancel.}\n@returns(204) Successfully cancelled.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Shard replica operation not found., 409: The operation is not in a cancellable state, e.g. it is READY or is a MOVE op in the DEHYDRATING state., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error., 501: Replica movement operations are disabled.}\n\n@endpoint GET /replication/sharding-state\n@desc Get sharding state\n@optional {collection: any # The collection name to get the sharding state for., shard: any # The shard to get the sharding state for.}\n@returns(200) Successfully retrieved sharding state.\n@errors {400: Bad request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Collection or shard not found., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error., 501: Replica movement operations are disabled.}\n\n@endpoint GET /replication/scale\n@desc Get replication scale plan\n@required {collection: any # The collection name to get the scaling plan for., replicationFactor: any # The desired replication factor to scale to. Must be a positive integer greater than zero.}\n@returns(200) Replication scale plan showing node additions and removals per shard.\n@errors {400: Bad request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Collection not found., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error., 501: Replica movement operations are disabled.}\n\n@endpoint POST /replication/scale\n@desc Apply replication scaling plan\n@required {body: map # The replication scaling plan specifying the collection and its shard-level replica adjustments.}\n@returns(200) List of replication shard copy operation IDs initiated for the scale operation\n@errors {400: Bad request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Collection not found., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error., 501: Replica movement operations are disabled.}\n\n@endgroup\n\n@group users\n@endpoint GET /users/own-info\n@desc Get current user info\n@returns(200) Info about the user.\n@errors {401: Unauthorized or invalid credentials., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error., 501: Replica movement operations are disabled.}\n\n@endpoint GET /users/db\n@desc List all users\n@optional {includeLastUsedTime: any # Whether to include the last time the users were utilized.}\n@returns(200) Info about the users.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint GET /users/db/{user_id}\n@desc Get user info\n@required {user_id: any # The name of the user.}\n@optional {includeLastUsedTime: any # Whether to include the last used time of the given user}\n@returns(200) Info about the user.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: User not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /users/db/{user_id}\n@desc Create a new user\n@required {user_id: any # The name of the user.}\n@optional {body: map}\n@returns(201) User created successfully and API key returned.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: User not found., 409: A user with the specified name already exists., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint DELETE /users/db/{user_id}\n@desc Delete a user\n@required {user_id: any # The name of the user.}\n@returns(204) Successfully deleted.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: User not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /users/db/{user_id}/rotate-key\n@desc Rotate API key of a user\n@required {user_id: any # The name of the user.}\n@returns(200) API key successfully updated.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: User not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /users/db/{user_id}/activate\n@desc Activate a user\n@required {user_id: any # The name of the user.}\n@returns(200) User successfully activated.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: User not found., 409: User already activated., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /users/db/{user_id}/deactivate\n@desc Deactivate a user\n@required {user_id: any # The name of the user.}\n@optional {body: map}\n@returns(200) User successfully deactivated.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: User not found., 409: User already deactivated., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endgroup\n\n@group authz\n@endpoint GET /authz/roles\n@desc Get all roles\n@returns(200) Successful response.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /authz/roles\n@desc Create new role\n@required {body: map}\n@returns(201) Role created successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 409: Role already exists., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /authz/roles/{id}/add-permissions\n@desc Add permissions to a role\n@required {id: any # The name (ID) of the role being modified., body: map}\n@returns(200) Permissions added successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: No role found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /authz/roles/{id}/remove-permissions\n@desc Remove permissions from a role\n@required {id: any # The name of the role being modified., body: map}\n@returns(200) Permissions removed successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: No role found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint GET /authz/roles/{id}\n@desc Get a role\n@required {id: any # The name of the role.}\n@returns(200) Successful response.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: No role found., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint DELETE /authz/roles/{id}\n@desc Delete a role\n@required {id: any # The name of the role.}\n@returns(204) Successfully deleted.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /authz/roles/{id}/has-permission\n@desc Check whether a role possesses a permission\n@required {id: any # The name of the role., body: map # The permissions to be checked.}\n@returns(200) Permission check was successful.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint GET /authz/roles/{id}/users\n@desc Get users assigned to a role\n@required {id: any # The name of the role.}\n@returns(200) Users assigned to this role.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: No role found., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint GET /authz/roles/{id}/user-assignments\n@desc Get users assigned to a role\n@required {id: any # The name (ID) of the role.}\n@returns(200) Users assigned to this role.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: No role found., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint GET /authz/roles/{id}/group-assignments\n@desc Get groups that have a specific role assigned\n@required {id: any # The unique name of the role.}\n@returns(200) Successfully retrieved the list of groups that have the role assigned.\n@errors {400: Bad request, 401: Unauthorized or invalid credentials., 403: Forbidden, 404: The specified role was not found., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint GET /authz/users/{id}/roles\n@desc Get roles assigned to a user\n@required {id: any # The name of the user.}\n@returns(200) Roles assigned to the user.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: No roles found for specified user., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint GET /authz/users/{id}/roles/{userType}\n@desc Get roles assigned to a user\n@required {id: any # The name of the user., userType: any # The type of the user.}\n@optional {includeFullRoles: any # Whether to include detailed role information like its assigned permissions.}\n@returns(200) Roles assigned to the user.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: No roles found for specified user., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /authz/users/{id}/assign\n@desc Assign a role to a user\n@required {id: any # The name of the user., body: map}\n@returns(200) Role assigned successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Specified role or user not found., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /authz/users/{id}/revoke\n@desc Revoke a role from a user\n@required {id: any # The name of the user., body: map}\n@returns(200) Roles revoked successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Specified role or user not found., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /authz/groups/{id}/assign\n@desc Assign a role to a group\n@required {id: any # The name of the group., body: map}\n@returns(200) Roles assigned successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Role or group not found., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /authz/groups/{id}/revoke\n@desc Revoke a role from a group\n@required {id: any # The name of the group., body: map}\n@returns(200) Roles revoked successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Role or group not found., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint GET /authz/groups/{id}/roles/{groupType}\n@desc Get roles assigned to a specific group\n@required {id: any # The unique name of the group., groupType: any # The type of the group.}\n@optional {includeFullRoles: any # If true, the response will include the full role definitions with all associated permissions. If false, only role names are returned.}\n@returns(200) A list of roles assigned to the specified group.\n@errors {400: Bad request, 401: Unauthorized or invalid credentials., 403: Forbidden, 404: The specified group was not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint GET /authz/groups/{groupType}\n@desc List all groups of a specific type\n@required {groupType: any # The type of group to retrieve.}\n@returns(200) A list of group names for the specified type.\n@errors {400: Bad request, 401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endgroup\n\n@group objects\n@endpoint GET /objects\n@desc List objects\n@optional {after: any # A threshold UUID of the objects to retrieve after, using an UUID-based ordering. This object is not part of the set. Must be used with collection name (`class`), typically in conjunction with `limit`. Note `after` cannot be used with `offset` or `sort`. For a null value similar to offset=0, set an empty string in the request, i.e. `after=` or `after`., offset: any # The starting index of the result window. Note `offset` will retrieve `offset+limit` results and return `limit` results from the object with index `offset` onwards. Limited by the value of `QUERY_MAXIMUM_RESULTS`. Should be used in conjunction with `limit`. Cannot be used with `after`., limit: any # The maximum number of items to be returned per page. The default is 25 unless set otherwise as an environment variable., include: any # Include additional information, such as classification information. Allowed values include: `classification`, `vector` and `interpretation`., sort: any # Name(s) of the property to sort by - e.g. `city`, or `country,city`., order: any # Order parameter to tell how to order (asc or desc) data within given field. Should be used in conjunction with `sort` parameter. If providing multiple `sort` values, provide multiple `order` values in corresponding order, e.g.: `sort=author_name,title&order=desc,asc`., class: any # The collection from which to query objects.  Note that if the collection name (`class`) is not provided, the response will not include any objects., tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(200) Successful response containing the list of objects. If the collection name (`class`) is not provided, the response will not include any objects.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Successful query result but no matching objects were found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the specified collection exists., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint POST /objects\n@desc Create an object\n@required {body: map # The object to be created.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful.}\n@returns(200) Object created successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the collection exists and the object properties are valid., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint DELETE /objects/{id}\n@desc Delete an object\n@required {id: any # Unique UUID of the object to be deleted.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful., tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(204) Object deleted successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object not found., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint GET /objects/{id}\n@desc Get an object\n@required {id: any # Unique UUID of the object to be retrieved.}\n@optional {include: any # Include additional information, such as classification information. Allowed values include: `classification`, `vector` and `interpretation`.}\n@returns(200) Successful response containing the object.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object not found., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint PATCH /objects/{id}\n@desc Patch an object\n@required {id: any # Unique UUID of the object to be patched.}\n@optional {body: map # RFC 7396-style JSON merge patch object containing the fields to update., consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful.}\n@returns(204) Object patched successfully.\n@errors {400: Malformed patch request body., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object not found., 422: The patch object is valid JSON but is unprocessable for other reasons (e.g., invalid schema)., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint PUT /objects/{id}\n@desc Update an object\n@required {id: any # Unique UUID of the object to be replaced., body: map # The object definition to replace the existing object with.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful.}\n@returns(200) Object replaced successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the collection exists and the object properties are valid., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint HEAD /objects/{id}\n@desc Check if an object exists\n@required {id: any # Unique UUID of the object to check.}\n@returns(204) Object exists.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object does not exist., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint GET /objects/{className}/{id}\n@desc Get an object\n@required {className: any # Name of the collection (class) the object belongs to., id: any # Unique UUID of the object to be retrieved.}\n@optional {include: any # Include additional information, such as classification information. Allowed values include: `classification`, `vector` and `interpretation`., consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful., node_name: any # The target node which should fulfill the request., tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(200) Successful response containing the object.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint DELETE /objects/{className}/{id}\n@desc Delete an object\n@required {className: any # Name of the collection (class) the object belongs to., id: any # Unique UUID of the object to be deleted.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful., tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(204) Object deleted successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint PUT /objects/{className}/{id}\n@desc Replace an object\n@required {className: any # Name of the collection (class) the object belongs to., id: any # Unique UUID of the object to be replaced., body: map # The object definition to replace the existing object with.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful.}\n@returns(200) Object replaced successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the collection exists and the object properties are valid., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint PATCH /objects/{className}/{id}\n@desc Patch an object\n@required {className: any # Name of the collection (class) the object belongs to., id: any # Unique UUID of the object to be patched.}\n@optional {body: map # RFC 7396-style JSON merge patch object containing the fields to update., consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful.}\n@returns(204) Object patched successfully.\n@errors {400: Malformed patch request body., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object not found., 422: The patch object is valid JSON but is unprocessable for other reasons (e.g., invalid schema)., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint HEAD /objects/{className}/{id}\n@desc Check if an object exists\n@required {className: any # Name of the collection (class) the object belongs to., id: any # Unique UUID of the object to check.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful., tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(204) Object exists.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object does not exist., 422: Invalid data provided. Please check the values in your request (e.g., invalid UUID format)., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint POST /objects/{id}/references/{propertyName}\n@desc Add an object reference\n@required {id: any # Unique UUID of the source object., propertyName: any # Unique name of the reference property of the source object., body: any # The reference to add.}\n@optional {tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(200) Reference added successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the property exists and is a reference type., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint PUT /objects/{id}/references/{propertyName}\n@desc Replace object references\n@required {id: any # Unique UUID of the source object., propertyName: any # Unique name of the reference property of the source object., body: [any] # The new list of references.}\n@optional {tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(200) References replaced successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the property exists and is a reference type., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint DELETE /objects/{id}/references/{propertyName}\n@desc Delete an object reference\n@required {id: any # Unique UUID of the source object., propertyName: any # Unique name of the reference property of the source object., body: any # The reference to remove.}\n@optional {tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(204) Reference deleted successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object or reference not found., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint POST /objects/{className}/{id}/references/{propertyName}\n@desc Add an object reference\n@required {className: any # Name of the collection (class) the source object belongs to., id: any # Unique UUID of the source object., propertyName: any # Unique name of the reference property of the source object., body: any # The reference to add.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful., tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(200) Reference added successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Source object not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the property exists and is a reference type., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint PUT /objects/{className}/{id}/references/{propertyName}\n@desc Replace object references\n@required {className: any # Name of the collection (class) the source object belongs to., id: any # Unique UUID of the source object., propertyName: any # Unique name of the reference property of the source object., body: [any] # The new list of references.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful., tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(200) References replaced successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Source object not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the property exists and is a reference type., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint DELETE /objects/{className}/{id}/references/{propertyName}\n@desc Delete an object reference\n@required {className: any # Name of the collection (class) the source object belongs to., id: any # Unique UUID of the source object., propertyName: any # Unique name of the reference property of the source object., body: any # The reference to remove.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful., tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(204) Reference deleted successfully.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Object or reference not found., 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the property exists and is a reference type., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint POST /objects/validate\n@desc Validate an object\n@required {body: map # The object definition to validate.}\n@returns(200) Object is valid according to the schema.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Request body is well-formed but the object is invalid according to the schema., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endgroup\n\n@group batch\n@endpoint POST /batch/objects\n@desc Create objects in batch\n@required {body: map # The request body containing the objects to be created.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful.}\n@returns(200) Request processed successfully. Individual object statuses are provided in the response body.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the collection exists and the object properties are valid., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint DELETE /batch/objects\n@desc Delete objects in batch\n@required {body: map # The request body containing the match filter and output configuration.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful., tenant: any # Specifies the tenant in a request targeting a multi-tenant collection (class).}\n@returns(200) Request processed successfully. See response body for matching objects and deletion results.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid data provided. Please check the values in your request (e.g., invalid filter)., 500: An error occurred while trying to fulfill the request. Check the ErrorResponse for details.}\n\n@endpoint POST /batch/references\n@desc Create cross-references in bulk\n@required {body: [any] # A list of references to be batched. The ideal size depends on the used database connector. Please see the documentation of the used connector for help.}\n@optional {consistency_level: any # Determines how many replicas must acknowledge a request before it is considered successful.}\n@returns(200) Request Successful. Warning: A successful request does not guarantee that every batched reference was successfully created. Inspect the response body to see which references succeeded and which failed.\n@errors {400: Malformed request., 401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the collection exists and the object properties are valid., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endgroup\n\n@group graphql\n@endpoint POST /graphql\n@desc Perform a GraphQL query\n@required {body: map # The GraphQL query to execute, including the query string and optional variables.}\n@returns(200) Query executed successfully. The response body contains the query result.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An internal server error occurred during query execution. Check the ErrorResponse for details.}\n\n@endpoint POST /graphql/batch\n@desc Perform batched GraphQL queries\n@required {body: [map] # An array containing multiple GraphQL query objects to execute in batch.}\n@returns(200) Batch request processed successfully. The response body contains an array of results corresponding to the input queries.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request., 500: An internal server error occurred during batch query execution. Check the ErrorResponse for details.}\n\n@endgroup\n\n@group meta\n@endpoint GET /meta\n@desc Get instance metadata\n@returns(200) Successfully retrieved meta information.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 500: An internal server error occurred while retrieving meta information. Check the ErrorResponse for details.}\n\n@endgroup\n\n@group tokenize\n@endpoint POST /tokenize\n@desc Tokenize text\n@required {body: map}\n@returns(200) Successfully tokenized the text.\n@errors {400: Invalid or malformed request body., 401: Unauthorized or invalid credentials., 403: Forbidden, 422: Request binding or validation error. Check the ErrorResponse for details., 500: An unexpected error occurred while tokenizing the text. Check the ErrorResponse for details.}\n\n@endgroup\n\n@group schema\n@endpoint GET /schema\n@desc Get all collection definitions\n@optional {consistency: any # If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true.}\n@returns(200) Successfully retrieved the database schema.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 500: An error occurred while retrieving the schema. Check the ErrorResponse for details.}\n\n@endpoint POST /schema\n@desc Create a new collection\n@required {objectClass: map # The definition of the collection (class) to create.}\n@returns(200) Collection created successfully and its definition returned.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid collection definition provided. Check the definition structure and properties., 500: An error occurred during collection creation. Check the ErrorResponse for details.}\n\n@endpoint GET /schema/{className}\n@desc Get a single collection\n@required {className: any # The name of the collection (class) to retrieve.}\n@optional {consistency: any # If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true.}\n@returns(200) Successfully retrieved the collection definition.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Collection not found., 500: An error occurred while retrieving the collection definition. Check the ErrorResponse for details.}\n\n@endpoint DELETE /schema/{className}\n@desc Delete a collection (and all associated data)\n@required {className: any # The name of the collection (class) to delete.}\n@returns(200) Collection deleted successfully.\n@errors {400: Could not delete the collection. See the error response for details., 401: Unauthorized or invalid credentials., 403: Forbidden, 500: An error occurred during collection deletion. Check the ErrorResponse for details.}\n\n@endpoint PUT /schema/{className}\n@desc Update collection definition\n@required {className: any # The name of the collection (class) to update., objectClass: map # The updated collection definition containing the settings to modify.}\n@returns(200) Collection settings updated successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Collection not found., 422: Invalid update attempt., 500: An error occurred while updating the collection. Check the ErrorResponse for details.}\n\n@endpoint POST /schema/{className}/properties\n@desc Add a property to a collection\n@required {className: any # The name of the collection (class) to add the property to., body: map # The definition of the property to add.}\n@returns(200) Property added successfully and its definition returned.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid property definition provided., 500: An error occurred while adding the property. Check the ErrorResponse for details.}\n\n@endpoint DELETE /schema/{className}/properties/{propertyName}/index/{indexName}\n@desc Delete a property's inverted index\n@required {className: any # The name of the collection (class) containing the property., propertyName: any # The name of the property whose inverted index should be deleted., indexName: any # The name of the inverted index to delete from the property.}\n@returns(200) Index deleted successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid index, property or collection provided., 500: An error occurred while deleting the index. Check the ErrorResponse for details.}\n\n@endpoint POST /schema/{className}/properties/{propertyName}/tokenize\n@desc Tokenize text using a property's configuration\n@required {className: any # The name of the collection (class) containing the property., propertyName: any # The name of the property whose tokenization configuration should be used., body: map}\n@returns(200) Successfully tokenized the text using the property's configuration.\n@errors {400: Invalid request body, missing required fields, or property does not have tokenization configured., 401: Unauthorized or invalid credentials., 403: Forbidden, 404: Collection or property not found., 422: Validation error, such as invalid class or property configuration for tokenization., 500: Unexpected server error while tokenizing the text.}\n\n@endpoint DELETE /schema/{className}/vectors/{vectorIndexName}/index\n@desc Delete a collection's vector index.\n@required {className: any # The name of the collection (class) containing the property., vectorIndexName: any # The name of the vector index.}\n@returns(200) Vector index deleted successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid vector index or collection provided., 500: An error occurred while deleting the vector index. Check the ErrorResponse for details.}\n\n@endpoint GET /schema/{className}/shards\n@desc Get the shards status of a collection\n@required {className: any # The name of the collection (class) whose shards to query.}\n@optional {tenant: any # The name of the tenant for which to retrieve shard statuses (only applicable for multi-tenant collections).}\n@returns(200) Shard statuses retrieved successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Collection not found., 500: An error occurred while retrieving shard statuses. Check the ErrorResponse for details.}\n\n@endpoint PUT /schema/{className}/shards/{shardName}\n@desc Update a shard status\n@required {className: any # The name of the collection (class) containing the shard., shardName: any # The name of the shard to update., body: any # The shard status object containing the desired new status.}\n@returns(200) Shard status updated successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Collection or shard not found., 422: Invalid update attempt, 500: An error occurred while updating the shard status. Check the ErrorResponse for details.}\n\n@endpoint POST /schema/{className}/tenants\n@desc Create a new tenant\n@required {className: any # The name of the multi-tenant enabled collection (class)., body: [map] # An array of tenant objects to create.}\n@returns(200) Tenants created successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid request., 500: An error occurred while creating tenants. Check the ErrorResponse for details.}\n\n@endpoint PUT /schema/{className}/tenants\n@desc Update a tenant\n@required {className: any # The name of the collection (class) containing the tenants., body: [map] # An array of tenant objects specifying the tenants to update and their desired new status.}\n@returns(200) Tenant statuses updated successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid update request., 500: An error occurred while updating tenants. Check the ErrorResponse for details.}\n\n@endpoint DELETE /schema/{className}/tenants\n@desc Delete tenants\n@required {className: any # The name of the collection (class) from which to delete tenants., tenants: [str] # An array of tenant names to delete.}\n@returns(200) Tenants deleted successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid request., 500: An error occurred while deleting tenants. Check the ErrorResponse for details.}\n\n@endpoint GET /schema/{className}/tenants\n@desc Get the list of tenants\n@required {className: any # The name of the collection (class) whose tenants to list.}\n@optional {consistency: any # If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true.}\n@returns(200) Successfully retrieved tenants.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid request., 500: An error occurred while listing tenants. Check the ErrorResponse for details.}\n\n@endpoint HEAD /schema/{className}/tenants/{tenantName}\n@desc Check if a tenant exists\n@required {className: any # The name of the collection (class) to check within., tenantName: any # The name of the tenant to check for.}\n@optional {consistency: any # If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true.}\n@returns(200) The tenant exists in the specified collection.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Tenant or collection not found., 422: Invalid request., 500: An error occurred during the check. Check the ErrorResponse for details.}\n\n@endpoint GET /schema/{className}/tenants/{tenantName}\n@desc Get a specific tenant\n@required {className: any # The name of the collection (class) containing the tenant., tenantName: any # The name of the tenant to retrieve.}\n@optional {consistency: any # If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true.}\n@returns(200) Successfully retrieved tenant details.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Tenant or collection not found., 422: Invalid request., 500: An error occurred while retrieving the tenant. Check the ErrorResponse for details.}\n\n@endgroup\n\n@group aliases\n@endpoint GET /aliases\n@desc List aliases\n@optional {class: any # Optional filter to retrieve aliases for a specific collection (class) only. If not provided, returns all aliases.}\n@returns(200) Successfully retrieved the list of aliases\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid collection (class) parameter provided, 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint POST /aliases\n@desc Create a new alias\n@required {body: map}\n@returns(200) Successfully created a new alias for the specified collection (class)\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid create alias request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint GET /aliases/{aliasName}\n@desc Get an alias\n@required {aliasName: any}\n@returns(200) Successfully retrieved the alias details.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Not Found - Alias does not exist, 422: Invalid alias name provided., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint PUT /aliases/{aliasName}\n@desc Update an alias\n@required {aliasName: any, body: map}\n@returns(200) Successfully updated the alias to point to the new collection (class).\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Not Found - Alias does not exist, 422: Invalid update alias request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endpoint DELETE /aliases/{aliasName}\n@desc Delete an alias\n@required {aliasName: any}\n@returns(204) Successfully deleted the alias.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Not Found - Alias does not exist, 422: Invalid delete alias request., 500: An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.}\n\n@endgroup\n\n@group backups\n@endpoint POST /backups/{backend}\n@desc Create a backup\n@required {backend: any # Specifies the backend storage system where the backup will be stored (e.g., `filesystem`, `gcs`, `s3`, `azure`)., body: any # Details of the backup request, including the backup ID and collections to include or exclude.}\n@returns(200) Backup creation process initiated successfully. Check the status endpoint for progress.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid backup creation request. Check the request body and backend configuration., 500: An internal server error occurred during backup initiation. Check the ErrorResponse for details.}\n\n@endpoint GET /backups/{backend}\n@desc List all created backups\n@required {backend: any # Specifies the backend storage system to list backups from (e.g., `filesystem`, `gcs`, `s3`, `azure`).}\n@optional {order: any # Order of returned list of backups based on creation time. (asc or desc)}\n@returns(200) Successfully retrieved the list of backups in progress.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid request to list backups., 500: An internal server error occurred while listing backups. Check the ErrorResponse for details.}\n\n@endpoint GET /backups/{backend}/{id}\n@desc Get backup creation status\n@required {backend: any # Specifies the backend storage system where the backup resides (e.g., `filesystem`, `gcs`, `s3`, `azure`)., id: any # The unique identifier of the backup. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed).}\n@optional {bucket: any # Optional: Specifies the bucket, container, or volume name if required by the backend., path: any # Optional: Specifies the path within the bucket/container/volume if the backup is not at the root.}\n@returns(200) Successfully retrieved the status of the backup creation process.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Backup not found on the specified backend with the given ID., 422: Invalid request to check backup creation status., 500: An internal server error occurred while checking backup status. Check the ErrorResponse for details.}\n\n@endpoint DELETE /backups/{backend}/{id}\n@desc Cancel a backup\n@required {backend: any # Specifies the backend storage system where the backup resides (e.g., `filesystem`, `gcs`, `s3`, `azure`)., id: any # The unique identifier of the backup to cancel. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed).}\n@optional {bucket: any # Optional: Specifies the bucket, container, or volume name if required by the backend., path: any # Optional: Specifies the path within the bucket/container/volume if the backup is not at the root.}\n@returns(204) Backup canceled successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid backup cancellation request., 500: An internal server error occurred during backup cancellation. Check the ErrorResponse for details.}\n\n@endpoint POST /backups/{backend}/{id}/restore\n@desc Restore from a backup\n@required {backend: any # Specifies the backend storage system where the backup resides (e.g., `filesystem`, `gcs`, `s3`, `azure`)., id: any # The unique identifier of the backup to restore from. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed)., body: any # Details of the restore request, including collections to include or exclude and node mapping if necessary.}\n@returns(200) Backup restoration process initiated successfully. Check the status endpoint for progress.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Backup not found on the specified backend with the given ID., 422: Invalid backup restoration request. Check requirements and request body., 500: An internal server error occurred during restore initiation. Check the ErrorResponse for details.}\n\n@endpoint GET /backups/{backend}/{id}/restore\n@desc Get backup restoration status\n@required {backend: any # Specifies the backend storage system where the backup resides (e.g., `filesystem`, `gcs`, `s3`, `azure`)., id: any # The unique identifier of the backup being restored. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed).}\n@optional {bucket: any # Optional: Specifies the bucket, container, or volume name if required by the backend., path: any # Optional: Specifies the path within the bucket.}\n@returns(200) Successfully retrieved the status of the backup restoration process.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Backup not found on the specified backend with the given ID., 500: An internal server error occurred while checking restore status. Check the ErrorResponse for details.}\n\n@endpoint DELETE /backups/{backend}/{id}/restore\n@desc Cancel a backup restoration\n@required {backend: any # Specifies the backend storage system where the backup resides (e.g., `filesystem`, `gcs`, `s3`, `azure`)., id: any # The unique identifier of the backup restoration to cancel. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed).}\n@optional {bucket: any # Optional: Specifies the bucket, container, or volume name if required by the backend., path: any # Optional: Specifies the path within the bucket/container/volume if the backup is not at the root.}\n@returns(204) Backup restoration cancelled successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid backup restoration cancellation request., 500: An internal server error occurred during backup restoration cancellation. Check the ErrorResponse for details.}\n\n@endgroup\n\n@group export\n@endpoint POST /export/{backend}\n@desc Start a new export\n@required {backend: any # The backend storage system to use for the export (e.g., `filesystem`, `gcs`, `s3`, `azure`)., body: map}\n@returns(200) Successfully started export operation\n@errors {401: Unauthorized or invalid credentials, 403: Forbidden - insufficient permissions, 409: Export already exists or another export is already in progress, 422: Invalid export request, 500: Internal server error occurred while starting export}\n\n@endpoint GET /export/{backend}/{id}\n@desc Get export status\n@required {backend: any # The backend storage system where the export is stored., id: any # The unique identifier of the export.}\n@optional {path: any # Optional path prefix within the bucket. If not specified, uses the backend's default path.}\n@returns(200) Successfully retrieved export status\n@errors {401: Unauthorized or invalid credentials, 403: Forbidden - insufficient permissions, 404: Export not found, 422: Invalid request (e.g., unsupported backend), 500: Internal server error occurred while retrieving export status}\n\n@endpoint DELETE /export/{backend}/{id}\n@desc Cancel an export\n@required {backend: any # The backend storage system where the export is stored., id: any # The unique identifier of the export to cancel.}\n@optional {path: any # Optional path prefix within the bucket.}\n@returns(204) Export cancelled successfully.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden - insufficient permissions, 404: Export not found, 409: Export has already finished and cannot be cancelled, 422: Invalid request (e.g., unsupported backend), 500: Internal server error occurred while cancelling export}\n\n@endgroup\n\n@group cluster\n@endpoint GET /cluster/statistics\n@desc Get cluster statistics\n@returns(200) Successfully retrieved Raft cluster statistics.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 422: Invalid request for cluster statistics., 500: An internal server error occurred while retrieving cluster statistics. Check the ErrorResponse for details.}\n\n@endgroup\n\n@group nodes\n@endpoint GET /nodes\n@desc Get node status\n@optional {output: any # Controls the verbosity of the output, possible values are: `minimal`, `verbose`. Defaults to `minimal`.}\n@returns(200) Successfully retrieved the status for all nodes.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Not Found., 422: Invalid request for node status., 500: An internal server error occurred while retrieving node status. Check the ErrorResponse for details.}\n\n@endpoint GET /nodes/{className}\n@desc Get node status by collection\n@required {className: any # The name of the collection (class) for which to retrieve node status.}\n@optional {shardName: any, output: any # Controls the verbosity of the output, possible values are: `minimal`, `verbose`. Defaults to `minimal`.}\n@returns(200) Successfully retrieved the status for nodes relevant to the specified collection.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Not Found., 422: Invalid request for node status., 500: An internal server error occurred while retrieving node status for the collection. Check the ErrorResponse for details.}\n\n@endgroup\n\n@group tasks\n@endpoint GET /tasks\n@desc Lists all distributed tasks in the cluster\n@returns(200) Distributed tasks successfully returned.\n@errors {403: Unauthorized or invalid credentials., 500: An internal server error occurred while retrieving distributed tasks. Check the ErrorResponse for details.}\n\n@endgroup\n\n@group classifications\n@endpoint POST /classifications/\n@desc Start a classification\n@required {params: map # Configuration parameters for the classification task, including type, target properties, and training data references.}\n@returns(201) Classification task successfully initiated. The response body contains the classification details including its ID.\n@errors {400: Invalid request body or parameters., 401: Unauthorized or invalid credentials., 403: Forbidden, 500: An internal server error occurred while starting the classification task. Check the ErrorResponse for details.}\n\n@endpoint GET /classifications/{id}\n@desc Get classification status\n@required {id: any # The unique identifier (UUID) of the classification task.}\n@returns(200) Successfully retrieved the classification details.\n@errors {401: Unauthorized or invalid credentials., 403: Forbidden, 404: Classification with the given ID not found., 500: An internal server error occurred while retrieving the classification status. Check the ErrorResponse for details.}\n\n@endgroup\n\n@group mcp\n@endpoint POST /mcp\n@desc MCP Streamable HTTP endpoint. Handles JSON-RPC requests for tool discovery and invocation.\n@returns(200) JSON-RPC response or SSE stream\n\n@endpoint GET /mcp\n@desc Opens an SSE stream for receiving MCP server-sent events.\n@returns(200) SSE event stream\n\n@endpoint DELETE /mcp\n@desc Terminates an MCP session.\n@returns(200) Session terminated\n\n@endgroup\n\n@end\n"}