@robosystems/client 0.2.11 → 0.2.12

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.gen.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
3
  import type { Options as ClientOptions, TDataShape, Client } from './client';
4
- 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, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ListUserOrgsData, ListUserOrgsResponses, CreateOrgData, CreateOrgResponses, CreateOrgErrors, GetOrgData, GetOrgResponses, GetOrgErrors, UpdateOrgData, UpdateOrgResponses, UpdateOrgErrors, ListOrgGraphsData, ListOrgGraphsResponses, ListOrgGraphsErrors, ListOrgMembersData, ListOrgMembersResponses, ListOrgMembersErrors, InviteOrgMemberData, InviteOrgMemberResponses, InviteOrgMemberErrors, RemoveOrgMemberData, RemoveOrgMemberResponses, RemoveOrgMemberErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, GetOrgLimitsData, GetOrgLimitsResponses, GetOrgLimitsErrors, GetOrgUsageData, GetOrgUsageResponses, GetOrgUsageErrors, 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, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, 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, CancelSubscriptionData, CancelSubscriptionResponses, CancelSubscriptionErrors, GetGraphSubscriptionData, GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, CreateRepositorySubscriptionData, CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, UpgradeSubscriptionData, UpgradeSubscriptionResponses, UpgradeSubscriptionErrors, 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, GetOrgBillingCustomerData, GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, UpdateOrgPaymentMethodData, UpdateOrgPaymentMethodResponses, UpdateOrgPaymentMethodErrors, ListOrgSubscriptionsData, ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, GetOrgSubscriptionData, GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, CancelOrgSubscriptionData, CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ListOrgInvoicesData, ListOrgInvoicesResponses, ListOrgInvoicesErrors, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, CreateCheckoutSessionData, CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, GetCheckoutStatusData, GetCheckoutStatusResponses, GetCheckoutStatusErrors } from './types.gen';
4
+ 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, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ListUserOrgsData, ListUserOrgsResponses, CreateOrgData, CreateOrgResponses, CreateOrgErrors, GetOrgData, GetOrgResponses, GetOrgErrors, UpdateOrgData, UpdateOrgResponses, UpdateOrgErrors, ListOrgGraphsData, ListOrgGraphsResponses, ListOrgGraphsErrors, ListOrgMembersData, ListOrgMembersResponses, ListOrgMembersErrors, InviteOrgMemberData, InviteOrgMemberResponses, InviteOrgMemberErrors, RemoveOrgMemberData, RemoveOrgMemberResponses, RemoveOrgMemberErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, GetOrgLimitsData, GetOrgLimitsResponses, GetOrgLimitsErrors, GetOrgUsageData, GetOrgUsageResponses, GetOrgUsageErrors, 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, ListAgentsData, ListAgentsResponses, ListAgentsErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, 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, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, 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, CancelSubscriptionData, CancelSubscriptionResponses, CancelSubscriptionErrors, GetGraphSubscriptionData, GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, CreateRepositorySubscriptionData, CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, UpgradeSubscriptionData, UpgradeSubscriptionResponses, UpgradeSubscriptionErrors, 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, GetOrgBillingCustomerData, GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, UpdateOrgPaymentMethodData, UpdateOrgPaymentMethodResponses, UpdateOrgPaymentMethodErrors, ListOrgSubscriptionsData, ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, GetOrgSubscriptionData, GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, CancelOrgSubscriptionData, CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ListOrgInvoicesData, ListOrgInvoicesResponses, ListOrgInvoicesErrors, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, CreateCheckoutSessionData, CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, GetCheckoutStatusData, GetCheckoutStatusResponses, GetCheckoutStatusErrors } from './types.gen';
5
5
  import { client as _heyApiClient } from './client.gen';
6
6
 
7
7
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
@@ -1035,9 +1035,38 @@ export const syncConnection = <ThrowOnError extends boolean = false>(options: Op
1035
1035
  });
1036
1036
  };
1037
1037
 
1038
+ /**
1039
+ * List available agents
1040
+ * Get a comprehensive list of all available agents with their metadata.
1041
+ *
1042
+ * **Returns:**
1043
+ * - Agent types and names
1044
+ * - Capabilities and supported modes
1045
+ * - Version information
1046
+ * - Credit requirements
1047
+ *
1048
+ * Use the optional `capability` filter to find agents with specific capabilities.
1049
+ */
1050
+ export const listAgents = <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => {
1051
+ return (options.client ?? _heyApiClient).get<ListAgentsResponses, ListAgentsErrors, ThrowOnError>({
1052
+ security: [
1053
+ {
1054
+ name: 'X-API-Key',
1055
+ type: 'apiKey'
1056
+ },
1057
+ {
1058
+ scheme: 'bearer',
1059
+ type: 'http'
1060
+ }
1061
+ ],
1062
+ url: '/v1/graphs/{graph_id}/agent',
1063
+ ...options
1064
+ });
1065
+ };
1066
+
1038
1067
  /**
1039
1068
  * Auto-select agent for query
1040
- * Automatically select the best agent for your query.
1069
+ * Automatically select the best agent for your query with intelligent execution strategy.
1041
1070
  *
1042
1071
  * **Agent Selection Process:**
1043
1072
  *
@@ -1046,7 +1075,8 @@ export const syncConnection = <ThrowOnError extends boolean = false>(options: Op
1046
1075
  * 2. Enriching context with RAG if enabled
1047
1076
  * 3. Evaluating all available agents against selection criteria
1048
1077
  * 4. Selecting the best match based on confidence scores
1049
- * 5. Executing the query with the selected agent
1078
+ * 5. Choosing execution strategy (sync/SSE/async) based on expected time
1079
+ * 6. Executing the query with the selected agent
1050
1080
  *
1051
1081
  * **Available Agent Types:**
1052
1082
  * - `financial`: Financial analysis, SEC filings, company metrics
@@ -1059,6 +1089,14 @@ export const syncConnection = <ThrowOnError extends boolean = false>(options: Op
1059
1089
  * - `extended`: Comprehensive analysis (~15-60s), deep research
1060
1090
  * - `streaming`: Real-time response streaming
1061
1091
  *
1092
+ * **Execution Strategies (automatic):**
1093
+ * - Fast operations (<5s): Immediate synchronous response
1094
+ * - Medium operations (5-30s): SSE streaming with progress updates
1095
+ * - Long operations (>30s): Async Celery worker with operation tracking
1096
+ *
1097
+ * **Response Mode Override:**
1098
+ * Use query parameter `?mode=sync|async` to override automatic strategy selection.
1099
+ *
1062
1100
  * **Confidence Score Interpretation:**
1063
1101
  * - `0.9-1.0`: High confidence, agent is ideal match
1064
1102
  * - `0.7-0.9`: Good confidence, agent is suitable
@@ -1101,15 +1139,54 @@ export const autoSelectAgent = <ThrowOnError extends boolean = false>(options: O
1101
1139
  });
1102
1140
  };
1103
1141
 
1142
+ /**
1143
+ * Get agent metadata
1144
+ * Get comprehensive metadata for a specific agent type.
1145
+ *
1146
+ * **Returns:**
1147
+ * - Agent name and description
1148
+ * - Version information
1149
+ * - Supported capabilities and modes
1150
+ * - Credit requirements
1151
+ * - Author and tags
1152
+ * - Configuration options
1153
+ *
1154
+ * Use this to understand agent capabilities before execution.
1155
+ */
1156
+ export const getAgentMetadata = <ThrowOnError extends boolean = false>(options: Options<GetAgentMetadataData, ThrowOnError>) => {
1157
+ return (options.client ?? _heyApiClient).get<GetAgentMetadataResponses, GetAgentMetadataErrors, ThrowOnError>({
1158
+ security: [
1159
+ {
1160
+ name: 'X-API-Key',
1161
+ type: 'apiKey'
1162
+ },
1163
+ {
1164
+ scheme: 'bearer',
1165
+ type: 'http'
1166
+ }
1167
+ ],
1168
+ url: '/v1/graphs/{graph_id}/agent/{agent_type}',
1169
+ ...options
1170
+ });
1171
+ };
1172
+
1104
1173
  /**
1105
1174
  * Execute specific agent
1106
- * Execute a specific agent type directly.
1175
+ * Execute a specific agent type directly with intelligent execution strategy.
1107
1176
  *
1108
1177
  * Available agents:
1109
1178
  * - **financial**: Financial analysis, SEC filings, accounting data
1110
1179
  * - **research**: Deep research and comprehensive analysis
1111
1180
  * - **rag**: Fast retrieval without AI (no credits required)
1112
1181
  *
1182
+ * **Execution Strategies (automatic):**
1183
+ * - Fast operations (<5s): Immediate synchronous response
1184
+ * - Medium operations (5-30s): SSE streaming with progress updates
1185
+ * - Long operations (>30s): Async Celery worker with operation tracking
1186
+ *
1187
+ * **Response Mode Override:**
1188
+ * Use query parameter `?mode=sync|async` to override automatic strategy selection.
1189
+ *
1113
1190
  * Use this endpoint when you know which agent you want to use.
1114
1191
  */
1115
1192
  export const executeSpecificAgent = <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificAgentData, ThrowOnError>) => {
@@ -1171,66 +1248,6 @@ export const batchProcessQueries = <ThrowOnError extends boolean = false>(option
1171
1248
  });
1172
1249
  };
1173
1250
 
1174
- /**
1175
- * List available agents
1176
- * Get a comprehensive list of all available agents with their metadata.
1177
- *
1178
- * **Returns:**
1179
- * - Agent types and names
1180
- * - Capabilities and supported modes
1181
- * - Version information
1182
- * - Credit requirements
1183
- *
1184
- * Use the optional `capability` filter to find agents with specific capabilities.
1185
- */
1186
- export const listAgents = <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => {
1187
- return (options.client ?? _heyApiClient).get<ListAgentsResponses, ListAgentsErrors, ThrowOnError>({
1188
- security: [
1189
- {
1190
- name: 'X-API-Key',
1191
- type: 'apiKey'
1192
- },
1193
- {
1194
- scheme: 'bearer',
1195
- type: 'http'
1196
- }
1197
- ],
1198
- url: '/v1/graphs/{graph_id}/agent/list',
1199
- ...options
1200
- });
1201
- };
1202
-
1203
- /**
1204
- * Get agent metadata
1205
- * Get comprehensive metadata for a specific agent type.
1206
- *
1207
- * **Returns:**
1208
- * - Agent name and description
1209
- * - Version information
1210
- * - Supported capabilities and modes
1211
- * - Credit requirements
1212
- * - Author and tags
1213
- * - Configuration options
1214
- *
1215
- * Use this to understand agent capabilities before execution.
1216
- */
1217
- export const getAgentMetadata = <ThrowOnError extends boolean = false>(options: Options<GetAgentMetadataData, ThrowOnError>) => {
1218
- return (options.client ?? _heyApiClient).get<GetAgentMetadataResponses, GetAgentMetadataErrors, ThrowOnError>({
1219
- security: [
1220
- {
1221
- name: 'X-API-Key',
1222
- type: 'apiKey'
1223
- },
1224
- {
1225
- scheme: 'bearer',
1226
- type: 'http'
1227
- }
1228
- ],
1229
- url: '/v1/graphs/{graph_id}/agent/{agent_type}/metadata',
1230
- ...options
1231
- });
1232
- };
1233
-
1234
1251
  /**
1235
1252
  * Get agent recommendations
1236
1253
  * Get intelligent agent recommendations for a specific query.
package/types.gen.d.ts CHANGED
@@ -882,7 +882,7 @@ export type CheckoutStatusResponse = {
882
882
  subscription_id: string;
883
883
  /**
884
884
  * Resource Id
885
- * Resource ID (graph_id or repository name) once provisioned
885
+ * Resource ID (graph_id for both graphs and repositories) once provisioned. For repositories, this is the repository slug (e.g., 'sec')
886
886
  */
887
887
  resource_id?: string | null;
888
888
  /**
@@ -1115,7 +1115,7 @@ export type CreateCheckoutRequest = {
1115
1115
  resource_type: string;
1116
1116
  /**
1117
1117
  * Resource Config
1118
- * Configuration for the resource to be provisioned
1118
+ * Configuration for the resource to be provisioned. For repositories: {'repository_name': 'graph_id'} where graph_id is the repository slug (e.g., 'sec')
1119
1119
  */
1120
1120
  resource_config: {
1121
1121
  [key: string]: unknown;
@@ -5885,6 +5885,41 @@ export type SyncConnectionResponses = {
5885
5885
  };
5886
5886
  };
5887
5887
  export type SyncConnectionResponse = SyncConnectionResponses[keyof SyncConnectionResponses];
5888
+ export type ListAgentsData = {
5889
+ body?: never;
5890
+ path: {
5891
+ /**
5892
+ * Graph Id
5893
+ */
5894
+ graph_id: string;
5895
+ };
5896
+ query?: {
5897
+ /**
5898
+ * Capability
5899
+ * Filter by capability (e.g., 'financial_analysis', 'rag_search')
5900
+ */
5901
+ capability?: string | null;
5902
+ };
5903
+ url: '/v1/graphs/{graph_id}/agent';
5904
+ };
5905
+ export type ListAgentsErrors = {
5906
+ /**
5907
+ * Unauthorized - Invalid or missing authentication
5908
+ */
5909
+ 401: unknown;
5910
+ /**
5911
+ * Validation Error
5912
+ */
5913
+ 422: HttpValidationError;
5914
+ };
5915
+ export type ListAgentsError = ListAgentsErrors[keyof ListAgentsErrors];
5916
+ export type ListAgentsResponses = {
5917
+ /**
5918
+ * List of agents retrieved successfully
5919
+ */
5920
+ 200: AgentListResponse;
5921
+ };
5922
+ export type ListAgentsResponse = ListAgentsResponses[keyof ListAgentsResponses];
5888
5923
  export type AutoSelectAgentData = {
5889
5924
  body: AgentRequest;
5890
5925
  path: {
@@ -5893,7 +5928,13 @@ export type AutoSelectAgentData = {
5893
5928
  */
5894
5929
  graph_id: string;
5895
5930
  };
5896
- query?: never;
5931
+ query?: {
5932
+ /**
5933
+ * Mode
5934
+ * Override execution mode: sync, async, stream, or auto
5935
+ */
5936
+ mode?: ResponseMode | null;
5937
+ };
5897
5938
  url: '/v1/graphs/{graph_id}/agent';
5898
5939
  };
5899
5940
  export type AutoSelectAgentErrors = {
@@ -5924,8 +5965,46 @@ export type AutoSelectAgentResponses = {
5924
5965
  * Query successfully processed by selected agent
5925
5966
  */
5926
5967
  200: AgentResponse;
5968
+ /**
5969
+ * Query queued for async processing with operation tracking
5970
+ */
5971
+ 202: unknown;
5927
5972
  };
5928
5973
  export type AutoSelectAgentResponse = AutoSelectAgentResponses[keyof AutoSelectAgentResponses];
5974
+ export type GetAgentMetadataData = {
5975
+ body?: never;
5976
+ path: {
5977
+ /**
5978
+ * Graph Id
5979
+ */
5980
+ graph_id: string;
5981
+ /**
5982
+ * Agent Type
5983
+ * Agent type identifier (e.g., 'financial', 'research', 'rag')
5984
+ */
5985
+ agent_type: string;
5986
+ };
5987
+ query?: never;
5988
+ url: '/v1/graphs/{graph_id}/agent/{agent_type}';
5989
+ };
5990
+ export type GetAgentMetadataErrors = {
5991
+ /**
5992
+ * Agent type not found
5993
+ */
5994
+ 404: unknown;
5995
+ /**
5996
+ * Validation Error
5997
+ */
5998
+ 422: HttpValidationError;
5999
+ };
6000
+ export type GetAgentMetadataError = GetAgentMetadataErrors[keyof GetAgentMetadataErrors];
6001
+ export type GetAgentMetadataResponses = {
6002
+ /**
6003
+ * Agent metadata retrieved successfully
6004
+ */
6005
+ 200: AgentMetadataResponse;
6006
+ };
6007
+ export type GetAgentMetadataResponse = GetAgentMetadataResponses[keyof GetAgentMetadataResponses];
5929
6008
  export type ExecuteSpecificAgentData = {
5930
6009
  body: AgentRequest;
5931
6010
  path: {
@@ -5938,7 +6017,13 @@ export type ExecuteSpecificAgentData = {
5938
6017
  */
5939
6018
  graph_id: string;
5940
6019
  };
5941
- query?: never;
6020
+ query?: {
6021
+ /**
6022
+ * Mode
6023
+ * Override execution mode: sync, async, stream, or auto
6024
+ */
6025
+ mode?: ResponseMode | null;
6026
+ };
5942
6027
  url: '/v1/graphs/{graph_id}/agent/{agent_type}';
5943
6028
  };
5944
6029
  export type ExecuteSpecificAgentErrors = {
@@ -5973,6 +6058,10 @@ export type ExecuteSpecificAgentResponses = {
5973
6058
  * Query successfully processed by specified agent
5974
6059
  */
5975
6060
  200: AgentResponse;
6061
+ /**
6062
+ * Query queued for async processing with operation tracking
6063
+ */
6064
+ 202: unknown;
5976
6065
  };
5977
6066
  export type ExecuteSpecificAgentResponse = ExecuteSpecificAgentResponses[keyof ExecuteSpecificAgentResponses];
5978
6067
  export type BatchProcessQueriesData = {
@@ -6012,75 +6101,6 @@ export type BatchProcessQueriesResponses = {
6012
6101
  200: BatchAgentResponse;
6013
6102
  };
6014
6103
  export type BatchProcessQueriesResponse = BatchProcessQueriesResponses[keyof BatchProcessQueriesResponses];
6015
- export type ListAgentsData = {
6016
- body?: never;
6017
- path: {
6018
- /**
6019
- * Graph Id
6020
- */
6021
- graph_id: string;
6022
- };
6023
- query?: {
6024
- /**
6025
- * Capability
6026
- * Filter by capability (e.g., 'financial_analysis', 'rag_search')
6027
- */
6028
- capability?: string | null;
6029
- };
6030
- url: '/v1/graphs/{graph_id}/agent/list';
6031
- };
6032
- export type ListAgentsErrors = {
6033
- /**
6034
- * Unauthorized - Invalid or missing authentication
6035
- */
6036
- 401: unknown;
6037
- /**
6038
- * Validation Error
6039
- */
6040
- 422: HttpValidationError;
6041
- };
6042
- export type ListAgentsError = ListAgentsErrors[keyof ListAgentsErrors];
6043
- export type ListAgentsResponses = {
6044
- /**
6045
- * List of agents retrieved successfully
6046
- */
6047
- 200: AgentListResponse;
6048
- };
6049
- export type ListAgentsResponse = ListAgentsResponses[keyof ListAgentsResponses];
6050
- export type GetAgentMetadataData = {
6051
- body?: never;
6052
- path: {
6053
- /**
6054
- * Graph Id
6055
- */
6056
- graph_id: string;
6057
- /**
6058
- * Agent Type
6059
- * Agent type identifier (e.g., 'financial', 'research', 'rag')
6060
- */
6061
- agent_type: string;
6062
- };
6063
- query?: never;
6064
- url: '/v1/graphs/{graph_id}/agent/{agent_type}/metadata';
6065
- };
6066
- export type GetAgentMetadataErrors = {
6067
- /**
6068
- * Agent type not found
6069
- */
6070
- 404: unknown;
6071
- /**
6072
- * Validation Error
6073
- */
6074
- 422: HttpValidationError;
6075
- };
6076
- export type GetAgentMetadataError = GetAgentMetadataErrors[keyof GetAgentMetadataErrors];
6077
- export type GetAgentMetadataResponses = {
6078
- /**
6079
- * Agent metadata retrieved successfully
6080
- */
6081
- 200: AgentMetadataResponse;
6082
- };
6083
- export type GetAgentMetadataResponse = GetAgentMetadataResponses[keyof GetAgentMetadataResponses];
6084
6104
  export type RecommendAgentData = {
6085
6105
  body: AgentRecommendationRequest;
6086
6106
  path: {
@@ -6747,6 +6767,7 @@ export type ListCreditTransactionsData = {
6747
6767
  path: {
6748
6768
  /**
6749
6769
  * Graph Id
6770
+ * Graph database identifier
6750
6771
  */
6751
6772
  graph_id: string;
6752
6773
  };
package/types.gen.ts CHANGED
@@ -914,7 +914,7 @@ export type CheckoutStatusResponse = {
914
914
  subscription_id: string;
915
915
  /**
916
916
  * Resource Id
917
- * Resource ID (graph_id or repository name) once provisioned
917
+ * Resource ID (graph_id for both graphs and repositories) once provisioned. For repositories, this is the repository slug (e.g., 'sec')
918
918
  */
919
919
  resource_id?: string | null;
920
920
  /**
@@ -1154,7 +1154,7 @@ export type CreateCheckoutRequest = {
1154
1154
  resource_type: string;
1155
1155
  /**
1156
1156
  * Resource Config
1157
- * Configuration for the resource to be provisioned
1157
+ * Configuration for the resource to be provisioned. For repositories: {'repository_name': 'graph_id'} where graph_id is the repository slug (e.g., 'sec')
1158
1158
  */
1159
1159
  resource_config: {
1160
1160
  [key: string]: unknown;
@@ -6255,6 +6255,46 @@ export type SyncConnectionResponses = {
6255
6255
 
6256
6256
  export type SyncConnectionResponse = SyncConnectionResponses[keyof SyncConnectionResponses];
6257
6257
 
6258
+ export type ListAgentsData = {
6259
+ body?: never;
6260
+ path: {
6261
+ /**
6262
+ * Graph Id
6263
+ */
6264
+ graph_id: string;
6265
+ };
6266
+ query?: {
6267
+ /**
6268
+ * Capability
6269
+ * Filter by capability (e.g., 'financial_analysis', 'rag_search')
6270
+ */
6271
+ capability?: string | null;
6272
+ };
6273
+ url: '/v1/graphs/{graph_id}/agent';
6274
+ };
6275
+
6276
+ export type ListAgentsErrors = {
6277
+ /**
6278
+ * Unauthorized - Invalid or missing authentication
6279
+ */
6280
+ 401: unknown;
6281
+ /**
6282
+ * Validation Error
6283
+ */
6284
+ 422: HttpValidationError;
6285
+ };
6286
+
6287
+ export type ListAgentsError = ListAgentsErrors[keyof ListAgentsErrors];
6288
+
6289
+ export type ListAgentsResponses = {
6290
+ /**
6291
+ * List of agents retrieved successfully
6292
+ */
6293
+ 200: AgentListResponse;
6294
+ };
6295
+
6296
+ export type ListAgentsResponse = ListAgentsResponses[keyof ListAgentsResponses];
6297
+
6258
6298
  export type AutoSelectAgentData = {
6259
6299
  body: AgentRequest;
6260
6300
  path: {
@@ -6263,7 +6303,13 @@ export type AutoSelectAgentData = {
6263
6303
  */
6264
6304
  graph_id: string;
6265
6305
  };
6266
- query?: never;
6306
+ query?: {
6307
+ /**
6308
+ * Mode
6309
+ * Override execution mode: sync, async, stream, or auto
6310
+ */
6311
+ mode?: ResponseMode | null;
6312
+ };
6267
6313
  url: '/v1/graphs/{graph_id}/agent';
6268
6314
  };
6269
6315
 
@@ -6297,10 +6343,53 @@ export type AutoSelectAgentResponses = {
6297
6343
  * Query successfully processed by selected agent
6298
6344
  */
6299
6345
  200: AgentResponse;
6346
+ /**
6347
+ * Query queued for async processing with operation tracking
6348
+ */
6349
+ 202: unknown;
6300
6350
  };
6301
6351
 
6302
6352
  export type AutoSelectAgentResponse = AutoSelectAgentResponses[keyof AutoSelectAgentResponses];
6303
6353
 
6354
+ export type GetAgentMetadataData = {
6355
+ body?: never;
6356
+ path: {
6357
+ /**
6358
+ * Graph Id
6359
+ */
6360
+ graph_id: string;
6361
+ /**
6362
+ * Agent Type
6363
+ * Agent type identifier (e.g., 'financial', 'research', 'rag')
6364
+ */
6365
+ agent_type: string;
6366
+ };
6367
+ query?: never;
6368
+ url: '/v1/graphs/{graph_id}/agent/{agent_type}';
6369
+ };
6370
+
6371
+ export type GetAgentMetadataErrors = {
6372
+ /**
6373
+ * Agent type not found
6374
+ */
6375
+ 404: unknown;
6376
+ /**
6377
+ * Validation Error
6378
+ */
6379
+ 422: HttpValidationError;
6380
+ };
6381
+
6382
+ export type GetAgentMetadataError = GetAgentMetadataErrors[keyof GetAgentMetadataErrors];
6383
+
6384
+ export type GetAgentMetadataResponses = {
6385
+ /**
6386
+ * Agent metadata retrieved successfully
6387
+ */
6388
+ 200: AgentMetadataResponse;
6389
+ };
6390
+
6391
+ export type GetAgentMetadataResponse = GetAgentMetadataResponses[keyof GetAgentMetadataResponses];
6392
+
6304
6393
  export type ExecuteSpecificAgentData = {
6305
6394
  body: AgentRequest;
6306
6395
  path: {
@@ -6313,7 +6402,13 @@ export type ExecuteSpecificAgentData = {
6313
6402
  */
6314
6403
  graph_id: string;
6315
6404
  };
6316
- query?: never;
6405
+ query?: {
6406
+ /**
6407
+ * Mode
6408
+ * Override execution mode: sync, async, stream, or auto
6409
+ */
6410
+ mode?: ResponseMode | null;
6411
+ };
6317
6412
  url: '/v1/graphs/{graph_id}/agent/{agent_type}';
6318
6413
  };
6319
6414
 
@@ -6351,6 +6446,10 @@ export type ExecuteSpecificAgentResponses = {
6351
6446
  * Query successfully processed by specified agent
6352
6447
  */
6353
6448
  200: AgentResponse;
6449
+ /**
6450
+ * Query queued for async processing with operation tracking
6451
+ */
6452
+ 202: unknown;
6354
6453
  };
6355
6454
 
6356
6455
  export type ExecuteSpecificAgentResponse = ExecuteSpecificAgentResponses[keyof ExecuteSpecificAgentResponses];
@@ -6397,85 +6496,6 @@ export type BatchProcessQueriesResponses = {
6397
6496
 
6398
6497
  export type BatchProcessQueriesResponse = BatchProcessQueriesResponses[keyof BatchProcessQueriesResponses];
6399
6498
 
6400
- export type ListAgentsData = {
6401
- body?: never;
6402
- path: {
6403
- /**
6404
- * Graph Id
6405
- */
6406
- graph_id: string;
6407
- };
6408
- query?: {
6409
- /**
6410
- * Capability
6411
- * Filter by capability (e.g., 'financial_analysis', 'rag_search')
6412
- */
6413
- capability?: string | null;
6414
- };
6415
- url: '/v1/graphs/{graph_id}/agent/list';
6416
- };
6417
-
6418
- export type ListAgentsErrors = {
6419
- /**
6420
- * Unauthorized - Invalid or missing authentication
6421
- */
6422
- 401: unknown;
6423
- /**
6424
- * Validation Error
6425
- */
6426
- 422: HttpValidationError;
6427
- };
6428
-
6429
- export type ListAgentsError = ListAgentsErrors[keyof ListAgentsErrors];
6430
-
6431
- export type ListAgentsResponses = {
6432
- /**
6433
- * List of agents retrieved successfully
6434
- */
6435
- 200: AgentListResponse;
6436
- };
6437
-
6438
- export type ListAgentsResponse = ListAgentsResponses[keyof ListAgentsResponses];
6439
-
6440
- export type GetAgentMetadataData = {
6441
- body?: never;
6442
- path: {
6443
- /**
6444
- * Graph Id
6445
- */
6446
- graph_id: string;
6447
- /**
6448
- * Agent Type
6449
- * Agent type identifier (e.g., 'financial', 'research', 'rag')
6450
- */
6451
- agent_type: string;
6452
- };
6453
- query?: never;
6454
- url: '/v1/graphs/{graph_id}/agent/{agent_type}/metadata';
6455
- };
6456
-
6457
- export type GetAgentMetadataErrors = {
6458
- /**
6459
- * Agent type not found
6460
- */
6461
- 404: unknown;
6462
- /**
6463
- * Validation Error
6464
- */
6465
- 422: HttpValidationError;
6466
- };
6467
-
6468
- export type GetAgentMetadataError = GetAgentMetadataErrors[keyof GetAgentMetadataErrors];
6469
-
6470
- export type GetAgentMetadataResponses = {
6471
- /**
6472
- * Agent metadata retrieved successfully
6473
- */
6474
- 200: AgentMetadataResponse;
6475
- };
6476
-
6477
- export type GetAgentMetadataResponse = GetAgentMetadataResponses[keyof GetAgentMetadataResponses];
6478
-
6479
6499
  export type RecommendAgentData = {
6480
6500
  body: AgentRecommendationRequest;
6481
6501
  path: {
@@ -7214,6 +7234,7 @@ export type ListCreditTransactionsData = {
7214
7234
  path: {
7215
7235
  /**
7216
7236
  * Graph Id
7237
+ * Graph database identifier
7217
7238
  */
7218
7239
  graph_id: string;
7219
7240
  };