@robosystems/client 0.2.13 → 0.2.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/sdk/sdk.gen.ts CHANGED
@@ -1116,6 +1116,13 @@ export const listAgents = <ThrowOnError extends boolean = false>(options: Option
1116
1116
  * - Leverage conversation history for contextual understanding
1117
1117
  * - Enable RAG for knowledge base enrichment
1118
1118
  *
1119
+ * **Subgraph Support:**
1120
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1121
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1122
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1123
+ * Agents operate on the specified graph/subgraph's data independently. RAG enrichment
1124
+ * and knowledge base search are scoped to the specific graph/subgraph.
1125
+ *
1119
1126
  * See request/response examples in the "Examples" dropdown below.
1120
1127
  */
1121
1128
  export const autoSelectAgent = <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => {
@@ -1300,6 +1307,13 @@ export const recommendAgent = <ThrowOnError extends boolean = false>(options: Op
1300
1307
  * - User permissions and subscription tier
1301
1308
  * - Backend capabilities (Kuzu, Neo4j, etc.)
1302
1309
  *
1310
+ * **Subgraph Support:**
1311
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1312
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1313
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1314
+ * The returned tool list is identical for parent graphs and subgraphs, as all
1315
+ * MCP tools work uniformly across graph boundaries.
1316
+ *
1303
1317
  * **Note:**
1304
1318
  * MCP tool listing is included - no credit consumption required.
1305
1319
  */
@@ -1354,6 +1368,13 @@ export const listMcpTools = <ThrowOnError extends boolean = false>(options: Opti
1354
1368
  * - `408 Request Timeout`: Tool execution exceeded timeout
1355
1369
  * - Clients should implement exponential backoff on errors
1356
1370
  *
1371
+ * **Subgraph Support:**
1372
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1373
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1374
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1375
+ * MCP tools operate on the specified graph/subgraph independently. Each subgraph
1376
+ * has its own schema, data, and can be queried separately via MCP.
1377
+ *
1357
1378
  * **Credit Model:**
1358
1379
  * MCP tool execution is included - no credit consumption required. Database
1359
1380
  * operations (queries, schema inspection, analytics) are completely free.
@@ -1761,6 +1782,12 @@ export const getGraphUsageAnalytics = <ThrowOnError extends boolean = false>(opt
1761
1782
  * - `503 Service Unavailable`: Circuit breaker open or SSE disabled
1762
1783
  * - Clients should implement exponential backoff
1763
1784
  *
1785
+ * **Subgraph Support:**
1786
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1787
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1788
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1789
+ * Subgraphs share the same instance as their parent graph and have independent data.
1790
+ *
1764
1791
  * **Note:**
1765
1792
  * Query operations are included - no credit consumption required.
1766
1793
  * Queue position is based on subscription tier for priority.
@@ -1823,6 +1850,14 @@ export const executeCypherQuery = <ThrowOnError extends boolean = false>(options
1823
1850
  * Property discovery is limited to 10 properties per node type for performance.
1824
1851
  * For complete schema definitions, use `/schema/export`.
1825
1852
  *
1853
+ * ## Subgraph Support
1854
+ *
1855
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1856
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1857
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1858
+ * Each subgraph has independent schema and data. The returned schema reflects
1859
+ * only the specified graph/subgraph's actual structure.
1860
+ *
1826
1861
  * This operation is included - no credit consumption required.
1827
1862
  */
1828
1863
  export const getGraphSchema = <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => {
@@ -1932,6 +1967,13 @@ export const exportGraphSchema = <ThrowOnError extends boolean = false>(options:
1932
1967
  * - Performance problems
1933
1968
  * - Naming conflicts
1934
1969
  *
1970
+ * **Subgraph Support:**
1971
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1972
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1973
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1974
+ * Schema validation is performed against the specified graph/subgraph's current
1975
+ * schema and data structure.
1976
+ *
1935
1977
  * This operation is included - no credit consumption required.
1936
1978
  */
1937
1979
  export const validateSchema = <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => {
@@ -2128,6 +2170,13 @@ export const checkStorageLimits = <ThrowOnError extends boolean = false>(options
2128
2170
  * - **Resource Usage**: Memory and storage consumption
2129
2171
  * - **Alerts**: Active warnings or issues
2130
2172
  *
2173
+ * **Subgraph Support:**
2174
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
2175
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
2176
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
2177
+ * Health metrics are specific to the requested graph/subgraph. Subgraphs share the
2178
+ * same physical instance as their parent but have independent health indicators.
2179
+ *
2131
2180
  * This endpoint provides essential monitoring data for operational visibility.
2132
2181
  */
2133
2182
  export const getDatabaseHealth = <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => {
@@ -2166,6 +2215,13 @@ export const getDatabaseHealth = <ThrowOnError extends boolean = false>(options:
2166
2215
  * - **Backup Status**: Backup availability and recency
2167
2216
  * - **Timestamps**: Creation and modification dates
2168
2217
  *
2218
+ * **Subgraph Support:**
2219
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
2220
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
2221
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
2222
+ * Returned metrics are specific to the requested graph/subgraph. Subgraphs have
2223
+ * independent size, node/relationship counts, and backup status.
2224
+ *
2169
2225
  * This endpoint provides essential database information for capacity planning and monitoring.
2170
2226
  */
2171
2227
  export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => {
@@ -2199,7 +2255,7 @@ export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: O
2199
2255
  *
2200
2256
  * This unified endpoint provides all limits in one place for easier client integration.
2201
2257
  *
2202
- * **Note**: Limits vary based on subscription tier (Standard, Enterprise, Premium).
2258
+ * **Note**: Limits vary based on subscription tier (kuzu-standard, kuzu-large, kuzu-xlarge).
2203
2259
  */
2204
2260
  export const getGraphLimits = <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => {
2205
2261
  return (options.client ?? _heyApiClient).get<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError>({
@@ -2262,6 +2318,12 @@ export const listSubgraphs = <ThrowOnError extends boolean = false>(options: Opt
2262
2318
  *
2263
2319
  * **Returns:**
2264
2320
  * - Created subgraph details including its unique ID
2321
+ * - Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
2322
+ *
2323
+ * **Usage:**
2324
+ * - Subgraphs share parent's credit pool
2325
+ * - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}*` endpoints
2326
+ * - Permissions inherited from parent graph
2265
2327
  */
2266
2328
  export const createSubgraph = <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => {
2267
2329
  return (options.client ?? _heyApiClient).post<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError>({
@@ -2291,6 +2353,7 @@ export const createSubgraph = <ThrowOnError extends boolean = false>(options: Op
2291
2353
  * **Requirements:**
2292
2354
  * - Must be a valid subgraph (not parent graph)
2293
2355
  * - User must have admin access to parent graph
2356
+ * - Subgraph name must be alphanumeric (1-20 characters)
2294
2357
  * - Optional backup before deletion
2295
2358
  *
2296
2359
  * **Deletion Options:**
@@ -2304,6 +2367,11 @@ export const createSubgraph = <ThrowOnError extends boolean = false>(options: Op
2304
2367
  * **Backup Location:**
2305
2368
  * If backup requested, stored in S3 Kuzu database bucket at:
2306
2369
  * `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
2370
+ *
2371
+ * **Notes:**
2372
+ * - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
2373
+ * - Deletion does not affect parent graph's credit pool or permissions
2374
+ * - Backup creation consumes credits from parent graph's allocation
2307
2375
  */
2308
2376
  export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => {
2309
2377
  return (options.client ?? _heyApiClient).delete<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError>({
@@ -2317,7 +2385,7 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
2317
2385
  type: 'http'
2318
2386
  }
2319
2387
  ],
2320
- url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}',
2388
+ url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}',
2321
2389
  ...options,
2322
2390
  headers: {
2323
2391
  'Content-Type': 'application/json',
@@ -2332,6 +2400,7 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
2332
2400
  *
2333
2401
  * **Requirements:**
2334
2402
  * - User must have read access to parent graph
2403
+ * - Subgraph name must be alphanumeric (1-20 characters)
2335
2404
  *
2336
2405
  * **Response includes:**
2337
2406
  * - Full subgraph metadata
@@ -2347,6 +2416,10 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
2347
2416
  * - Edge count
2348
2417
  * - Database size on disk
2349
2418
  * - Schema information
2419
+ *
2420
+ * **Note:**
2421
+ * Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
2422
+ * The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
2350
2423
  */
2351
2424
  export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => {
2352
2425
  return (options.client ?? _heyApiClient).get<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError>({
@@ -2360,7 +2433,7 @@ export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: O
2360
2433
  type: 'http'
2361
2434
  }
2362
2435
  ],
2363
- url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}/info',
2436
+ url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info',
2364
2437
  ...options
2365
2438
  });
2366
2439
  };
@@ -2624,6 +2697,13 @@ export const listTableFiles = <ThrowOnError extends boolean = false>(options: Op
2624
2697
  * Tables are automatically created on first file upload with type inferred from name
2625
2698
  * (e.g., "Transaction" → relationship) and empty schema populated during ingestion.
2626
2699
  *
2700
+ * **Subgraph Support:**
2701
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
2702
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
2703
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
2704
+ * Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
2705
+ * to one subgraph do not appear in other subgraphs.
2706
+ *
2627
2707
  * **Important Notes:**
2628
2708
  * - Presigned URLs expire (default: 1 hour)
2629
2709
  * - Use appropriate Content-Type header when uploading to S3
@@ -2815,7 +2895,7 @@ export const updateFileStatus = <ThrowOnError extends boolean = false>(options:
2815
2895
  * 2. Files are validated and marked as 'uploaded'
2816
2896
  * 3. Trigger ingestion: `POST /tables/ingest`
2817
2897
  * 4. DuckDB staging tables created from S3 patterns
2818
- * 5. Data copied row-by-row from DuckDB to Kuzu
2898
+ * 5. Data copied from DuckDB to Kuzu
2819
2899
  * 6. Per-table results and metrics returned
2820
2900
  *
2821
2901
  * **Rebuild Feature:**
@@ -2846,6 +2926,13 @@ export const updateFileStatus = <ThrowOnError extends boolean = false>(options:
2846
2926
  * you'll receive a 409 Conflict error. The distributed lock automatically expires after
2847
2927
  * the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
2848
2928
  *
2929
+ * **Subgraph Support:**
2930
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
2931
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
2932
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
2933
+ * Each subgraph has independent staging tables and graph data. Ingestion operates
2934
+ * on the specified graph/subgraph only and does not affect other subgraphs.
2935
+ *
2849
2936
  * **Important Notes:**
2850
2937
  * - Only files with 'uploaded' status are processed
2851
2938
  * - Tables with no uploaded files are skipped
@@ -2922,6 +3009,12 @@ export const ingestTables = <ThrowOnError extends boolean = false>(options: Opti
2922
3009
  * - Read-only: No INSERT, UPDATE, DELETE
2923
3010
  * - User's tables only: Cannot query other users' data
2924
3011
  *
3012
+ * **Subgraph Support:**
3013
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
3014
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
3015
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
3016
+ * Each subgraph has its own independent staging tables.
3017
+ *
2925
3018
  * **Shared Repositories:**
2926
3019
  * Shared repositories (SEC, etc.) do not allow direct SQL queries.
2927
3020
  * Use the graph query endpoint instead: `POST /v1/graphs/{graph_id}/query`
@@ -3400,17 +3400,17 @@ export type PaymentMethod = {
3400
3400
  brand?: string | null;
3401
3401
  /**
3402
3402
  * Last4
3403
- * Last 4 digits
3403
+ * Last 4 digits of the card or account number
3404
3404
  */
3405
3405
  last4?: string | null;
3406
3406
  /**
3407
3407
  * Exp Month
3408
- * Expiration month
3408
+ * Expiration month of the card
3409
3409
  */
3410
3410
  exp_month?: number | null;
3411
3411
  /**
3412
3412
  * Exp Year
3413
- * Expiration year
3413
+ * Expiration year of the card
3414
3414
  */
3415
3415
  exp_year?: number | null;
3416
3416
  /**
@@ -7107,13 +7107,13 @@ export type DeleteSubgraphData = {
7107
7107
  */
7108
7108
  graph_id: string;
7109
7109
  /**
7110
- * Subgraph Id
7111
- * Subgraph identifier to delete
7110
+ * Subgraph Name
7111
+ * Subgraph name to delete (e.g., 'dev', 'staging')
7112
7112
  */
7113
- subgraph_id: string;
7113
+ subgraph_name: string;
7114
7114
  };
7115
7115
  query?: never;
7116
- url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}';
7116
+ url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}';
7117
7117
  };
7118
7118
  export type DeleteSubgraphErrors = {
7119
7119
  /**
@@ -7161,13 +7161,13 @@ export type GetSubgraphInfoData = {
7161
7161
  */
7162
7162
  graph_id: string;
7163
7163
  /**
7164
- * Subgraph Id
7165
- * Subgraph identifier
7164
+ * Subgraph Name
7165
+ * Subgraph name (e.g., 'dev', 'staging')
7166
7166
  */
7167
- subgraph_id: string;
7167
+ subgraph_name: string;
7168
7168
  };
7169
7169
  query?: never;
7170
- url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}/info';
7170
+ url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info';
7171
7171
  };
7172
7172
  export type GetSubgraphInfoErrors = {
7173
7173
  /**
package/sdk/types.gen.ts CHANGED
@@ -3509,17 +3509,17 @@ export type PaymentMethod = {
3509
3509
  brand?: string | null;
3510
3510
  /**
3511
3511
  * Last4
3512
- * Last 4 digits
3512
+ * Last 4 digits of the card or account number
3513
3513
  */
3514
3514
  last4?: string | null;
3515
3515
  /**
3516
3516
  * Exp Month
3517
- * Expiration month
3517
+ * Expiration month of the card
3518
3518
  */
3519
3519
  exp_month?: number | null;
3520
3520
  /**
3521
3521
  * Exp Year
3522
- * Expiration year
3522
+ * Expiration year of the card
3523
3523
  */
3524
3524
  exp_year?: number | null;
3525
3525
  /**
@@ -7617,13 +7617,13 @@ export type DeleteSubgraphData = {
7617
7617
  */
7618
7618
  graph_id: string;
7619
7619
  /**
7620
- * Subgraph Id
7621
- * Subgraph identifier to delete
7620
+ * Subgraph Name
7621
+ * Subgraph name to delete (e.g., 'dev', 'staging')
7622
7622
  */
7623
- subgraph_id: string;
7623
+ subgraph_name: string;
7624
7624
  };
7625
7625
  query?: never;
7626
- url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}';
7626
+ url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}';
7627
7627
  };
7628
7628
 
7629
7629
  export type DeleteSubgraphErrors = {
@@ -7676,13 +7676,13 @@ export type GetSubgraphInfoData = {
7676
7676
  */
7677
7677
  graph_id: string;
7678
7678
  /**
7679
- * Subgraph Id
7680
- * Subgraph identifier
7679
+ * Subgraph Name
7680
+ * Subgraph name (e.g., 'dev', 'staging')
7681
7681
  */
7682
- subgraph_id: string;
7682
+ subgraph_name: string;
7683
7683
  };
7684
7684
  query?: never;
7685
- url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}/info';
7685
+ url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info';
7686
7686
  };
7687
7687
 
7688
7688
  export type GetSubgraphInfoErrors = {
package/sdk.gen.d.ts CHANGED
@@ -457,6 +457,13 @@ export declare const listAgents: <ThrowOnError extends boolean = false>(options:
457
457
  * - Leverage conversation history for contextual understanding
458
458
  * - Enable RAG for knowledge base enrichment
459
459
  *
460
+ * **Subgraph Support:**
461
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
462
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
463
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
464
+ * Agents operate on the specified graph/subgraph's data independently. RAG enrichment
465
+ * and knowledge base search are scoped to the specific graph/subgraph.
466
+ *
460
467
  * See request/response examples in the "Examples" dropdown below.
461
468
  */
462
469
  export declare const autoSelectAgent: <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => import("./client").RequestResult<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError, "fields">;
@@ -545,6 +552,13 @@ export declare const recommendAgent: <ThrowOnError extends boolean = false>(opti
545
552
  * - User permissions and subscription tier
546
553
  * - Backend capabilities (Kuzu, Neo4j, etc.)
547
554
  *
555
+ * **Subgraph Support:**
556
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
557
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
558
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
559
+ * The returned tool list is identical for parent graphs and subgraphs, as all
560
+ * MCP tools work uniformly across graph boundaries.
561
+ *
548
562
  * **Note:**
549
563
  * MCP tool listing is included - no credit consumption required.
550
564
  */
@@ -583,6 +597,13 @@ export declare const listMcpTools: <ThrowOnError extends boolean = false>(option
583
597
  * - `408 Request Timeout`: Tool execution exceeded timeout
584
598
  * - Clients should implement exponential backoff on errors
585
599
  *
600
+ * **Subgraph Support:**
601
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
602
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
603
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
604
+ * MCP tools operate on the specified graph/subgraph independently. Each subgraph
605
+ * has its own schema, data, and can be queried separately via MCP.
606
+ *
586
607
  * **Credit Model:**
587
608
  * MCP tool execution is included - no credit consumption required. Database
588
609
  * operations (queries, schema inspection, analytics) are completely free.
@@ -850,6 +871,12 @@ export declare const getGraphUsageAnalytics: <ThrowOnError extends boolean = fal
850
871
  * - `503 Service Unavailable`: Circuit breaker open or SSE disabled
851
872
  * - Clients should implement exponential backoff
852
873
  *
874
+ * **Subgraph Support:**
875
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
876
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
877
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
878
+ * Subgraphs share the same instance as their parent graph and have independent data.
879
+ *
853
880
  * **Note:**
854
881
  * Query operations are included - no credit consumption required.
855
882
  * Queue position is based on subscription tier for priority.
@@ -892,6 +919,14 @@ export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(
892
919
  * Property discovery is limited to 10 properties per node type for performance.
893
920
  * For complete schema definitions, use `/schema/export`.
894
921
  *
922
+ * ## Subgraph Support
923
+ *
924
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
925
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
926
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
927
+ * Each subgraph has independent schema and data. The returned schema reflects
928
+ * only the specified graph/subgraph's actual structure.
929
+ *
895
930
  * This operation is included - no credit consumption required.
896
931
  */
897
932
  export declare const getGraphSchema: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => import("./client").RequestResult<GetGraphSchemaResponses, GetGraphSchemaErrors, ThrowOnError, "fields">;
@@ -969,6 +1004,13 @@ export declare const exportGraphSchema: <ThrowOnError extends boolean = false>(o
969
1004
  * - Performance problems
970
1005
  * - Naming conflicts
971
1006
  *
1007
+ * **Subgraph Support:**
1008
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1009
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1010
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1011
+ * Schema validation is performed against the specified graph/subgraph's current
1012
+ * schema and data structure.
1013
+ *
972
1014
  * This operation is included - no credit consumption required.
973
1015
  */
974
1016
  export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => import("./client").RequestResult<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError, "fields">;
@@ -1065,6 +1107,13 @@ export declare const checkStorageLimits: <ThrowOnError extends boolean = false>(
1065
1107
  * - **Resource Usage**: Memory and storage consumption
1066
1108
  * - **Alerts**: Active warnings or issues
1067
1109
  *
1110
+ * **Subgraph Support:**
1111
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1112
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1113
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1114
+ * Health metrics are specific to the requested graph/subgraph. Subgraphs share the
1115
+ * same physical instance as their parent but have independent health indicators.
1116
+ *
1068
1117
  * This endpoint provides essential monitoring data for operational visibility.
1069
1118
  */
1070
1119
  export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseHealthResponses, GetDatabaseHealthErrors, ThrowOnError, "fields">;
@@ -1087,6 +1136,13 @@ export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(o
1087
1136
  * - **Backup Status**: Backup availability and recency
1088
1137
  * - **Timestamps**: Creation and modification dates
1089
1138
  *
1139
+ * **Subgraph Support:**
1140
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1141
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1142
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1143
+ * Returned metrics are specific to the requested graph/subgraph. Subgraphs have
1144
+ * independent size, node/relationship counts, and backup status.
1145
+ *
1090
1146
  * This endpoint provides essential database information for capacity planning and monitoring.
1091
1147
  */
1092
1148
  export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseInfoResponses, GetDatabaseInfoErrors, ThrowOnError, "fields">;
@@ -1104,7 +1160,7 @@ export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(opt
1104
1160
  *
1105
1161
  * This unified endpoint provides all limits in one place for easier client integration.
1106
1162
  *
1107
- * **Note**: Limits vary based on subscription tier (Standard, Enterprise, Premium).
1163
+ * **Note**: Limits vary based on subscription tier (kuzu-standard, kuzu-large, kuzu-xlarge).
1108
1164
  */
1109
1165
  export declare const getGraphLimits: <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => import("./client").RequestResult<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError, "fields">;
1110
1166
  /**
@@ -1135,6 +1191,12 @@ export declare const listSubgraphs: <ThrowOnError extends boolean = false>(optio
1135
1191
  *
1136
1192
  * **Returns:**
1137
1193
  * - Created subgraph details including its unique ID
1194
+ * - Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
1195
+ *
1196
+ * **Usage:**
1197
+ * - Subgraphs share parent's credit pool
1198
+ * - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}*` endpoints
1199
+ * - Permissions inherited from parent graph
1138
1200
  */
1139
1201
  export declare const createSubgraph: <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => import("./client").RequestResult<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError, "fields">;
1140
1202
  /**
@@ -1144,6 +1206,7 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
1144
1206
  * **Requirements:**
1145
1207
  * - Must be a valid subgraph (not parent graph)
1146
1208
  * - User must have admin access to parent graph
1209
+ * - Subgraph name must be alphanumeric (1-20 characters)
1147
1210
  * - Optional backup before deletion
1148
1211
  *
1149
1212
  * **Deletion Options:**
@@ -1157,6 +1220,11 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
1157
1220
  * **Backup Location:**
1158
1221
  * If backup requested, stored in S3 Kuzu database bucket at:
1159
1222
  * `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
1223
+ *
1224
+ * **Notes:**
1225
+ * - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
1226
+ * - Deletion does not affect parent graph's credit pool or permissions
1227
+ * - Backup creation consumes credits from parent graph's allocation
1160
1228
  */
1161
1229
  export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => import("./client").RequestResult<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError, "fields">;
1162
1230
  /**
@@ -1165,6 +1233,7 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
1165
1233
  *
1166
1234
  * **Requirements:**
1167
1235
  * - User must have read access to parent graph
1236
+ * - Subgraph name must be alphanumeric (1-20 characters)
1168
1237
  *
1169
1238
  * **Response includes:**
1170
1239
  * - Full subgraph metadata
@@ -1180,6 +1249,10 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
1180
1249
  * - Edge count
1181
1250
  * - Database size on disk
1182
1251
  * - Schema information
1252
+ *
1253
+ * **Note:**
1254
+ * Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
1255
+ * The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
1183
1256
  */
1184
1257
  export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError, "fields">;
1185
1258
  /**
@@ -1337,6 +1410,13 @@ export declare const listTableFiles: <ThrowOnError extends boolean = false>(opti
1337
1410
  * Tables are automatically created on first file upload with type inferred from name
1338
1411
  * (e.g., "Transaction" → relationship) and empty schema populated during ingestion.
1339
1412
  *
1413
+ * **Subgraph Support:**
1414
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1415
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1416
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1417
+ * Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
1418
+ * to one subgraph do not appear in other subgraphs.
1419
+ *
1340
1420
  * **Important Notes:**
1341
1421
  * - Presigned URLs expire (default: 1 hour)
1342
1422
  * - Use appropriate Content-Type header when uploading to S3
@@ -1456,7 +1536,7 @@ export declare const updateFileStatus: <ThrowOnError extends boolean = false>(op
1456
1536
  * 2. Files are validated and marked as 'uploaded'
1457
1537
  * 3. Trigger ingestion: `POST /tables/ingest`
1458
1538
  * 4. DuckDB staging tables created from S3 patterns
1459
- * 5. Data copied row-by-row from DuckDB to Kuzu
1539
+ * 5. Data copied from DuckDB to Kuzu
1460
1540
  * 6. Per-table results and metrics returned
1461
1541
  *
1462
1542
  * **Rebuild Feature:**
@@ -1487,6 +1567,13 @@ export declare const updateFileStatus: <ThrowOnError extends boolean = false>(op
1487
1567
  * you'll receive a 409 Conflict error. The distributed lock automatically expires after
1488
1568
  * the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
1489
1569
  *
1570
+ * **Subgraph Support:**
1571
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1572
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1573
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1574
+ * Each subgraph has independent staging tables and graph data. Ingestion operates
1575
+ * on the specified graph/subgraph only and does not affect other subgraphs.
1576
+ *
1490
1577
  * **Important Notes:**
1491
1578
  * - Only files with 'uploaded' status are processed
1492
1579
  * - Tables with no uploaded files are skipped
@@ -1543,6 +1630,12 @@ export declare const ingestTables: <ThrowOnError extends boolean = false>(option
1543
1630
  * - Read-only: No INSERT, UPDATE, DELETE
1544
1631
  * - User's tables only: Cannot query other users' data
1545
1632
  *
1633
+ * **Subgraph Support:**
1634
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
1635
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
1636
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
1637
+ * Each subgraph has its own independent staging tables.
1638
+ *
1546
1639
  * **Shared Repositories:**
1547
1640
  * Shared repositories (SEC, etc.) do not allow direct SQL queries.
1548
1641
  * Use the graph query endpoint instead: `POST /v1/graphs/{graph_id}/query`