{ "openapi": "3.1.0", "info": { "title": "HydraDB API", "description": "REST APIs for the HydraDB retrieval engine", "version": "0.0.1" }, "servers": [ { "url": "https://api.hydradb.com", "description": "Production", "x-fern-server-name": "hydradb-prod" } ], "paths": { "/metrics": { "get": { "summary": "Metrics", "operationId": "metrics_metrics_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/ingestion/upload_knowledge": { "post": { "tags": [ "ingestion" ], "summary": "Upload Knowledge", "operationId": "upload_knowledge_ingestion_upload_knowledge_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_knowledge_ingestion_upload_knowledge_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceUploadResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "upload", "x-fern-sdk-method-name": "knowledge", "x-fern-sdk-audience": [ "public" ] } }, "/ingestion/verify_processing": { "post": { "tags": [ "ingestion" ], "summary": "Verify Processing", "operationId": "verify_processing_ingestion_verify_processing_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "file_id", "in": "query", "required": false, "deprecated": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Single file ID (deprecated - use file_ids instead).", "title": "File Id", "example": "" }, "description": "Single file ID (deprecated - use file_ids instead)." }, { "name": "file_ids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "One or more file IDs to check processing status for.", "default": [], "title": "File Ids", "example": "" }, "description": "One or more file IDs to check processing status for." }, { "name": "tenant_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Unique identifier for the tenant/organization", "default": "", "title": "Tenant Id", "example": "tenant_1234" }, "description": "Unique identifier for the tenant/organization" }, { "name": "sub_tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.", "title": "Sub Tenant Id", "example": "sub_tenant_4567" }, "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchProcessingStatus" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "x-fern-sdk-group-name": "upload", "x-fern-sdk-method-name": "verify_processing", "x-fern-sdk-audience": [ "public" ] } }, "/tenants/create": { "post": { "tags": [ "tenants" ], "summary": "Create Tenant", "operationId": "create_tenant_tenants_create_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantCreateAcceptedResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "tenant", "x-fern-sdk-method-name": "create", "x-fern-sdk-audience": [ "public" ] } }, "/tenants/sub_tenant_ids": { "get": { "tags": [ "tenants" ], "summary": "Get Sub Tenant Ids", "operationId": "get_sub_tenant_ids_tenants_sub_tenant_ids_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Unique identifier for the tenant/organization", "title": "Tenant Id", "example": "tenant_1234" }, "description": "Unique identifier for the tenant/organization" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubTenantIdsResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "x-fern-sdk-group-name": "tenant", "x-fern-sdk-method-name": "get_sub_tenant_ids", "x-fern-sdk-audience": [ "public" ] } }, "/tenants/infra/status": { "get": { "tags": [ "tenants", "tenants", "Monitor & infra status" ], "summary": "Get Infra Status", "operationId": "get_infra_status_tenants_infra_status_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Unique identifier for the tenant/organization", "title": "Tenant Id", "example": "tenant_1234" }, "description": "Unique identifier for the tenant/organization" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfraStatusResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "x-fern-sdk-group-name": "tenant", "x-fern-sdk-method-name": "get_infra_status", "x-fern-sdk-audience": [ "public" ] } }, "/tenants/delete": { "delete": { "tags": [ "tenants" ], "summary": "Delete Tenant", "operationId": "delete_tenant_tenants_delete_delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Unique identifier for the tenant/organization", "title": "Tenant Id", "example": "tenant_1234" }, "description": "Unique identifier for the tenant/organization" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDeleteResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "x-fern-sdk-group-name": "tenant", "x-fern-sdk-method-name": "delete_tenant", "x-fern-sdk-audience": [ "public" ] } }, "/tenants/monitor": { "get": { "tags": [ "tenants", "tenants", "Monitor & infra status" ], "summary": "Get Tenant Stats", "operationId": "get_tenant_stats_tenants_monitor_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Unique identifier for the tenant/organization", "title": "Tenant Id", "example": "tenant_1234" }, "description": "Unique identifier for the tenant/organization" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantStatsResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "x-fern-sdk-group-name": "tenant", "x-fern-sdk-method-name": "monitor", "x-fern-sdk-audience": [ "public" ] } }, "/api-keys/create_api_key": { "post": { "tags": [ "api-keys" ], "summary": "Create Api Key", "operationId": "create_api_key_api_keys_create_api_key_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "x-fern-sdk-group-name": "key", "x-fern-sdk-method-name": "create_api_key", "x-fern-sdk-audience": [ "public" ] } }, "/embeddings/insert_raw_embeddings": { "post": { "tags": [ "embeddings" ], "summary": "Insert Raw Embeddings Endpoint", "operationId": "insert_raw_embeddings_endpoint_embeddings_insert_raw_embeddings_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_insert_raw_embeddings_endpoint_embeddings_insert_raw_embeddings_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertResult" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "embeddings", "x-fern-sdk-method-name": "insert", "x-fern-sdk-audience": [ "public" ] } }, "/embeddings/search_raw_embeddings": { "post": { "tags": [ "embeddings" ], "summary": "Search Raw Embeddings Endpoint", "operationId": "search_raw_embeddings_endpoint_embeddings_search_raw_embeddings_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_search_raw_embeddings_endpoint_embeddings_search_raw_embeddings_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RawEmbeddingSearchResult" }, "type": "array", "title": "Response Search Raw Embeddings Endpoint Embeddings Search Raw Embeddings Post" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "embeddings", "x-fern-sdk-method-name": "search", "x-fern-sdk-audience": [ "public" ] } }, "/embeddings/filter_raw_embeddings": { "post": { "tags": [ "embeddings" ], "summary": "Filter Raw Embeddings Endpoint", "operationId": "filter_raw_embeddings_endpoint_embeddings_filter_raw_embeddings_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_filter_raw_embeddings_endpoint_embeddings_filter_raw_embeddings_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RawEmbeddingSearchResult" }, "type": "array", "title": "Response Filter Raw Embeddings Endpoint Embeddings Filter Raw Embeddings Post" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "embeddings", "x-fern-sdk-method-name": "filter", "x-fern-sdk-audience": [ "public" ] } }, "/embeddings/delete_raw_embeddings": { "delete": { "tags": [ "embeddings" ], "summary": "Delete Raw Embeddings Endpoint", "operationId": "delete_raw_embeddings_endpoint_embeddings_delete_raw_embeddings_delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Unique identifier for the tenant/organization", "title": "Tenant Id", "example": "tenant_1234" }, "description": "Unique identifier for the tenant/organization" }, { "name": "sub_tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional sub-tenant ID for scoping deletion", "title": "Sub Tenant Id", "example": "sub_tenant_4567" }, "description": "Optional sub-tenant ID for scoping deletion" }, { "name": "source_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional source ID to delete by (mutually exclusive with chunk_ids)", "title": "Source Id", "example": "" }, "description": "Optional source ID to delete by (mutually exclusive with chunk_ids)" }, { "name": "chunk_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Optional list of chunk IDs to delete (mutually exclusive with source_id)", "title": "Chunk Ids", "example": [ "HydraEmbeddings123_0", "HydraEmbeddings123_1" ] }, "description": "Optional list of chunk IDs to delete (mutually exclusive with source_id)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResult" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "x-fern-sdk-group-name": "embeddings", "x-fern-sdk-method-name": "delete", "x-fern-sdk-audience": [ "public" ] } }, "/list/data": { "post": { "tags": [ "list" ], "summary": "List Content", "operationId": "list_content_list_data_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListContentRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SourceListResponse" }, { "$ref": "#/components/schemas/ListUserMemoriesResponse" } ], "title": "Response List Content List Data Post" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "fetch", "x-fern-sdk-method-name": "list_data", "x-fern-sdk-audience": [ "public" ] } }, "/list/graph_relations_by_id": { "get": { "tags": [ "list" ], "summary": "Graph Relations By Id", "operationId": "graph_relations_by_id_list_graph_relations_by_id_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "source_id", "in": "query", "required": true, "schema": { "type": "string", "description": "The source ID to fetch relations for", "title": "Source Id", "example": "" }, "description": "The source ID to fetch relations for" }, { "name": "tenant_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Unique identifier for the tenant/organization", "default": "", "title": "Tenant Id", "example": "tenant_1234" }, "description": "Unique identifier for the tenant/organization" }, { "name": "is_memory", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to fetch relations for memories", "default": false, "title": "Is Memory", "example": "" }, "description": "Whether to fetch relations for memories" }, { "name": "sub_tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.", "title": "Sub Tenant Id", "example": "sub_tenant_4567" }, "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum number of relations to return", "default": 250, "title": "Limit", "example": "" }, "description": "Maximum number of relations to return" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceGraphRelationsResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "x-fern-sdk-group-name": "fetch", "x-fern-sdk-method-name": "graph_relations_by_source_id", "x-fern-sdk-audience": [ "public" ] } }, "/knowledge/delete_knowledge": { "post": { "tags": [ "delete" ], "summary": "Delete Source", "operationId": "delete_source_knowledge_delete_knowledge_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDeleteRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDeleteResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "data", "x-fern-sdk-method-name": "delete", "x-fern-sdk-audience": [ "public" ] } }, "/fetch/content": { "post": { "tags": [ "fetch" ], "summary": "Fetch Source", "operationId": "fetch_source_fetch_content_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceFetchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceFetchResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cortex__models__response__commons__ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "fetch", "x-fern-sdk-method-name": "content", "x-fern-sdk-audience": [ "public" ] } }, "/recall/full_recall": { "post": { "tags": [ "Search" ], "summary": "Full recall for knowledge base", "operationId": "full_recall_recall_full_recall_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecallSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalResult" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "429": { "description": "Too Many Requests - Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "recall", "x-fern-sdk-method-name": "full_recall", "x-fern-sdk-audience": [ "public" ] } }, "/recall/recall_preferences": { "post": { "tags": [ "Search" ], "summary": "Recall preferences (memories)", "operationId": "recall_preferences_recall_recall_preferences_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecallSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalResult" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "429": { "description": "Too Many Requests - Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "recall", "x-fern-sdk-method-name": "recall_preferences", "x-fern-sdk-audience": [ "public" ] } }, "/recall/boolean_recall": { "post": { "tags": [ "Search" ], "summary": "Full-text search", "operationId": "full_text_search_recall_boolean_recall_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullTextSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalResult" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "429": { "description": "Too Many Requests - Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "recall", "x-fern-sdk-method-name": "boolean_recall", "x-fern-sdk-audience": [ "public" ] } }, "/memories/add_memory": { "post": { "tags": [ "Memories" ], "summary": "Add memory", "operationId": "add_memory_memories_add_memory_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_add_memory_memories_add_memory_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddMemoryResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ], "x-fern-sdk-group-name": "upload", "x-fern-sdk-method-name": "add_memory", "x-fern-sdk-audience": [ "public" ] } }, "/memories/delete_memory": { "delete": { "tags": [ "Memories" ], "summary": "Delete memory", "operationId": "delete_memory_memories_delete_memory_delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Tenant ID", "title": "Tenant Id", "example": "tenant_1234" }, "description": "Tenant ID" }, { "name": "memory_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Unique identifier of the memory to delete", "title": "Memory Id", "example": "memory_1234" }, "description": "Unique identifier of the memory to delete" }, { "name": "sub_tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sub-tenant ID", "title": "Sub Tenant Id", "example": "sub_tenant_4567" }, "description": "Sub-tenant ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteUserMemoryResponse" } } } }, "400": { "description": "Bad Request - Invalid input parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "403": { "description": "Forbidden - Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "404": { "description": "Not Found - Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualErrorResponse" } } } } }, "x-fern-sdk-group-name": "upload", "x-fern-sdk-method-name": "delete_memory", "x-fern-sdk-audience": [ "public" ] } } }, "components": { "schemas": { "ActualErrorResponse": { "properties": { "detail": { "$ref": "#/components/schemas/ErrorResponse" } }, "type": "object", "required": [ "detail" ], "title": "ActualErrorResponse" }, "AddMemoryResponse": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true, "example": true }, "message": { "type": "string", "title": "Message", "default": "Memories queued for ingestion successfully" }, "results": { "items": { "$ref": "#/components/schemas/MemoryResultItem" }, "type": "array", "title": "Results", "description": "List of results for each ingested memory item.", "example": [] }, "success_count": { "type": "integer", "title": "Success Count", "description": "Number of items successfully queued for ingestion.", "default": 0, "example": 1 }, "failed_count": { "type": "integer", "title": "Failed Count", "description": "Number of items that failed to queue.", "default": 0, "example": 1 } }, "type": "object", "title": "AddMemoryResponse", "description": "Response model for add_memory endpoint." }, "ApiKeyCreateRequest": { "properties": { "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner", "description": "Owner identifier (e.g. email). Defaults to authenticated user's email." }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes", "description": "Optional list of scopes (e.g. ['ingest', 'query']). Omit or leave empty for now.", "example": [] }, "env": { "type": "string", "pattern": "^(live|test)$", "title": "Env", "description": "Environment tag embedded into the key (live or test).", "default": "live", "example": "" }, "prefix": { "type": "string", "minLength": 1, "title": "Prefix", "description": "Key prefix, e.g. 'sk'.", "default": "sk", "example": "" } }, "type": "object", "title": "ApiKeyCreateRequest" }, "ApiKeyCreateResponse": { "properties": { "api_key_id": { "type": "string", "title": "Api Key Id", "description": "Identifier used for API key lookup.", "example": "" }, "owner": { "type": "string", "title": "Owner", "description": "Owner identifier for the key.", "example": "" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes", "description": "Assigned scopes (if any).", "example": [] }, "env": { "type": "string", "title": "Env", "description": "Environment tag embedded into the key.", "example": "" }, "full_api_key": { "type": "string", "title": "Full Api Key", "description": "The full API key (shown only once). Store this securely.", "example": "" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Creation timestamp (UTC).", "example": "" } }, "type": "object", "required": [ "api_key_id", "owner", "env", "full_api_key", "created_at" ], "title": "ApiKeyCreateResponse" }, "AttachmentModel": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the attachment.", "default": "", "example": "HydraDoc1234" }, "url": { "type": "string", "title": "Url", "description": "Public or internal URL referencing the attachment resource.", "default": "", "example": "" }, "title": { "type": "string", "title": "Title", "description": "Human-readable title or filename of the attachment.", "default": "", "example": "" }, "content_type": { "type": "string", "title": "Content Type", "description": "MIME type of the attachment (e.g., application/pdf).", "default": "", "example": "<content_type>" }, "content_url": { "type": "string", "title": "Content Url", "description": "Direct URL for content retrieval when different from the reference URL.", "default": "", "example": "<content_url>" }, "misc": { "additionalProperties": true, "type": "object", "title": "Misc", "description": "Additional attachment attributes defined by the tenant (free-form)." }, "content": { "$ref": "#/components/schemas/ContentModel", "description": "Structured content payload for the attachment when available." } }, "type": "object", "title": "AttachmentModel" }, "BM25OperatorType": { "type": "string", "enum": [ "or", "and", "phrase" ], "title": "BM25OperatorType" }, "BatchProcessingStatus": { "properties": { "statuses": { "items": { "$ref": "#/components/schemas/ProcessingStatus" }, "type": "array", "title": "Statuses", "description": "List of processing statuses, one per requested file ID.", "example": [] } }, "type": "object", "required": [ "statuses" ], "title": "BatchProcessingStatus" }, "Body_add_memory_memories_add_memory_post": { "properties": { "memories": { "items": { "$ref": "#/components/schemas/MemoryItem" }, "type": "array", "minItems": 1, "title": "Memories", "description": "List of memory items to ingest", "example": [] }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Unique identifier for the tenant/organization", "example": "tenant_1234" }, "sub_tenant_id": { "type": "string", "title": "Sub Tenant Id", "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.", "default": "", "example": "sub_tenant_4567" }, "upsert": { "type": "boolean", "title": "Upsert", "description": "If true, update existing sources with the same source_id.", "default": true, "example": true } }, "type": "object", "required": [ "memories", "tenant_id" ], "title": "Body_add_memory_memories_add_memory_post" }, "Body_filter_raw_embeddings_endpoint_embeddings_filter_raw_embeddings_post": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Unique identifier for the tenant/organization", "example": "tenant_1234" }, "sub_tenant_id": { "type": "string", "title": "Sub Tenant Id", "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.", "example": "sub_tenant_4567" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id", "description": "Optional source ID to filter by (mutually exclusive with chunk_ids)" }, "chunk_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Chunk Ids", "description": "Optional list of chunk IDs to filter by (mutually exclusive with source_id)", "example": [ "HydraEmbeddings123_0", "HydraEmbeddings123_1" ] }, "output_fields": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Output Fields", "description": "Optional list of fields to return in results (default: chunk_id, source_id, metadata)" }, "limit": { "type": "integer", "maximum": 10000.0, "minimum": 1.0, "title": "Limit", "description": "Maximum number of results to return", "default": 100, "example": 1 } }, "type": "object", "required": [ "tenant_id", "sub_tenant_id" ], "title": "Body_filter_raw_embeddings_endpoint_embeddings_filter_raw_embeddings_post" }, "Body_insert_raw_embeddings_endpoint_embeddings_insert_raw_embeddings_post": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Unique identifier for the tenant/organization", "example": "tenant_1234" }, "sub_tenant_id": { "type": "string", "title": "Sub Tenant Id", "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.", "default": "", "example": "sub_tenant_4567" }, "embeddings": { "items": { "$ref": "#/components/schemas/RawEmbeddingDocument" }, "type": "array", "title": "Embeddings", "description": "List of raw embedding documents to insert", "example": [ [ 0.123413, 0.655367, 0.987654, 0.123456, 0.789012 ], [ 0.123413, 0.655367, 0.987654, 0.123456, 0.789012 ] ] }, "upsert": { "type": "boolean", "title": "Upsert", "description": "If True, update existing embeddings; if False, insert only", "default": false, "example": true } }, "type": "object", "required": [ "tenant_id", "embeddings" ], "title": "Body_insert_raw_embeddings_endpoint_embeddings_insert_raw_embeddings_post" }, "Body_search_raw_embeddings_endpoint_embeddings_search_raw_embeddings_post": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Unique identifier for the tenant/organization", "example": "tenant_1234" }, "sub_tenant_id": { "type": "string", "title": "Sub Tenant Id", "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.", "example": "sub_tenant_4567" }, "query_embedding": { "items": { "type": "number" }, "type": "array", "title": "Query Embedding", "description": "Query embedding vector to search for", "example": [] }, "limit": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "title": "Limit", "description": "Maximum number of results to return", "default": 10, "example": 1 }, "filter_expr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter Expr", "description": "Optional Milvus filter expression for additional filtering" }, "output_fields": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Output Fields", "description": "Optional list of fields to return in results (default: chunk_id, source_id, metadata)" } }, "type": "object", "required": [ "tenant_id", "sub_tenant_id", "query_embedding" ], "title": "Body_search_raw_embeddings_endpoint_embeddings_search_raw_embeddings_post" }, "Body_upload_knowledge_ingestion_upload_knowledge_post": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Unique identifier for the tenant/organization", "example": "tenant_1234" }, "sub_tenant_id": { "type": "string", "title": "Sub Tenant Id", "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.", "default": "", "example": "sub_tenant_4567" }, "upsert": { "type": "boolean", "title": "Upsert", "description": "If true, update existing sources with the same id.", "default": true, "example": true }, "files": { "items": { "type": "string", "format": "binary" }, "type": "array", "title": "Files", "description": "Files to upload (documents). Omit or leave empty when only sending app_knowledge.", "default": [] }, "file_metadata": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Metadata", "description": "JSON array of file metadata objects; length must match files when provided. Each object may include: file_id (optional), metadata, additional_metadata, and relations (forceful relations to other HydraDB source IDs)." }, "app_knowledge": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "App Knowledge", "description": "JSON: single source object or array of app-generated sources to index. Omit when only uploading files." } }, "type": "object", "required": [ "tenant_id" ], "title": "Body_upload_knowledge_ingestion_upload_knowledge_post" }, "CollectionStats": { "properties": { "row_count": { "type": "integer", "title": "Row Count", "description": "Number of rows in the collection", "example": 1 }, "dimensions": { "type": "integer", "title": "Dimensions", "description": "Number of dimensions in the collection", "example": 1 } }, "type": "object", "required": [ "row_count", "dimensions" ], "title": "CollectionStats" }, "ContentFilter": { "properties": { "tenant_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Tenant Metadata", "description": "Key-value pairs matched against source.tenant_metadata. All provided pairs must match (AND logic).", "examples": [ { "compliance_tag": "GDPR", "department": "Finance" } ] }, "document_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Document Metadata", "description": "Key-value pairs matched against source.document_metadata. All provided pairs must match (AND logic).", "examples": [ { "author": "Alice Smith", "year": 2023 } ] }, "source_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Source Fields", "description": "Key-value pairs matched against top-level source fields that you supply during ingestion. Allowed keys: description, timestamp, title, type, url. All provided pairs must match (AND logic).", "examples": [ { "title": "standup notes", "type": "slack" } ] } }, "type": "object", "title": "ContentFilter", "description": "Optional filters for narrowing list results.\n\nAll filter categories use **AND** logic \u2014 every provided key-value pair\nmust match for a document to be included.\n\nExamples\n--------\n```json\n{\n \"tenant_metadata\": {\"department\": \"Finance\", \"region\": \"US\"},\n \"document_metadata\": {\"author\": \"Alice Smith\"},\n \"source_fields\": {\"type\": \"slack\", \"title\": \"standup notes\"}\n}\n```" }, "ContentModel": { "properties": { "text": { "type": "string", "title": "Text", "description": "Plain text content extracted or provided for indexing.", "default": "", "example": "<text>" }, "html_base64": { "type": "string", "title": "Html Base64", "description": "Base64-encoded HTML content preserving structure and formatting.", "default": "", "example": "<html_base64>" }, "csv_base64": { "type": "string", "title": "Csv Base64", "description": "Base64-encoded CSV data for tabular content ingestion.", "default": "", "example": "<csv_base64>" }, "markdown": { "type": "string", "title": "Markdown", "description": "Raw Markdown content to be indexed as rich text.", "default": "", "example": "<markdown>" }, "files": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Files", "description": "List of file descriptors associated with the source (e.g., filenames, sizes)." }, "layout": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Layout", "description": "Optional layout metadata such as sections or blocks to guide chunking.", "example": [] } }, "type": "object", "title": "ContentModel" }, "CustomPropertyDefinition": { "properties": { "name": { "type": "string", "title": "Name", "description": "Property name (used as field name in Milvus)", "example": "<name>" }, "data_type": { "$ref": "#/components/schemas/MilvusDataType", "description": "Milvus data type. Use VARCHAR for text fields that need embeddings.", "default": "VARCHAR" }, "max_length": { "type": "integer", "title": "Max Length", "description": "Max length for VARCHAR fields. Increase for longer text content.", "default": 1024, "example": 1 }, "enable_match": { "type": "boolean", "title": "Enable Match", "description": "Enable TEXT_MATCH filtering on this field", "default": false, "example": true }, "enable_dense_embedding": { "type": "boolean", "title": "Enable Dense Embedding", "description": "Create a dense embedding field (FLOAT_VECTOR) for semantic similarity search. Only applicable to VARCHAR fields. A corresponding '{name}_embedding' field will be created.", "default": false, "example": true }, "enable_sparse_embedding": { "type": "boolean", "title": "Enable Sparse Embedding", "description": "Create a sparse embedding field (BM25) for keyword search. Only applicable to VARCHAR fields. A corresponding '{name}_sparse' field and BM25 function will be created.", "default": false, "example": true }, "nullable": { "type": "boolean", "title": "Nullable", "description": "Whether field can be null", "default": true, "example": true } }, "type": "object", "required": [ "name" ], "title": "CustomPropertyDefinition", "description": "Definition for custom/dynamic properties on a collection.\n\nUse this to define tenant metadata fields that can enhance search capabilities:\n- enable_dense_embedding: Creates a dense vector field for semantic similarity search\n- enable_sparse_embedding: Creates a sparse vector field for BM25 keyword search\n\nExample:\n CustomPropertyDefinition(\n name=\"product_description\",\n data_type=MilvusDataType.VARCHAR,\n max_length=4096,\n enable_dense_embedding=True, # Enables semantic search on this field\n enable_sparse_embedding=True, # Enables keyword search on this field\n )" }, "DeleteResult": { "properties": { "delete_count": { "type": "integer", "title": "Delete Count", "description": "Number of entities deleted", "example": 1 }, "success": { "type": "boolean", "title": "Success", "description": "Whether delete succeeded", "default": true, "example": true }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Error message if failed" } }, "type": "object", "required": [ "delete_count" ], "title": "DeleteResult", "description": "Result of a delete operation." }, "DeleteUserMemoryResponse": { "properties": { "success": { "type": "boolean", "title": "Success", "description": "Indicates whether the memory deletion operation was successful", "default": true, "example": true }, "user_memory_deleted": { "type": "boolean", "title": "User Memory Deleted", "description": "Confirms whether the specific memory was successfully deleted", "example": true } }, "type": "object", "required": [ "user_memory_deleted" ], "title": "DeleteUserMemoryResponse", "description": "Response model for deleting a user memory." }, "Entity": { "properties": { "name": { "type": "string", "title": "Name", "description": "Normalized entity name", "example": "<name>" }, "type": { "type": "string", "title": "Type", "description": "PERSON, ORGANIZATION, PROJECT, PRODUCT, ERROR_CODE, etc.", "example": "<type>" }, "namespace": { "type": "string", "title": "Namespace", "description": "Context category like 'employees', 'projects'", "default": "default", "example": "<namespace>" }, "entity_id": { "type": "string", "title": "Entity Id", "description": "Internal unique entity ID from graph database", "example": "<entity_id>" }, "identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Identifier", "description": "Unique ID like email, employee_id, URL" } }, "type": "object", "required": [ "name", "type", "entity_id" ], "title": "Entity" }, "ErrorResponse": { "properties": { "success": { "type": "boolean", "title": "Success", "default": false }, "message": { "type": "string", "minLength": 1, "title": "Message", "default": "Error occurred" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" } }, "type": "object", "title": "ErrorResponse" }, "FetchMode": { "type": "string", "enum": [ "content", "url", "both" ], "title": "FetchMode", "description": "Mode for fetching file content." }, "ForcefulRelationsPayload": { "properties": { "hydradb_source_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "HydraDB Source Ids", "description": "HydraDB source IDs to forcefully relate to the uploaded source." }, "properties": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Properties", "description": "Optional properties to attach to the forceful relation." } }, "type": "object", "title": "ForcefulRelationsPayload" }, "FullTextSearchRequest": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Unique identifier for the tenant/organization", "example": "tenant_1234" }, "sub_tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sub Tenant Id", "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.", "example": "sub_tenant_4567" }, "query": { "type": "string", "title": "Query", "description": "Search terms to find in your content", "example": "John Smith Jake" }, "operator": { "$ref": "#/components/schemas/BM25OperatorType", "description": "How to combine search terms: 'or' (any term matches), 'and' (all terms must match), 'phrase' (exact phrase must appear)", "default": "or", "example": "and" }, "max_results": { "type": "integer", "title": "Max Results", "description": "Maximum number of results to return", "default": 10, "example": 1 }, "search_mode": { "$ref": "#/components/schemas/SearchMode", "description": "What to search: 'sources' for documents or 'memories' for user memories", "default": "sources" } }, "type": "object", "required": [ "tenant_id", "query" ], "title": "FullTextSearchRequest" }, "GraphContext": { "properties": { "query_paths": { "items": { "$ref": "#/components/schemas/ScoredPathResponse" }, "type": "array", "title": "Query Paths", "example": [] }, "chunk_relations": { "items": { "$ref": "#/components/schemas/ScoredPathResponse" }, "type": "array", "title": "Chunk Relations", "example": [] }, "chunk_id_to_group_ids": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object", "title": "Chunk Id To Group Ids" } }, "type": "object", "title": "GraphContext", "description": "Graph context containing query-based paths and chunk-based relation paths." }, "Infra": { "properties": { "scheduler_status": { "type": "boolean", "title": "Scheduler Status", "example": true }, "graph_status": { "type": "boolean", "title": "Graph Status", "example": true }, "vectorstore_status": { "prefixItems": [ { "type": "boolean" }, { "type": "boolean" } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Vectorstore Status", "example": [] } }, "type": "object", "required": [ "scheduler_status", "graph_status", "vectorstore_status" ], "title": "Infra" }, "InfraStatusResponse": { "properties": { "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id", "description": "Tenant identifier when status is queried for a specific tenant", "example": "tenant_1234" }, "org_id": { "type": "string", "title": "Org Id", "description": "Organization identifier", "example": "<org_id>" }, "infra": { "$ref": "#/components/schemas/Infra", "description": "Deployed infrastructure status" }, "message": { "type": "string", "title": "Message", "description": "Summary message", "default": "Deployed infrastructure status" } }, "type": "object", "required": [ "org_id", "infra" ], "title": "InfraStatusResponse", "description": "Response for deployed infrastructure status checks." }, "InsertResult": { "properties": { "insert_count": { "type": "integer", "title": "Insert Count", "description": "Number of entities inserted", "example": 1 }, "ids": { "items": { "type": "string" }, "type": "array", "title": "Ids", "description": "Inserted entity IDs", "example": [ "HydraDoc1234", "HydraDoc4567" ] }, "success": { "type": "boolean", "title": "Success", "description": "Whether insert succeeded", "default": true, "example": true }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Error message if failed" } }, "type": "object", "required": [ "insert_count" ], "title": "InsertResult", "description": "Result of an insert operation." }, "ListContentKind": { "type": "string", "enum": [ "knowledge", "memories" ], "title": "ListContentKind" }, "ListContentRequest": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Tenant ID", "example": "tenant_1234" }, "sub_tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sub Tenant Id", "description": "Sub-tenant ID", "example": "sub_tenant_4567" }, "kind": { "$ref": "#/components/schemas/ListContentKind", "description": "Whether to list normal sources or user memories.", "default": "knowledge" }, "source_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 100 }, { "type": "null" } ], "title": "Source Ids", "description": "Optional list of IDs to fetch (max 100). If omitted, returns all." }, "page": { "type": "integer", "minimum": 1.0, "title": "Page", "description": "Page number to retrieve (1-indexed). Defaults to 1.", "default": 1, "example": 1 }, "page_size": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Page Size", "description": "Number of items per page (1-100). Defaults to 50.", "default": 50, "example": 1 }, "filters": { "anyOf": [ { "$ref": "#/components/schemas/ContentFilter" }, { "type": "null" } ], "description": "Optional filters. Provide key-value pairs to match against tenant_metadata, document_metadata, and/or source-level fields (title, type, description, url, timestamp)." }, "include_fields": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Include Fields", "description": "Optional list of source fields to include in the response. When provided, only the specified fields (plus id, tenant_id, sub_tenant_id which are always returned) will be populated; all other fields will have their default/empty values. This reduces payload size and improves performance. Allowed values: attachments, content, description, document_metadata, note, relations, tenant_metadata, timestamp, title, type, url. Omit or pass null to return all fields. Only applies to kind=knowledge; ignored for kind=memories.", "examples": [ [ "title", "type", "url", "timestamp" ] ] } }, "type": "object", "required": [ "tenant_id" ], "title": "ListContentRequest", "description": "Unified request model for listing either sources or user memories.\n\nSupports **pagination** (page / page_size) and optional **filters**\non tenant_metadata and document_metadata.\n\nIf `source_ids` is provided and non-empty, only those IDs are returned\n(pagination and filters still apply)." }, "ListUserMemoriesResponse": { "properties": { "success": { "type": "boolean", "title": "Success", "description": "Indicates whether the memory listing operation was successful", "default": true, "example": true }, "user_memories": { "items": { "$ref": "#/components/schemas/UserMemory" }, "type": "array", "title": "User Memories", "description": "Array of user memories for the current page", "example": [ { "memory_id": "memory_1234", "memory_content": "I prefer detailed technical explanations and works in the Pacific timezone" }, { "memory_id": "memory_4567", "memory_content": "I prefer dark mode" } ] }, "total": { "type": "integer", "title": "Total", "description": "Total number of user memories matching the query", "default": 0, "example": 1 }, "pagination": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata for navigating through results." } }, "type": "object", "required": [ "pagination" ], "title": "ListUserMemoriesResponse", "description": "Response model for listing all user memories." }, "MemoryItem": { "properties": { "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id", "description": "Optional unique identifier. Auto-generated if not provided." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Display title for this memory item." }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text", "description": "Raw text or markdown content to be indexed.", "examples": [ "# Introduction\n\nThis is the document content." ] }, "user_assistant_pairs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UserAssistantPair" }, "type": "array" }, { "type": "null" } ], "title": "User Assistant Pairs", "description": "Array of user/assistant conversation pairs to store as memory." }, "is_markdown": { "type": "boolean", "title": "Is Markdown", "description": "Whether the text is markdown formatted.", "default": false, "example": true }, "infer": { "type": "boolean", "title": "Infer", "description": "If true, process and extract additional insights/inferences from the contentbefore indexingUseful for extracting implicit information from conversations", "default": false, "example": true }, "custom_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Instructions", "description": "Custom instructions to guide inference processing." }, "user_name": { "type": "string", "title": "User Name", "description": "User's name for personalization in conversation pairs.", "default": "User", "example": "John Doe" }, "expiry_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expiry Time", "description": "Optional TTL in seconds for this memory." }, "tenant_metadata": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Metadata", "description": "JSON string containing tenant-level document metadata (e.g., department, compliance_tag)\n\nExample: > \"{\"department\":\"Finance\",\"compliance_tag\":\"GDPR\"}\"\n\n", "default": "" }, "document_metadata": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Metadata", "description": "JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.\n\nExample: > \"{\"title\":\"Q1 Report.pdf\",\"author\":\"Alice Smith\",\"file_id\":\"custom_file_123\"}\"\n\n\n", "default": "" }, "relations": { "anyOf": [ { "$ref": "#/components/schemas/ForcefulRelationsPayload" }, { "type": "null" } ], "description": "Forcefully connect 2 sources based on HydraDB source IDs or common properties." } }, "type": "object", "title": "MemoryItem", "description": "Represents a single memory item for ingestion.\nSupports raw text, markdown, and user/assistant conversation pairs." }, "MemoryResultItem": { "properties": { "source_id": { "type": "string", "title": "Source Id", "description": "Unique identifier for the ingested source.", "example": "<source_id>" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Title of the memory if provided." }, "status": { "$ref": "#/components/schemas/SourceStatus", "description": "Initial processing status.", "default": "queued" }, "infer": { "type": "boolean", "title": "Infer", "description": "Whether inference was requested for this memory.", "default": false, "example": true }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Error message if ingestion failed." } }, "type": "object", "required": [ "source_id" ], "title": "MemoryResultItem", "description": "Result for a single ingested memory item." }, "MilvusDataType": { "type": "string", "enum": [ "BOOL", "INT8", "INT16", "INT32", "INT64", "FLOAT", "DOUBLE", "VARCHAR", "JSON", "ARRAY", "FLOAT_VECTOR", "SPARSE_FLOAT_VECTOR" ], "title": "MilvusDataType", "description": "Milvus data types mapped from Weaviate schema." }, "PaginationMeta": { "properties": { "page": { "type": "integer", "title": "Page", "description": "Current page number (1-indexed).", "example": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Number of items returned per page.", "example": 1 }, "total": { "type": "integer", "title": "Total", "description": "Total number of items matching the query.", "example": 1 }, "total_pages": { "type": "integer", "title": "Total Pages", "description": "Total number of pages available.", "example": 1 }, "has_next": { "type": "boolean", "title": "Has Next", "description": "Whether a next page exists.", "example": true }, "has_previous": { "type": "boolean", "title": "Has Previous", "description": "Whether a previous page exists.", "example": true } }, "type": "object", "required": [ "page", "page_size", "total", "total_pages", "has_next", "has_previous" ], "title": "PaginationMeta", "description": "Pagination metadata returned with every paginated response." }, "PathTriplet": { "properties": { "source": { "$ref": "#/components/schemas/Entity" }, "relation": { "$ref": "#/components/schemas/RelationEvidence" }, "target": { "$ref": "#/components/schemas/Entity" } }, "type": "object", "required": [ "source", "relation", "target" ], "title": "PathTriplet" }, "ProcessingStatus": { "properties": { "file_id": { "type": "string", "title": "File Id", "description": "Identifier for the file whose status is being retrieved", "example": "<file_id>" }, "indexing_status": { "type": "string", "enum": [ "queued", "processing", "completed", "errored", "graph_creation", "success" ], "title": "Indexing Status", "description": "Current status of the file. Possible values are 'queued', 'processing', 'completed', 'errored', 'graph_creation', 'success'. 'graph_creation' indicates the file is indexed but the knowledge graph is still being created. 'success' is an alias for 'completed'.", "example": "<indexing_status>" }, "error_code": { "type": "string", "title": "Error Code", "description": "Error code for the file. You may share this code with us to help us diagnose and resolve the issue.", "default": "", "example": "<error_code>" }, "success": { "type": "boolean", "title": "Success", "description": "Whether the file was processed successfully.", "default": true, "example": true }, "message": { "type": "string", "title": "Message", "description": "Detailed status message about the processing operation", "default": "Processing status retrieved successfully" } }, "type": "object", "required": [ "file_id", "indexing_status" ], "title": "ProcessingStatus" }, "RawEmbeddingDocument": { "properties": { "source_id": { "type": "string", "title": "Source Id", "description": "Source identifier for the embedding", "example": "<source_id>" }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Tenant ID (set by the server)", "default": "", "example": "tenant_1234" }, "sub_tenant_id": { "type": "string", "title": "Sub Tenant Id", "description": "Sub-tenant ID (set by the server)", "default": "", "example": "sub_tenant_4567" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata", "description": "Metadata to store" }, "embeddings": { "items": { "$ref": "#/components/schemas/RawEmbeddingVector" }, "type": "array", "title": "Embeddings", "description": "Embedding payloads containing ids and vectors", "example": [ [ 0.123413, 0.655367, 0.987654, 0.123456, 0.789012 ], [ 0.123413, 0.655367, 0.987654, 0.123456, 0.789012 ] ] } }, "type": "object", "required": [ "source_id", "embeddings" ], "title": "RawEmbeddingDocument", "description": "A raw embedding document for direct insert/upsert operations." }, "RawEmbeddingSearchResult": { "properties": { "source_id": { "type": "string", "title": "Source Id", "description": "Source identifier", "example": "<source_id>" }, "embedding": { "anyOf": [ { "$ref": "#/components/schemas/RawEmbeddingVector" }, { "type": "null" } ], "description": "Embedding payload with chunk id and vector (if set)" }, "score": { "type": "number", "title": "Score", "description": "Similarity score", "default": 0.0, "example": 1.0 }, "distance": { "type": "number", "title": "Distance", "description": "Vector distance", "default": 0.0, "example": 1.0 }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "Metadata associated with the embedding" } }, "type": "object", "required": [ "source_id" ], "title": "RawEmbeddingSearchResult", "description": "Search result for raw embedding collections." }, "RawEmbeddingVector": { "properties": { "chunk_id": { "type": "string", "title": "Chunk Id", "description": "Primary key / chunk identifier", "example": "<chunk_id>" }, "embedding": { "items": { "type": "number" }, "type": "array", "title": "Embedding", "description": "Embedding vector", "example": [] } }, "type": "object", "required": [ "chunk_id", "embedding" ], "title": "RawEmbeddingVector", "description": "Embedding payload containing the chunk identifier and vector." }, "RecallSearchRequest": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Unique identifier for the tenant/organization", "example": "tenant_1234" }, "sub_tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sub Tenant Id", "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.", "example": "sub_tenant_4567" }, "query": { "type": "string", "title": "Query", "description": "Search terms to find relevant content", "example": "Which mode does user prefer" }, "max_results": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Results", "description": "Maximum number of results to return" }, "mode": { "$ref": "#/components/schemas/RetrieveMode", "description": "Retrieval mode to use ('fast' or 'thinking')", "default": "fast" }, "alpha": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "title": "Alpha", "description": "Search ranking algorithm parameter (0.0-1.0 or 'auto')", "default": 0.8 }, "recency_bias": { "type": "number", "title": "Recency Bias", "description": "Preference for newer content (0.0 = no bias, 1.0 = strong recency preference)", "default": 0.0, "example": 1.0 }, "graph_context": { "type": "boolean", "title": "Graph Context", "description": "Enable graph context for search results", "default": false, "example": true }, "search_forceful_relations": { "type": "boolean", "title": "Search Forceful Relations", "description": "Whether to search for forceful relations in thinking mode to augment context", "default": true, "example": true }, "additional_context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Additional Context", "description": "Additional context provided by the user to guide retrieval" }, "metadata_filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata Filters", "description": "Optional object for exact-match metadata scoping. All provided conditions are combined with AND. Top-level keys (except the reserved nested object described below) must match tenant-level metadata field names declared with enable_match in tenant_metadata_schema; each value is compared with plain equality to the stored tenant metadata value for that field. For document-level metadata, supply a nested object under the key \"additional_metadata\" whose keys and values are compared with plain equality to per-source document metadata. Only equality on scalar-compatible values is part of this contract—do not send range operators, regular-expression operators, or Mongo-style operators such as $gte, $lt, $in, or $regex.", "examples": [ { "category": "engineering", "department": "R&D" }, { "additional_metadata": { "source": "account_plan" } } ] } }, "type": "object", "required": [ "tenant_id", "query" ], "title": "RecallSearchRequest", "description": "Request body for full recall (sources) and recall preferences (memories)." }, "RelationEvidence": { "properties": { "canonical_predicate": { "type": "string", "title": "Canonical Predicate", "description": "Relationship phrase like 'works for', 'reports to'", "example": "<canonical_predicate>" }, "raw_predicate": { "type": "string", "title": "Raw Predicate", "description": "Original predicate from text", "example": "<raw_predicate>" }, "context": { "type": "string", "title": "Context", "description": "Rich contextual description of the relationship with surrounding information, details about how/why/when, and any relevant background. Should be comprehensive enough to understand the relationship without referring back to source.", "example": "<context>" }, "confidence": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Confidence", "description": "Confidence score", "default": 0.8, "example": 1.0 }, "temporal_details": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temporal Details", "description": "Temporal timing information extracted from text (e.g., 'last week', 'in 2023', 'yesterday')" }, "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp", "description": "Timestamp when this relation was introduced", "example": "<timestamp>" }, "relationship_id": { "type": "string", "title": "Relationship Id", "description": "Unique ID for this relationship from graph database", "example": "<relationship_id>" }, "chunk_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Chunk Id", "description": "ID of the chunk this relation was extracted from" }, "source_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Entity Id", "description": "The entity ID of source node" }, "target_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Entity Id", "description": "The entity ID of target node" } }, "type": "object", "required": [ "canonical_predicate", "raw_predicate", "context", "relationship_id" ], "title": "RelationEvidence", "description": "Single piece of evidence for a relationship between two entities" }, "RetrievalResult": { "properties": { "chunks": { "items": { "$ref": "#/components/schemas/VectorStoreChunk" }, "type": "array", "title": "Chunks", "example": [] }, "sources": { "items": { "$ref": "#/components/schemas/SourceInfo" }, "type": "array", "title": "Sources", "description": "Deduplicated source documents corresponding to the returned chunks" }, "graph_context": { "$ref": "#/components/schemas/GraphContext" }, "additional_context": { "additionalProperties": { "$ref": "#/components/schemas/VectorStoreChunk" }, "type": "object", "title": "Additional Context", "description": "Map of chunk_uuid to VectorStoreChunk for extra context from forcefully related sources. Use chunk.extra_context_ids to look up chunks: extra_context[id] for id in chunk.extra_context_ids." } }, "type": "object", "title": "RetrievalResult", "description": "Result of a hybrid search retrieval operation." }, "RetrieveMode": { "type": "string", "enum": [ "fast", "thinking" ], "title": "RetrieveMode" }, "ScoredPathResponse": { "properties": { "triplets": { "items": { "$ref": "#/components/schemas/PathTriplet" }, "type": "array", "title": "Triplets", "example": [] }, "relevancy_score": { "type": "number", "title": "Relevancy Score", "example": 1.0 }, "combined_context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Combined Context" }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Id", "description": "Path group identifier (e.g., 'p_0') for chunk mapping" }, "source_chunk_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Source Chunk Ids", "description": "Input chunk IDs whose graph traversal produced this path" } }, "type": "object", "required": [ "triplets", "relevancy_score" ], "title": "ScoredPathResponse" }, "SearchMode": { "type": "string", "enum": [ "sources", "memories" ], "title": "SearchMode", "description": "Search mode to specify what type of content to search." }, "SourceDeleteRequest": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id", "example": "tenant_1234" }, "sub_tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sub Tenant Id", "example": "sub_tenant_4567" }, "ids": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Ids", "description": "List of source IDs to delete.", "example": [ "HydraDoc1234", "HydraDoc4567" ] } }, "type": "object", "required": [ "tenant_id", "ids" ], "title": "SourceDeleteRequest", "description": "Request to delete sources by their IDs." }, "SourceDeleteResponse": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true, "example": true }, "message": { "type": "string", "title": "Message", "default": "Delete completed" }, "results": { "items": { "$ref": "#/components/schemas/SourceDeleteResultItem" }, "type": "array", "title": "Results", "example": [] }, "deleted_count": { "type": "integer", "title": "Deleted Count", "description": "Number of sources deleted.", "default": 0, "example": 1 } }, "type": "object", "title": "SourceDeleteResponse", "description": "Response for delete request." }, "SourceDeleteResultItem": { "properties": { "id": { "type": "string", "title": "Id", "description": "ID of the source.", "example": "HydraDoc1234" }, "deleted": { "type": "boolean", "title": "Deleted", "description": "Whether deletion succeeded.", "default": false, "example": true }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Error message if deletion failed." } }, "type": "object", "required": [ "id" ], "title": "SourceDeleteResultItem", "description": "Result for a single source deletion." }, "SourceFetchRequest": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Unique identifier for the tenant/organization", "example": "tenant_1234" }, "sub_tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sub Tenant Id", "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.", "example": "sub_tenant_4567" }, "source_id": { "type": "string", "title": "Source Id", "description": "Source ID of the file to fetch", "example": "<source_id>" }, "mode": { "$ref": "#/components/schemas/FetchMode", "description": "Fetch mode: 'content' returns file content, 'url' returns presigned URL, 'both' returns both", "default": "content" }, "expiry_seconds": { "type": "integer", "maximum": 604800.0, "minimum": 60.0, "title": "Expiry Seconds", "description": "Expiry time in seconds for presigned URL (60-604800, default: 3600)", "default": 3600, "example": 1 } }, "type": "object", "required": [ "tenant_id", "source_id" ], "title": "SourceFetchRequest", "description": "Request to fetch source file content." }, "SourceFetchResponse": { "properties": { "success": { "type": "boolean", "title": "Success", "description": "Whether the fetch was successful", "default": true, "example": true }, "source_id": { "type": "string", "title": "Source Id", "description": "Source ID of the fetched file", "example": "<source_id>" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content", "description": "File content as string (if mode includes 'content')" }, "content_base64": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Base64", "description": "File content as base64 encoded string (for binary files, if mode includes 'content')" }, "presigned_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Presigned Url", "description": "Presigned URL to access the file (if mode includes 'url')" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type", "description": "Content type of the file" }, "size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Size Bytes", "description": "Size of the file in bytes" }, "message": { "type": "string", "title": "Message", "description": "Response message", "default": "File fetched successfully" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Error message if fetch failed" } }, "type": "object", "required": [ "source_id" ], "title": "SourceFetchResponse", "description": "Response for file fetch request." }, "SourceGraphRelationsResponse": { "properties": { "relations": { "items": { "anyOf": [ { "$ref": "#/components/schemas/TripletWithEvidence" }, { "type": "null" } ] }, "type": "array", "title": "Relations", "description": "List of relations retrieved", "example": [] }, "success": { "type": "boolean", "title": "Success", "description": "Indicates whether the request was successful", "default": true, "example": true }, "message": { "type": "string", "title": "Message", "description": "Response message describing the operation result", "default": "Relations retrieved successfully" } }, "type": "object", "required": [ "relations" ], "title": "SourceGraphRelationsResponse" }, "SourceInfo": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the source", "example": "HydraDoc1234" }, "title": { "type": "string", "title": "Title", "description": "Short human-readable title for the source", "default": "", "example": "<title>" }, "type": { "type": "string", "title": "Type", "description": "Category of the source (e.g., document, email, ticket)", "default": "", "example": "<type>" }, "description": { "type": "string", "title": "Description", "description": "Long-form description providing additional context", "default": "", "example": "<description>" }, "url": { "type": "string", "title": "Url", "description": "Canonical URL or reference link associated with the source", "default": "", "example": "<url>" }, "timestamp": { "type": "string", "title": "Timestamp", "description": "Creation or last-updated timestamp in ISO-8601 format", "default": "", "example": "<timestamp>" }, "tenant_metadata": { "additionalProperties": true, "type": "object", "title": "Tenant Metadata", "description": "Custom metadata associated with your tenant" }, "document_metadata": { "additionalProperties": true, "type": "object", "title": "Document Metadata", "description": "Metadata extracted from the source document" } }, "type": "object", "required": [ "id" ], "title": "SourceInfo" }, "SourceListResponse": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true, "example": true }, "message": { "type": "string", "title": "Message", "default": "Sources retrieved successfully" }, "sources": { "items": { "$ref": "#/components/schemas/SourceModel" }, "type": "array", "title": "Sources" }, "total": { "type": "integer", "title": "Total", "description": "Total number of sources matching the query.", "example": 1 }, "pagination": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata for navigating through results." } }, "type": "object", "required": [ "total", "pagination" ], "title": "SourceListResponse" }, "SourceModel": { "properties": { "id": { "type": "string", "title": "Id", "description": "Stable, unique identifier for the source. If omitted, one may be generated upstream.", "example": "HydraDoc1234" }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Unique identifier for the tenant/organization", "example": "tenant_1234" }, "sub_tenant_id": { "type": "string", "title": "Sub Tenant Id", "description": "Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.", "example": "sub_tenant_4567" }, "title": { "type": "string", "title": "Title", "description": "Short human-readable title for the source.", "default": "", "example": "<title>" }, "type": { "type": "string", "title": "Type", "description": "High-level category of the source (e.g., document, email, ticket).", "default": "", "example": "<type>" }, "description": { "type": "string", "title": "Description", "description": "Optional long-form description providing additional context.", "default": "", "example": "<description>" }, "note": { "type": "string", "title": "Note", "description": "Free-form notes for internal use or ingestion hints.", "default": "", "example": "<note>" }, "url": { "type": "string", "title": "Url", "description": "Canonical URL or reference link associated with the source.", "default": "", "example": "<url>" }, "timestamp": { "type": "string", "title": "Timestamp", "description": "Creation or last-updated timestamp of the source in ISO-8601 format.", "default": "", "example": "<timestamp>" }, "content": { "$ref": "#/components/schemas/ContentModel", "description": "Primary content payload used for indexing and retrieval." }, "tenant_metadata": { "additionalProperties": true, "type": "object", "title": "Tenant Metadata", "description": "JSON string containing tenant-level document metadata (e.g., department, compliance_tag)\n\nExample: > \"{\"department\":\"Finance\",\"compliance_tag\":\"GDPR\"}\"\n\n" }, "document_metadata": { "additionalProperties": true, "type": "object", "title": "Document Metadata", "description": "JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.\n\nExample: > \"{\"title\":\"Q1 Report.pdf\",\"author\":\"Alice Smith\",\"file_id\":\"custom_file_123\"}\"\n\n\n" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta", "description": "System-provided attributes (e.g., app_name, local file size) not intended for search filtering." }, "attachments": { "items": { "$ref": "#/components/schemas/AttachmentModel" }, "type": "array", "title": "Attachments", "description": "Attachments related to the source such as images, PDFs, or supplemental files." }, "relations": { "anyOf": [ { "$ref": "#/components/schemas/ForcefulRelationsPayload" }, { "type": "null" } ], "description": "Forcefully connect 2 sources based on HydraDB source IDs or common properties." } }, "type": "object", "required": [ "id", "tenant_id", "sub_tenant_id" ], "title": "SourceModel" }, "SourceStatus": { "type": "string", "enum": [ "queued", "processing", "completed", "failed" ], "title": "SourceStatus" }, "SourceUploadResponse": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true, "example": true }, "message": { "type": "string", "title": "Message", "default": "Upload initiated successfully" }, "results": { "items": { "$ref": "#/components/schemas/SourceUploadResultItem" }, "type": "array", "title": "Results", "description": "List of upload results for each source.", "example": [] }, "success_count": { "type": "integer", "title": "Success Count", "description": "Number of sources successfully queued.", "default": 0, "example": 1 }, "failed_count": { "type": "integer", "title": "Failed Count", "description": "Number of sources that failed to upload.", "default": 0, "example": 1 } }, "type": "object", "title": "SourceUploadResponse" }, "SourceUploadResultItem": { "properties": { "source_id": { "type": "string", "title": "Source Id", "description": "Unique identifier for the uploaded source.", "example": "<source_id>" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filename", "description": "Original filename if present." }, "status": { "$ref": "#/components/schemas/SourceStatus", "description": "Initial processing status.", "default": "queued" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Error message if upload failed." } }, "type": "object", "required": [ "source_id" ], "title": "SourceUploadResultItem" }, "SubTenantIdsResponse": { "properties": { "sub_tenant_ids": { "items": { "type": "string" }, "type": "array", "title": "Sub Tenant Ids", "description": "Unique sub-tenant IDs that have indexed data in the tenant's collections", "example": [ "sub_tenant_1234", "sub_tenant_4567" ] }, "message": { "type": "string", "title": "Message", "description": "Summary message", "default": "Successfully retrieved sub-tenant IDs" } }, "type": "object", "title": "SubTenantIdsResponse", "description": "Response for listing unique sub-tenant IDs in a tenant (from Milvus)." }, "SupportedLLMProviders": { "type": "string", "enum": [ "groq", "cerebras", "openai", "anthropic", "gemini" ], "title": "SupportedLLMProviders" }, "TenantCreateAcceptedResponse": { "properties": { "status": { "type": "string", "title": "Status", "description": "Status of the request", "default": "accepted" }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Tenant identifier that is being created", "example": "tenant_1234" }, "message": { "type": "string", "title": "Message", "description": "Response message", "default": "Tenant creation started in the background. Use GET /tenants/infra/status?tenant_id=... to check progress." } }, "type": "object", "required": [ "tenant_id" ], "title": "TenantCreateAcceptedResponse", "description": "Response when tenant creation is accepted and runs in the background." }, "TenantCreateRequest": { "properties": { "tenant_id": { "type": "string", "minLength": 1, "title": "Tenant Id", "description": "Unique tenant identifier", "example": "tenant_1234" }, "is_embeddings_tenant": { "type": "boolean", "title": "Is Embeddings Tenant", "description": "True to create embeddings tenant", "default": false, "example": true }, "embeddings_dimension": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Embeddings Dimension", "description": "Embedding dimensions for embeddings tenant. Not required for non-embeddings (is_embeddings_tenant=False) tenants", "default": 1536 }, "tenant_metadata_schema": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CustomPropertyDefinition" }, "type": "array" }, { "type": "null" } ], "title": "Tenant Metadata Schema", "description": "Schema definition for tenant metadata fields. Each field can be configured for: filtering (enable_match), semantic search (enable_dense_embedding), and/or keyword search (enable_sparse_embedding). Fields with embeddings enabled must be VARCHAR type.", "examples": [ [ { "data_type": "VARCHAR", "enable_match": true, "max_length": 256, "name": "category" }, { "data_type": "VARCHAR", "enable_dense_embedding": true, "enable_sparse_embedding": true, "max_length": 4096, "name": "product_description" } ] ], "example": [ { "name": "department", "data_type": "VARCHAR", "max_length": 256, "enable_match": true }, { "name": "compliance_framework", "data_type": "VARCHAR", "max_length": 256, "enable_match": true, "enable_dense_embedding": false, "enable_sparse_embedding": false }, { "name": "data_classification", "data_type": "VARCHAR", "max_length": 128, "enable_match": true } ] } }, "type": "object", "required": [ "tenant_id" ], "title": "TenantCreateRequest", "description": "Request model for creating a tenant with optional metadata schema.\n\nThe `tenant_metadata_schema` allows you to define custom fields that will be indexed in Milvus with configurable search capabilities.\n\nExample:\n\n```json\n{\n \"tenant_id\": \"my-tenant\",\n \"tenant_metadata_schema\": [\n {\n \"name\": \"category\",\n \"data_type\": \"VARCHAR\",\n \"max_length\": 256,\n \"enable_match\": true\n },\n {\n \"name\": \"product_description\",\n \"data_type\": \"VARCHAR\",\n \"max_length\": 4096,\n \"enable_dense_embedding\": true,\n \"enable_sparse_embedding\": true\n }\n ]\n}\n```" }, "TenantDeleteResponse": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Identifier provided by user", "example": "tenant_1234" }, "status": { "type": "string", "title": "Status", "default": "deletion_scheduled" }, "message": { "type": "string", "title": "Message", "default": "Tenant deregistered. Background cleanup is in progress." } }, "type": "object", "required": [ "tenant_id" ], "title": "TenantDeleteResponse" }, "TenantStatsResponse": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Tenant identifier", "example": "tenant_1234" }, "normal_collection": { "$ref": "#/components/schemas/CollectionStats", "description": "Statistics for the normal (context) collection" }, "memory_collection": { "$ref": "#/components/schemas/CollectionStats", "description": "Statistics for the memory collection" }, "message": { "type": "string", "title": "Message", "description": "Summary message", "default": "Successfully retrieved tenant collection statistics" } }, "type": "object", "required": [ "tenant_id", "normal_collection", "memory_collection" ], "title": "TenantStatsResponse" }, "TripletWithEvidence": { "properties": { "source": { "$ref": "#/components/schemas/Entity" }, "target": { "$ref": "#/components/schemas/Entity" }, "relations": { "items": { "$ref": "#/components/schemas/RelationEvidence" }, "type": "array", "title": "Relations", "description": "Array of relation evidences", "example": [] }, "chunk_id": { "type": "string", "title": "Chunk Id", "description": "The chunk_id these relations are associated with", "example": "<chunk_id>" } }, "type": "object", "required": [ "source", "target", "relations", "chunk_id" ], "title": "TripletWithEvidence", "description": "Triple with multiple evidence items from different chunks" }, "UserAssistantPair": { "properties": { "user": { "type": "string", "title": "User", "description": "User's message in the conversation", "example": "<user>" }, "assistant": { "type": "string", "title": "Assistant", "description": "Assistant's response to the user message", "example": "<assistant>" } }, "type": "object", "required": [ "user", "assistant" ], "title": "UserAssistantPair", "description": "Represents a user-assistant conversation pair." }, "UserMemory": { "properties": { "memory_id": { "type": "string", "title": "Memory Id", "description": "Unique identifier for the user memory", "examples": [ "HydraUserMemory1234..." ], "example": "memory_1234" }, "memory_content": { "type": "string", "title": "Memory Content", "description": "The actual memory content text that was stored", "examples": [ "User prefers dark mode interface and uses keyboard shortcuts" ], "example": "<memory_content>" } }, "type": "object", "required": [ "memory_id", "memory_content" ], "title": "UserMemory", "description": "Represents a user memory stored in the system." }, "VectorStoreChunk": { "properties": { "chunk_uuid": { "type": "string", "title": "Chunk Uuid", "description": "Unique identifier for this content chunk", "examples": [ "a1b2c3d4-e5f6-7890-1234-567890abcdef" ], "example": "<chunk_uuid>" }, "source_id": { "type": "string", "title": "Source Id", "description": "Unique identifier for the source document", "examples": [ "doc_12345" ], "example": "<source_id>" }, "chunk_content": { "type": "string", "title": "Chunk Content", "description": "The actual text content of this chunk", "examples": [ "This is a chunk of text from the source document." ], "example": "<chunk_content>" }, "source_type": { "type": "string", "title": "Source Type", "description": "Type of the source document (file, webpage, etc.)", "default": "", "examples": [ "file" ], "example": "<source_type>" }, "source_upload_time": { "type": "string", "title": "Source Upload Time", "description": "When the source document was originally uploaded", "default": "", "examples": [ "2023-10-27T10:00:00Z" ], "example": "<source_upload_time>" }, "source_title": { "type": "string", "title": "Source Title", "description": "Title or name of the source document", "default": "", "examples": [ "Project Phoenix Overview" ], "example": "<source_title>" }, "source_last_updated_time": { "type": "string", "title": "Source Last Updated Time", "description": "When the source document was last modified", "default": "", "examples": [ "2023-10-27T12:30:00Z" ], "example": "<source_last_updated_time>" }, "layout": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Layout", "description": "Layout of the chunk in original document. You will generally receive a stringified dict with 2 keys, `offsets` and `page`(optional). Offsets will have `document_level_start_index` and `page_level_start_index`(optional)", "examples": [ "{\"offsets\": {\"document_level_start_index\": 1024}, \"page\": 2}" ] }, "relevancy_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Relevancy Score", "description": "Score indicating how relevant this chunk is to your search query, with higher values indicating better matches" }, "document_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Document Metadata", "description": "Metadata extracted from the source document", "examples": [ { "author": "John Doe", "category": "Internal" } ] }, "tenant_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Tenant Metadata", "description": "Custom metadata associated with your tenant", "examples": [ { "department": "R&D" } ] }, "extra_context_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Extra Context Ids", "description": "IDs of related chunks providing extra context (from forceful relations). Only present in thinking mode when sources have forceful relations." } }, "type": "object", "required": [ "chunk_uuid", "source_id", "chunk_content" ], "title": "VectorStoreChunk" }, "cortex__models__response__commons__ActualErrorResponse": { "properties": { "detail": { "$ref": "#/components/schemas/cortex__models__response__commons__ErrorResponse" } }, "type": "object", "required": [ "detail" ], "title": "ActualErrorResponse" }, "cortex__models__response__commons__ErrorResponse": { "properties": { "success": { "type": "boolean", "title": "Success", "default": false, "example": true }, "message": { "type": "string", "title": "Message", "default": "Error occurred" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" } }, "type": "object", "title": "ErrorResponse" } }, "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } } } }