@robosystems/client 0.2.4 → 0.2.5

package/sdk/sdk.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import type { Options as ClientOptions, TDataShape, Client } from './client';
-import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, GetAllCreditSummariesData, GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, GetUserLimitsData, GetUserLimitsResponses, GetUserLimitsErrors, GetUserUsageData, GetUserUsageResponses, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetDetailedUserAnalyticsData, GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, GetUserSharedSubscriptionsData, GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, SubscribeToSharedRepositoryData, SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, UpgradeSharedRepositorySubscriptionData, UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, CancelSharedRepositorySubscriptionData, CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, GetSharedRepositoryCreditsData, GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, GetRepositoryCreditsData, GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ListTablesData, ListTablesResponses, ListTablesErrors, ListTableFilesData, ListTableFilesResponses, ListTableFilesErrors, GetUploadUrlData, GetUploadUrlResponses, GetUploadUrlErrors, DeleteFileData, DeleteFileResponses, DeleteFileErrors, GetFileInfoData, GetFileInfoResponses, GetFileInfoErrors, UpdateFileStatusData, UpdateFileStatusResponses, UpdateFileStatusErrors, IngestTablesData, IngestTablesResponses, IngestTablesErrors, QueryTablesData, QueryTablesResponses, QueryTablesErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, SelectGraphData, SelectGraphResponses, SelectGraphErrors, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors } from './types.gen';
+import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, GetAllCreditSummariesData, GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, GetUserLimitsData, GetUserLimitsResponses, GetUserLimitsErrors, GetUserUsageData, GetUserUsageResponses, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetDetailedUserAnalyticsData, GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, GetUserSharedSubscriptionsData, GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, SubscribeToSharedRepositoryData, SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, UpgradeSharedRepositorySubscriptionData, UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, CancelSharedRepositorySubscriptionData, CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, GetSharedRepositoryCreditsData, GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, GetRepositoryCreditsData, GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ListTablesData, ListTablesResponses, ListTablesErrors, ListTableFilesData, ListTableFilesResponses, ListTableFilesErrors, GetUploadUrlData, GetUploadUrlResponses, GetUploadUrlErrors, DeleteFileData, DeleteFileResponses, DeleteFileErrors, GetFileInfoData, GetFileInfoResponses, GetFileInfoErrors, UpdateFileStatusData, UpdateFileStatusResponses, UpdateFileStatusErrors, IngestTablesData, IngestTablesResponses, IngestTablesErrors, QueryTablesData, QueryTablesResponses, QueryTablesErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, GetAvailableGraphTiersData, GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, SelectGraphData, SelectGraphResponses, SelectGraphErrors, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors } from './types.gen';
 import { client as _heyApiClient } from './client.gen';
 
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
@@ -1080,13 +1080,46 @@ export const syncConnection = <ThrowOnError extends boolean = false>(options: Op
  * Auto-select agent for query
  * Automatically select the best agent for your query.
  *
- * The orchestrator will:
- * 1. Enrich context with RAG if enabled
- * 2. Evaluate all available agents
- * 3. Select the best match based on confidence scores
- * 4. Execute the query with the selected agent
+ * **Agent Selection Process:**
+ *
+ * The orchestrator intelligently routes your query by:
+ * 1. Analyzing query intent and complexity
+ * 2. Enriching context with RAG if enabled
+ * 3. Evaluating all available agents against selection criteria
+ * 4. Selecting the best match based on confidence scores
+ * 5. Executing the query with the selected agent
+ *
+ * **Available Agent Types:**
+ * - `financial`: Financial analysis, SEC filings, company metrics
+ * - `research`: General research, data exploration, trend analysis
+ * - `rag`: Knowledge base search using RAG enrichment
+ *
+ * **Execution Modes:**
+ * - `quick`: Fast responses (~2-5s), suitable for simple queries
+ * - `standard`: Balanced approach (~5-15s), default mode
+ * - `extended`: Comprehensive analysis (~15-60s), deep research
+ * - `streaming`: Real-time response streaming
+ *
+ * **Confidence Score Interpretation:**
+ * - `0.9-1.0`: High confidence, agent is ideal match
+ * - `0.7-0.9`: Good confidence, agent is suitable
+ * - `0.5-0.7`: Moderate confidence, agent can handle but may not be optimal
+ * - `0.3-0.5`: Low confidence, fallback agent used
+ * - `<0.3`: Very low confidence, consider using specific agent endpoint
+ *
+ * **Credit Costs:**
+ * - Quick mode: 5-10 credits per query
+ * - Standard mode: 15-25 credits per query
+ * - Extended mode: 30-75 credits per query
+ * - RAG enrichment: +5-15 credits (if enabled)
  *
- * Use this endpoint when you want the system to intelligently route your query.
+ * **Use Cases:**
+ * - Ask questions without specifying agent type
+ * - Get intelligent routing for complex multi-domain queries
+ * - Leverage conversation history for contextual understanding
+ * - Enable RAG for knowledge base enrichment
+ *
+ * See request/response examples in the "Examples" dropdown below.
  */
 export const autoSelectAgent = <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => {
     return (options.client ?? _heyApiClient).post<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError>({
@@ -1409,6 +1442,23 @@ export const listBackups = <ThrowOnError extends boolean = false>(options: Optio
  * - **Download Support**: Unencrypted backups can be downloaded
  * - **Restore Support**: Future support for encrypted backup restoration
  *
+ * **Operation State Machine:**
+ * ```
+ * pending → processing → completed
+ * ↘ failed
+ * ```
+ * - **pending**: Backup queued, waiting to start
+ * - **processing**: Actively backing up database
+ * - **completed**: Backup successfully created and stored
+ * - **failed**: Backup failed (check error message)
+ *
+ * **Expected Durations:**
+ * Operation times vary by database size:
+ * - **Small** (<1GB): 30 seconds - 2 minutes
+ * - **Medium** (1-10GB): 2-10 minutes
+ * - **Large** (10-100GB): 10-30 minutes
+ * - **Very Large** (>100GB): 30+ minutes
+ *
  * **Progress Monitoring:**
  * Use the returned operation_id to connect to the SSE stream:
  * ```javascript
@@ -1416,6 +1466,7 @@ export const listBackups = <ThrowOnError extends boolean = false>(options: Optio
  * eventSource.addEventListener('operation_progress', (event) => {
  * const data = JSON.parse(event.data);
  * console.log('Backup progress:', data.progress_percent + '%');
+ * console.log('Status:', data.status); // pending, processing, completed, failed
  * });
  * ```
  *
@@ -1496,6 +1547,28 @@ export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(optio
  * - **Data Integrity**: Verification ensures successful restore
  * - **Security**: Only encrypted backups to prevent data tampering
  *
+ * **Operation State Machine:**
+ * ```
+ * pending → backing_up_current → downloading → restoring → verifying → completed
+ * ↘ failed
+ * ```
+ * - **pending**: Restore queued, waiting to start
+ * - **backing_up_current**: Creating safety backup of existing database
+ * - **downloading**: Downloading backup from storage
+ * - **restoring**: Replacing database with backup contents
+ * - **verifying**: Verifying database integrity (if enabled)
+ * - **completed**: Restore successful, database operational
+ * - **failed**: Restore failed (rollback may be available)
+ *
+ * **Expected Durations:**
+ * Operation times vary by database size (includes backup + restore):
+ * - **Small** (<1GB): 1-3 minutes
+ * - **Medium** (1-10GB): 5-15 minutes
+ * - **Large** (10-100GB): 20-45 minutes
+ * - **Very Large** (>100GB): 45+ minutes
+ *
+ * Note: Restore operations take longer than backups due to safety backup step.
+ *
  * **Progress Monitoring:**
  * Use the returned operation_id to connect to the SSE stream:
  * ```javascript
@@ -1503,6 +1576,7 @@ export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(optio
  * eventSource.addEventListener('operation_progress', (event) => {
  * const data = JSON.parse(event.data);
  * console.log('Restore progress:', data.message);
+ * console.log('Status:', data.status); // Shows current state
  * });
  * ```
  *
@@ -3006,9 +3080,35 @@ export const getGraphs = <ThrowOnError extends boolean = false>(options?: Option
  * This endpoint starts an asynchronous graph creation operation and returns
  * connection details for monitoring progress via Server-Sent Events (SSE).
  *
- * **Operation Types:**
- * - **Generic Graph**: Creates empty graph with schema extensions
- * - **Entity Graph**: Creates graph with initial entity data
+ * **Graph Creation Options:**
+ *
+ * 1. **Entity Graph with Initial Entity** (`initial_entity` provided, `create_entity=True`):
+ * - Creates graph structure with entity schema extensions
+ * - Populates an initial entity node with provided data
+ * - Useful when you want a pre-configured entity to start with
+ * - Example: Creating a company graph with the company already populated
+ *
+ * 2. **Entity Graph without Initial Entity** (`initial_entity=None`, `create_entity=False`):
+ * - Creates graph structure with entity schema extensions
+ * - Graph starts empty, ready for data import
+ * - Useful for bulk data imports or custom workflows
+ * - Example: Creating a graph structure before importing from CSV/API
+ *
+ * 3. **Generic Graph** (no `initial_entity` provided):
+ * - Creates empty graph with custom schema extensions
+ * - General-purpose knowledge graph
+ * - Example: Analytics graphs, custom data models
+ *
+ * **Required Fields:**
+ * - `metadata.graph_name`: Unique name for the graph
+ * - `instance_tier`: Resource tier (kuzu-standard, kuzu-large, kuzu-xlarge)
+ *
+ * **Optional Fields:**
+ * - `metadata.description`: Human-readable description of the graph's purpose
+ * - `metadata.schema_extensions`: List of schema extensions (roboledger, roboinvestor, etc.)
+ * - `tags`: Organizational tags (max 10)
+ * - `initial_entity`: Entity data (required for entity graphs with initial data)
+ * - `create_entity`: Whether to populate initial entity (default: true when initial_entity provided)
  *
  * **Monitoring Progress:**
  * Use the returned `operation_id` to connect to the SSE stream:
@@ -3111,6 +3211,53 @@ export const getAvailableExtensions = <ThrowOnError extends boolean = false>(opt
     });
 };
 
+/**
+ * Get Available Graph Tiers
+ * List all available graph database tier configurations.
+ *
+ * This endpoint provides comprehensive technical specifications for each available
+ * graph database tier, including instance types, resource limits, and features.
+ *
+ * **Tier Information:**
+ * Each tier includes:
+ * - Technical specifications (instance type, memory, storage)
+ * - Resource limits (subgraphs, credits, rate limits)
+ * - Feature list with capabilities
+ * - Availability status
+ *
+ * **Available Tiers:**
+ * - **kuzu-standard**: Multi-tenant entry-level tier
+ * - **kuzu-large**: Dedicated professional tier with subgraph support
+ * - **kuzu-xlarge**: Enterprise tier with maximum resources
+ * - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
+ * - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
+ *
+ * **Use Cases:**
+ * - Display tier options in graph creation UI
+ * - Show technical specifications for tier selection
+ * - Validate tier availability before graph creation
+ * - Display feature comparisons
+ *
+ * **Note:**
+ * Tier listing is included - no credit consumption required.
+ */
+export const getAvailableGraphTiers = <ThrowOnError extends boolean = false>(options?: Options<GetAvailableGraphTiersData, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).get<GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, ThrowOnError>({
+        security: [
+            {
+                name: 'X-API-Key',
+                type: 'apiKey'
+            },
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/v1/graphs/tiers',
+        ...options
+    });
+};
+
 /**
  * Select Graph
  * Select a specific graph as the active workspace for the user.

package/sdk/types.gen.d.ts

@@ -365,7 +365,7 @@ export type AgentResponse = {
     } | null;
     /**
      * Confidence Score
-     * Confidence score of the response
+     * Confidence score of the response (0.0-1.0 scale)
      */
     confidence_score?: number | null;
     /**
@@ -491,6 +491,58 @@ export type BackupCreateRequest = {
      */
     schedule?: string | null;
 };
+/**
+ * BackupDownloadUrlResponse
+ * Response model for backup download URL generation.
+ */
+export type BackupDownloadUrlResponse = {
+    /**
+     * Download Url
+     * Pre-signed S3 URL for downloading the backup file
+     */
+    download_url: string;
+    /**
+     * Expires In
+     * URL expiration time in seconds from now
+     */
+    expires_in: number;
+    /**
+     * Expires At
+     * Unix timestamp when the URL expires
+     */
+    expires_at: number;
+    /**
+     * Backup Id
+     * Backup identifier
+     */
+    backup_id: string;
+    /**
+     * Graph Id
+     * Graph database identifier
+     */
+    graph_id: string;
+};
+/**
+ * BackupLimits
+ * Backup operation limits.
+ */
+export type BackupLimits = {
+    /**
+     * Max Backup Size Gb
+     * Maximum backup size in GB
+     */
+    max_backup_size_gb: number;
+    /**
+     * Backup Retention Days
+     * Backup retention period in days
+     */
+    backup_retention_days: number;
+    /**
+     * Max Backups Per Day
+     * Maximum backups per day
+     */
+    max_backups_per_day: number;
+};
 /**
  * BackupListResponse
  * Response model for backup list.
@@ -658,7 +710,7 @@ export type BackupStatsResponse = {
 export type BatchAgentRequest = {
     /**
      * Queries
-     * List of queries to process
+     * List of queries to process (max 10)
      */
     queries: Array<AgentRequest>;
     /**
@@ -674,12 +726,12 @@ export type BatchAgentRequest = {
 export type BatchAgentResponse = {
     /**
      * Results
-     * List of agent responses
+     * List of agent responses (includes successes and failures)
      */
     results: Array<AgentResponse>;
     /**
      * Total Execution Time
-     * Total execution time
+     * Total execution time in seconds
      */
     total_execution_time: number;
     /**
@@ -904,6 +956,42 @@ export type ConnectionResponse = {
         [key: string]: unknown;
     };
 };
+/**
+ * CopyOperationLimits
+ * Copy/ingestion operation limits.
+ */
+export type CopyOperationLimits = {
+    /**
+     * Max File Size Gb
+     * Maximum file size in GB
+     */
+    max_file_size_gb: number;
+    /**
+     * Timeout Seconds
+     * Operation timeout in seconds
+     */
+    timeout_seconds: number;
+    /**
+     * Concurrent Operations
+     * Maximum concurrent operations
+     */
+    concurrent_operations: number;
+    /**
+     * Max Files Per Operation
+     * Maximum files per operation
+     */
+    max_files_per_operation: number;
+    /**
+     * Daily Copy Operations
+     * Daily operation limit
+     */
+    daily_copy_operations: number;
+    /**
+     * Supported Formats
+     * Supported file formats
+     */
+    supported_formats: Array<string>;
+};
 /**
  * CreateAPIKeyRequest
  * Request model for creating a new API key.
@@ -962,6 +1050,10 @@ export type CreateConnectionRequest = {
 /**
  * CreateGraphRequest
  * Request model for creating a new graph.
+ *
+ * Use this to create either:
+ * - **Entity graphs**: Standard graphs with entity schema and optional extensions
+ * - **Custom graphs**: Generic graphs with fully custom schema definitions
  */
 export type CreateGraphRequest = {
     /**
@@ -974,11 +1066,11 @@ export type CreateGraphRequest = {
      */
     instance_tier?: string;
     /**
-     * Custom schema definition to apply
+     * Custom schema definition to apply. If provided, creates a generic custom graph. If omitted, creates an entity graph using schema_extensions.
      */
     custom_schema?: CustomSchemaDefinition | null;
     /**
-     * Optional initial entity to create in the graph. If provided, creates a entity-focused graph.
+     * Optional initial entity to create in the graph. If provided with entity graph, populates the first entity node.
      */
     initial_entity?: InitialEntityData | null;
     /**
@@ -1029,6 +1121,32 @@ export type CreateSubgraphRequest = {
         [key: string]: unknown;
     } | null;
 };
+/**
+ * CreditLimits
+ * AI credit limits (optional).
+ */
+export type CreditLimits = {
+    /**
+     * Monthly Ai Credits
+     * Monthly AI credits allocation
+     */
+    monthly_ai_credits: number;
+    /**
+     * Current Balance
+     * Current credit balance
+     */
+    current_balance: number;
+    /**
+     * Storage Billing Enabled
+     * Whether storage billing is enabled
+     */
+    storage_billing_enabled: boolean;
+    /**
+     * Storage Rate Per Gb Per Day
+     * Storage billing rate per GB per day
+     */
+    storage_rate_per_gb_per_day: number;
+};
 /**
  * CreditSummary
  * Credit balance summary.
@@ -1149,7 +1267,11 @@ export type CreditsSummaryResponse = {
 };
 /**
  * CustomSchemaDefinition
- * Custom schema definition for custom graphs.
+ * Custom schema definition for generic graphs.
+ *
+ * This model allows you to define custom node types, relationship types, and properties
+ * for graphs that don't fit the standard entity-based schema. Perfect for domain-specific
+ * applications like inventory systems, org charts, project management, etc.
  */
 export type CustomSchemaDefinition = {
     /**
@@ -1169,7 +1291,7 @@ export type CustomSchemaDefinition = {
     description?: string | null;
     /**
      * Extends
-     * Base schema to extend (e.g., 'base')
+     * Base schema to extend (e.g., 'base' for common utilities)
      */
     extends?: string | null;
     /**
@@ -1789,6 +1911,56 @@ export type GraphInfo = {
      */
     createdAt: string;
 };
+/**
+ * GraphLimitsResponse
+ * Response model for comprehensive graph operational limits.
+ */
+export type GraphLimitsResponse = {
+    /**
+     * Graph Id
+     * Graph database identifier
+     */
+    graph_id: string;
+    /**
+     * Subscription Tier
+     * User's subscription tier
+     */
+    subscription_tier: string;
+    /**
+     * Graph Tier
+     * Graph's database tier
+     */
+    graph_tier: string;
+    /**
+     * Is Shared Repository
+     * Whether this is a shared repository
+     */
+    is_shared_repository: boolean;
+    /**
+     * Storage limits and usage
+     */
+    storage: StorageLimits;
+    /**
+     * Query operation limits
+     */
+    queries: QueryLimits;
+    /**
+     * Copy/ingestion operation limits
+     */
+    copy_operations: CopyOperationLimits;
+    /**
+     * Backup operation limits
+     */
+    backups: BackupLimits;
+    /**
+     * API rate limits
+     */
+    rate_limits: RateLimits;
+    /**
+     * AI credit limits (if applicable)
+     */
+    credits?: CreditLimits | null;
+};
 /**
  * GraphMetadata
  * Metadata for graph creation.
@@ -1950,7 +2122,10 @@ export type HealthStatus = {
 };
 /**
  * InitialEntityData
- * Initial entity data for graph creation.
+ * Initial entity data for entity-focused graph creation.
+ *
+ * When creating an entity graph with an initial entity node, this model defines
+ * the entity's identifying information and metadata.
  */
 export type InitialEntityData = {
     /**
@@ -2327,6 +2502,32 @@ export type PlaidConnectionConfig = {
         [key: string]: unknown;
     }> | null;
 };
+/**
+ * QueryLimits
+ * Query operation limits.
+ */
+export type QueryLimits = {
+    /**
+     * Max Timeout Seconds
+     * Maximum query timeout in seconds
+     */
+    max_timeout_seconds: number;
+    /**
+     * Chunk Size
+     * Maximum chunk size for result streaming
+     */
+    chunk_size: number;
+    /**
+     * Max Rows Per Query
+     * Maximum rows returned per query
+     */
+    max_rows_per_query: number;
+    /**
+     * Concurrent Queries
+     * Maximum concurrent queries allowed
+     */
+    concurrent_queries: number;
+};
 /**
  * QuickBooksConnectionConfig
  * QuickBooks-specific connection configuration.
@@ -2343,6 +2544,27 @@ export type QuickBooksConnectionConfig = {
      */
     refresh_token?: string | null;
 };
+/**
+ * RateLimits
+ * API rate limits.
+ */
+export type RateLimits = {
+    /**
+     * Requests Per Minute
+     * Requests per minute limit
+     */
+    requests_per_minute: number;
+    /**
+     * Requests Per Hour
+     * Requests per hour limit
+     */
+    requests_per_hour: number;
+    /**
+     * Burst Capacity
+     * Burst capacity for short spikes
+     */
+    burst_capacity: number;
+};
 /**
  * RegisterRequest
  * Registration request model.
@@ -2722,6 +2944,27 @@ export type StorageLimitResponse = {
      */
     recommendations?: Array<string> | null;
 };
+/**
+ * StorageLimits
+ * Storage limits information.
+ */
+export type StorageLimits = {
+    /**
+     * Current Usage Gb
+     * Current storage usage in GB
+     */
+    current_usage_gb?: number | null;
+    /**
+     * Max Storage Gb
+     * Maximum storage limit in GB
+     */
+    max_storage_gb: number;
+    /**
+     * Approaching Limit
+     * Whether approaching storage limit (>80%)
+     */
+    approaching_limit: boolean;
+};
 /**
  * SubgraphQuotaResponse
  * Response model for subgraph quota information.
@@ -5218,12 +5461,9 @@ export type GetBackupDownloadUrlErrors = {
 export type GetBackupDownloadUrlError = GetBackupDownloadUrlErrors[keyof GetBackupDownloadUrlErrors];
 export type GetBackupDownloadUrlResponses = {
     /**
-     * Response Getbackupdownloadurl
      * Download URL generated successfully
      */
-    200: {
-        [key: string]: unknown;
-    };
+    200: BackupDownloadUrlResponse;
 };
 export type GetBackupDownloadUrlResponse = GetBackupDownloadUrlResponses[keyof GetBackupDownloadUrlResponses];
 export type RestoreBackupData = {
@@ -5434,12 +5674,23 @@ export type ExecuteCypherQueryResponses = {
     /**
      * Query executed successfully
      */
-    200: unknown;
+    200: {
+        success?: boolean;
+        data?: Array<{
+            [key: string]: unknown;
+        }>;
+        columns?: Array<string>;
+        row_count?: number;
+        execution_time_ms?: number;
+        graph_id?: string;
+        timestamp?: string;
+    };
     /**
      * Query queued for execution
      */
     202: unknown;
 };
+export type ExecuteCypherQueryResponse = ExecuteCypherQueryResponses[keyof ExecuteCypherQueryResponses];
 export type GetGraphSchemaData = {
     body?: never;
     path: {
@@ -6105,12 +6356,9 @@ export type GetGraphLimitsErrors = {
 export type GetGraphLimitsError = GetGraphLimitsErrors[keyof GetGraphLimitsErrors];
 export type GetGraphLimitsResponses = {
     /**
-     * Response Getgraphlimits
      * Limits retrieved successfully
      */
-    200: {
-        [key: string]: unknown;
-    };
+    200: GraphLimitsResponse;
 };
 export type GetGraphLimitsResponse = GetGraphLimitsResponses[keyof GetGraphLimitsResponses];
 export type ListSubgraphsData = {
@@ -6753,6 +7001,34 @@ export type GetAvailableExtensionsResponses = {
     200: AvailableExtensionsResponse;
 };
 export type GetAvailableExtensionsResponse = GetAvailableExtensionsResponses[keyof GetAvailableExtensionsResponses];
+export type GetAvailableGraphTiersData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Include Disabled
+         */
+        include_disabled?: boolean;
+    };
+    url: '/v1/graphs/tiers';
+};
+export type GetAvailableGraphTiersErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+    /**
+     * Failed to retrieve tiers
+     */
+    500: unknown;
+};
+export type GetAvailableGraphTiersError = GetAvailableGraphTiersErrors[keyof GetAvailableGraphTiersErrors];
+export type GetAvailableGraphTiersResponses = {
+    /**
+     * Tiers retrieved successfully
+     */
+    200: unknown;
+};
 export type SelectGraphData = {
     body?: never;
     path: {