@vibexp/api-client 0.7.0 → 0.9.0

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.
@@ -667,6 +667,10 @@ export type EmbeddingProvider = {
667
667
  * Overlap between adjacent chunks.
668
668
  */
669
669
  chunk_overlap: number;
670
+ /**
671
+ * Maximum number of simultaneous embedding requests VibeXP issues to this provider. Keep at 1 for single-threaded providers.
672
+ */
673
+ concurrency: number;
670
674
  is_default: boolean;
671
675
  base_url?: string | null;
672
676
  configuration: string;
@@ -695,6 +699,10 @@ export type CreateEmbeddingProviderRequest = {
695
699
  * Optional chunk overlap; defaults to 200 when omitted.
696
700
  */
697
701
  chunk_overlap?: number;
702
+ /**
703
+ * Optional max simultaneous embedding requests to this provider; defaults to 1 when omitted.
704
+ */
705
+ concurrency?: number;
698
706
  is_default?: boolean;
699
707
  base_url?: string;
700
708
  api_key?: string | null;
@@ -708,6 +716,7 @@ export type UpdateEmbeddingProviderRequest = {
708
716
  model?: string;
709
717
  chunk_size?: number;
710
718
  chunk_overlap?: number;
719
+ concurrency?: number;
711
720
  is_default?: boolean;
712
721
  base_url?: string;
713
722
  api_key?: string;
@@ -747,6 +756,48 @@ export type ValidateEmbeddingProviderResponse = {
747
756
  error_details?: string;
748
757
  };
749
758
  };
759
+ /**
760
+ * Embedding coverage for a single entity type: how many entities exist, how many have an embedding under the team's active model, how many are still pending, and the embedded percentage.
761
+ */
762
+ export type EmbeddingCoverageItem = {
763
+ /**
764
+ * The embeddable entity type this row reports on.
765
+ */
766
+ entity_type: 'prompt' | 'artifact' | 'memory' | 'blueprint' | 'feed_item';
767
+ /**
768
+ * Total embeddable entities of this type owned by the team.
769
+ */
770
+ total: number;
771
+ /**
772
+ * Entities of this type that already have an embedding under the team's active model.
773
+ */
774
+ embedded: number;
775
+ /**
776
+ * Entities still missing an embedding (total − embedded).
777
+ */
778
+ pending: number;
779
+ /**
780
+ * Rounded percentage of entities embedded (embedded / total * 100); 0 when there are no entities of this type.
781
+ */
782
+ embedded_percent: number;
783
+ };
784
+ /**
785
+ * Derived, team-scoped embedding coverage per entity type under the team's active provider model. Counts are computed from existing rows (no per-entity state); a non-decreasing pending count is the signal that embedding is stuck. When the team has no active provider, has_active_provider is false, active_model is null, and every type reports all entities as pending (0%).
786
+ */
787
+ export type EmbeddingCoverageResponse = {
788
+ /**
789
+ * Whether the team has an active embedding provider configured.
790
+ */
791
+ has_active_provider: boolean;
792
+ /**
793
+ * The active provider's embedding model the embedded counts are measured against, or null when no provider is configured.
794
+ */
795
+ active_model: string | null;
796
+ /**
797
+ * One entry per embeddable entity type, in a stable order.
798
+ */
799
+ coverage: Array<EmbeddingCoverageItem>;
800
+ };
750
801
  export type ResourceUsageItem = {
751
802
  /**
752
803
  * Type of resource (e.g., prompt, memory, artifact)
@@ -1038,9 +1089,9 @@ export type Artifact = {
1038
1089
  */
1039
1090
  description?: string;
1040
1091
  /**
1041
- * Type category of the artifact
1092
+ * Type category of the artifact. An open string validated at runtime against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum.
1042
1093
  */
1043
- type: 'work_reports' | 'static_contexts' | 'general';
1094
+ type: string;
1044
1095
  /**
1045
1096
  * Additional metadata as key-value pairs
1046
1097
  */
@@ -1070,9 +1121,9 @@ export type CreateArtifactRequest = {
1070
1121
  */
1071
1122
  description?: string;
1072
1123
  /**
1073
- * Type category of the artifact
1124
+ * Type category of the artifact. An open string validated at runtime against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum. Defaults to general when omitted.
1074
1125
  */
1075
- type?: 'work_reports' | 'static_contexts' | 'general';
1126
+ type?: string;
1076
1127
  /**
1077
1128
  * Initial status of the artifact
1078
1129
  */
@@ -1106,9 +1157,9 @@ export type UpdateArtifactRequest = {
1106
1157
  */
1107
1158
  description?: string;
1108
1159
  /**
1109
- * Updated type category of the artifact
1160
+ * Updated type category of the artifact. An open string validated at runtime against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum.
1110
1161
  */
1111
- type?: 'work_reports' | 'static_contexts' | 'general';
1162
+ type?: string;
1112
1163
  /**
1113
1164
  * Updated status of the artifact
1114
1165
  */
@@ -1627,6 +1678,10 @@ export type Memory = {
1627
1678
  version: number;
1628
1679
  };
1629
1680
  export type CreateMemoryRequest = {
1681
+ /**
1682
+ * UUID of the project this memory belongs to
1683
+ */
1684
+ project_id: string;
1630
1685
  /**
1631
1686
  * The text content of the memory
1632
1687
  */
@@ -1643,6 +1698,10 @@ export type CreateMemoryRequest = {
1643
1698
  };
1644
1699
  };
1645
1700
  export type UpdateMemoryRequest = {
1701
+ /**
1702
+ * New project UUID for the memory (moves it between projects)
1703
+ */
1704
+ project_id?: string;
1646
1705
  /**
1647
1706
  * Updated text content of the memory
1648
1707
  */
@@ -1971,35 +2030,21 @@ export type GitHubInstallationStatus = {
1971
2030
  */
1972
2031
  installed: boolean;
1973
2032
  /**
1974
- * GitHub installation ID (present when installed is true)
1975
- */
1976
- installation_id?: number;
1977
- /**
1978
- * GitHub account or organization login that installed the app
2033
+ * GitHub account or organization login that installed the app (present when installed is true)
1979
2034
  */
1980
2035
  account_login?: string;
1981
2036
  /**
1982
- * Type of GitHub account (User or Organization)
1983
- */
1984
- account_type?: 'User' | 'Organization';
1985
- /**
1986
- * Target type of the installation
1987
- */
1988
- target_type?: string;
1989
- /**
1990
- * Permissions granted by the installation
2037
+ * GitHub installation ID (present when installed is true)
1991
2038
  */
1992
- permissions?: {
1993
- [key: string]: string;
1994
- };
2039
+ installation_id?: number;
1995
2040
  /**
1996
- * Events the installation is subscribed to
2041
+ * Whether the installation is currently suspended
1997
2042
  */
1998
- events?: Array<string>;
2043
+ suspended?: boolean;
1999
2044
  /**
2000
- * When the installation was suspended (null if not suspended)
2045
+ * When the GitHub App was installed (present when installed is true)
2001
2046
  */
2002
- suspended_at?: string | null;
2047
+ installed_at?: string;
2003
2048
  };
2004
2049
  /**
2005
2050
  * A GitHub repository accessible by the installation
@@ -2164,7 +2209,7 @@ export type BlueprintImportReport = {
2164
2209
  /**
2165
2210
  * Details of files successfully imported
2166
2211
  */
2167
- success_items: Array<BlueprintImportSuccess>;
2212
+ successful_items: Array<BlueprintImportSuccess>;
2168
2213
  /**
2169
2214
  * Details of files that were skipped
2170
2215
  */
@@ -2272,55 +2317,6 @@ export type UserActivityRow = {
2272
2317
  */
2273
2318
  total_agent_executions_run?: number;
2274
2319
  };
2275
- /**
2276
- * Configuration for an embedding backfill run. The scope is explicit: set exactly one of `all` or a non-empty `entity_types`. Sending neither, or both, is rejected with a 400.
2277
- */
2278
- export type EmbeddingBackfillRequest = {
2279
- /**
2280
- * Backfill every supported entity type. Mutually exclusive with `entity_types`.
2281
- */
2282
- all?: boolean;
2283
- /**
2284
- * Restrict the run to these entity types. Mutually exclusive with `all`.
2285
- */
2286
- entity_types?: Array<'prompt' | 'artifact' | 'memory' | 'blueprint' | 'feed_item'>;
2287
- /**
2288
- * When true, only publish for entities that do not already have an embedding for the currently configured model. Honored by `dry_run`.
2289
- */
2290
- missing_only?: boolean;
2291
- /**
2292
- * When true, count the entities that would be republished without publishing any event.
2293
- */
2294
- dry_run?: boolean;
2295
- };
2296
- /**
2297
- * Per-entity-type outcome of a backfill run.
2298
- */
2299
- export type EmbeddingBackfillTypeResult = {
2300
- entity_type: string;
2301
- /**
2302
- * Number of source entities seen for this type.
2303
- */
2304
- total: number;
2305
- /**
2306
- * Number of `.created` events successfully republished (0 on a dry run).
2307
- */
2308
- published: number;
2309
- /**
2310
- * Number of entities whose event publish failed (log-and-continue).
2311
- */
2312
- failed: number;
2313
- };
2314
- /**
2315
- * Aggregated result of an embedding backfill run.
2316
- */
2317
- export type EmbeddingBackfillResult = {
2318
- dry_run: boolean;
2319
- results: Array<EmbeddingBackfillTypeResult>;
2320
- total_seen: number;
2321
- total_published: number;
2322
- total_failed: number;
2323
- };
2324
2320
  /**
2325
2321
  * Usage and growth data response
2326
2322
  */
@@ -4044,9 +4040,9 @@ export type ListArtifactsData = {
4044
4040
  */
4045
4041
  status?: 'active' | 'draft' | 'archived';
4046
4042
  /**
4047
- * Filter by type
4043
+ * Filter by type. An open string matched against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum.
4048
4044
  */
4049
- type?: 'work_reports' | 'static_contexts' | 'general';
4045
+ type?: string;
4050
4046
  /**
4051
4047
  * Search in title, description, and content
4052
4048
  */
@@ -4172,9 +4168,9 @@ export type ListArtifactsByProjectData = {
4172
4168
  */
4173
4169
  status?: 'active' | 'draft' | 'archived';
4174
4170
  /**
4175
- * Filter by type
4171
+ * Filter by type. An open string matched against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum.
4176
4172
  */
4177
- type?: 'work_reports' | 'static_contexts' | 'general';
4173
+ type?: string;
4178
4174
  /**
4179
4175
  * Search in title, description, and content
4180
4176
  */
@@ -4937,6 +4933,10 @@ export type ListMemoriesData = {
4937
4933
  team_id: string;
4938
4934
  };
4939
4935
  query?: {
4936
+ /**
4937
+ * Filter memories by project ID
4938
+ */
4939
+ project_id?: string;
4940
4940
  /**
4941
4941
  * Search in memory text
4942
4942
  */
@@ -5024,6 +5024,10 @@ export type SearchMemoriesByMetadataData = {
5024
5024
  team_id: string;
5025
5025
  };
5026
5026
  query: {
5027
+ /**
5028
+ * Filter memories by project ID
5029
+ */
5030
+ project_id?: string;
5027
5031
  /**
5028
5032
  * Metadata key to search for
5029
5033
  */
@@ -6751,34 +6755,6 @@ export type GetUsageAndGrowthResponses = {
6751
6755
  200: UsageAndGrowthResponse;
6752
6756
  };
6753
6757
  export type GetUsageAndGrowthResponse = GetUsageAndGrowthResponses[keyof GetUsageAndGrowthResponses];
6754
- export type BackfillEmbeddingsData = {
6755
- body: EmbeddingBackfillRequest;
6756
- path?: never;
6757
- query?: never;
6758
- url: '/bo/v1/embeddings/backfill';
6759
- };
6760
- export type BackfillEmbeddingsErrors = {
6761
- /**
6762
- * Invalid request body, no scope (`all` and `entity_types` both empty), an ambiguous scope (both `all` and `entity_types` set), or an unsupported entity type was requested.
6763
- */
6764
- 400: ErrorResponse;
6765
- /**
6766
- * Unauthorized - Missing or invalid back office admin API key
6767
- */
6768
- 401: ErrorResponse;
6769
- /**
6770
- * Internal server error
6771
- */
6772
- 500: ErrorResponse;
6773
- };
6774
- export type BackfillEmbeddingsError = BackfillEmbeddingsErrors[keyof BackfillEmbeddingsErrors];
6775
- export type BackfillEmbeddingsResponses = {
6776
- /**
6777
- * Backfill completed; per-entity-type and aggregate counts returned.
6778
- */
6779
- 200: EmbeddingBackfillResult;
6780
- };
6781
- export type BackfillEmbeddingsResponse = BackfillEmbeddingsResponses[keyof BackfillEmbeddingsResponses];
6782
6758
  export type GetGitHubStatusData = {
6783
6759
  body?: never;
6784
6760
  path: {
@@ -6851,6 +6827,10 @@ export type HandleGitHubCallbackData = {
6851
6827
  * GitHub App installation ID from the callback URL
6852
6828
  */
6853
6829
  installation_id: number;
6830
+ /**
6831
+ * Setup action reported by GitHub on the callback URL (e.g. "install"). Accepted for forward compatibility but currently ignored server-side.
6832
+ */
6833
+ setup_action?: string;
6854
6834
  /**
6855
6835
  * HMAC-signed state parameter from the install URL (CSRF protection)
6856
6836
  */
@@ -6980,16 +6960,16 @@ export type ImportGitHubProjectResponses = {
6980
6960
  * Project already exists — returned without creating a new one
6981
6961
  */
6982
6962
  200: {
6983
- project?: Project;
6984
- created?: boolean;
6963
+ project: Project;
6964
+ created: boolean;
6985
6965
  message?: string;
6986
6966
  };
6987
6967
  /**
6988
6968
  * Project created successfully from the GitHub repository
6989
6969
  */
6990
6970
  201: {
6991
- project?: Project;
6992
- created?: boolean;
6971
+ project: Project;
6972
+ created: boolean;
6993
6973
  };
6994
6974
  };
6995
6975
  export type ImportGitHubProjectResponse = ImportGitHubProjectResponses[keyof ImportGitHubProjectResponses];
@@ -10043,6 +10023,35 @@ export type CreateEmbeddingProviderResponses = {
10043
10023
  200: EmbeddingProviderResponse;
10044
10024
  };
10045
10025
  export type CreateEmbeddingProviderResponse = CreateEmbeddingProviderResponses[keyof CreateEmbeddingProviderResponses];
10026
+ export type GetEmbeddingCoverageData = {
10027
+ body?: never;
10028
+ path: {
10029
+ /**
10030
+ * Team whose embedding coverage is reported.
10031
+ */
10032
+ team_id: string;
10033
+ };
10034
+ query?: never;
10035
+ url: '/api/v1/{team_id}/embedding-providers/coverage';
10036
+ };
10037
+ export type GetEmbeddingCoverageErrors = {
10038
+ /**
10039
+ * Unauthorized
10040
+ */
10041
+ 401: ErrorResponse;
10042
+ /**
10043
+ * Failed to retrieve embedding coverage (`DATABASE_ERROR`)
10044
+ */
10045
+ 500: ErrorResponse;
10046
+ };
10047
+ export type GetEmbeddingCoverageError = GetEmbeddingCoverageErrors[keyof GetEmbeddingCoverageErrors];
10048
+ export type GetEmbeddingCoverageResponses = {
10049
+ /**
10050
+ * Embedding coverage retrieved successfully
10051
+ */
10052
+ 200: EmbeddingCoverageResponse;
10053
+ };
10054
+ export type GetEmbeddingCoverageResponse = GetEmbeddingCoverageResponses[keyof GetEmbeddingCoverageResponses];
10046
10055
  export type DeleteEmbeddingProviderData = {
10047
10056
  body?: never;
10048
10057
  path: {
@@ -10162,6 +10171,43 @@ export type UpdateEmbeddingProviderResponses = {
10162
10171
  200: EmbeddingProviderResponse;
10163
10172
  };
10164
10173
  export type UpdateEmbeddingProviderResponse = UpdateEmbeddingProviderResponses[keyof UpdateEmbeddingProviderResponses];
10174
+ export type ReprocessEmbeddingProviderData = {
10175
+ body?: never;
10176
+ path: {
10177
+ /**
10178
+ * Team that owns the embedding provider(s).
10179
+ */
10180
+ team_id: string;
10181
+ /**
10182
+ * Embedding provider ID
10183
+ */
10184
+ id: string;
10185
+ };
10186
+ query?: never;
10187
+ url: '/api/v1/{team_id}/embedding-providers/{id}/reprocess';
10188
+ };
10189
+ export type ReprocessEmbeddingProviderErrors = {
10190
+ /**
10191
+ * Unauthorized
10192
+ */
10193
+ 401: ErrorResponse;
10194
+ /**
10195
+ * Embedding provider not found (`PROVIDER_NOT_FOUND`)
10196
+ */
10197
+ 404: ErrorResponse;
10198
+ /**
10199
+ * Failed to load the provider before reprocess (`DATABASE_ERROR`)
10200
+ */
10201
+ 500: ErrorResponse;
10202
+ };
10203
+ export type ReprocessEmbeddingProviderError = ReprocessEmbeddingProviderErrors[keyof ReprocessEmbeddingProviderErrors];
10204
+ export type ReprocessEmbeddingProviderResponses = {
10205
+ /**
10206
+ * Reprocess accepted; embeddings are regenerated in the background.
10207
+ */
10208
+ 202: SuccessResponse;
10209
+ };
10210
+ export type ReprocessEmbeddingProviderResponse = ReprocessEmbeddingProviderResponses[keyof ReprocessEmbeddingProviderResponses];
10165
10211
  export type ValidateEmbeddingProviderData = {
10166
10212
  body: ValidateEmbeddingProviderRequest;
10167
10213
  path: {
@@ -10261,6 +10307,35 @@ export type CreateEmbeddingProviderSettingsResponses = {
10261
10307
  200: EmbeddingProviderResponse;
10262
10308
  };
10263
10309
  export type CreateEmbeddingProviderSettingsResponse = CreateEmbeddingProviderSettingsResponses[keyof CreateEmbeddingProviderSettingsResponses];
10310
+ export type GetEmbeddingCoverageSettingsData = {
10311
+ body?: never;
10312
+ path: {
10313
+ /**
10314
+ * Team whose embedding coverage is reported.
10315
+ */
10316
+ team_id: string;
10317
+ };
10318
+ query?: never;
10319
+ url: '/api/v1/{team_id}/settings/embedding-providers/coverage';
10320
+ };
10321
+ export type GetEmbeddingCoverageSettingsErrors = {
10322
+ /**
10323
+ * Unauthorized
10324
+ */
10325
+ 401: ErrorResponse;
10326
+ /**
10327
+ * Failed to retrieve embedding coverage (`DATABASE_ERROR`)
10328
+ */
10329
+ 500: ErrorResponse;
10330
+ };
10331
+ export type GetEmbeddingCoverageSettingsError = GetEmbeddingCoverageSettingsErrors[keyof GetEmbeddingCoverageSettingsErrors];
10332
+ export type GetEmbeddingCoverageSettingsResponses = {
10333
+ /**
10334
+ * Embedding coverage retrieved successfully
10335
+ */
10336
+ 200: EmbeddingCoverageResponse;
10337
+ };
10338
+ export type GetEmbeddingCoverageSettingsResponse = GetEmbeddingCoverageSettingsResponses[keyof GetEmbeddingCoverageSettingsResponses];
10264
10339
  export type DeleteEmbeddingProviderSettingsData = {
10265
10340
  body?: never;
10266
10341
  path: {
@@ -10380,6 +10455,43 @@ export type UpdateEmbeddingProviderSettingsResponses = {
10380
10455
  200: EmbeddingProviderResponse;
10381
10456
  };
10382
10457
  export type UpdateEmbeddingProviderSettingsResponse = UpdateEmbeddingProviderSettingsResponses[keyof UpdateEmbeddingProviderSettingsResponses];
10458
+ export type ReprocessEmbeddingProviderSettingsData = {
10459
+ body?: never;
10460
+ path: {
10461
+ /**
10462
+ * Team that owns the embedding provider(s).
10463
+ */
10464
+ team_id: string;
10465
+ /**
10466
+ * Embedding provider ID
10467
+ */
10468
+ id: string;
10469
+ };
10470
+ query?: never;
10471
+ url: '/api/v1/{team_id}/settings/embedding-providers/{id}/reprocess';
10472
+ };
10473
+ export type ReprocessEmbeddingProviderSettingsErrors = {
10474
+ /**
10475
+ * Unauthorized
10476
+ */
10477
+ 401: ErrorResponse;
10478
+ /**
10479
+ * Embedding provider not found (`PROVIDER_NOT_FOUND`)
10480
+ */
10481
+ 404: ErrorResponse;
10482
+ /**
10483
+ * Failed to load the provider before reprocess (`DATABASE_ERROR`)
10484
+ */
10485
+ 500: ErrorResponse;
10486
+ };
10487
+ export type ReprocessEmbeddingProviderSettingsError = ReprocessEmbeddingProviderSettingsErrors[keyof ReprocessEmbeddingProviderSettingsErrors];
10488
+ export type ReprocessEmbeddingProviderSettingsResponses = {
10489
+ /**
10490
+ * Reprocess accepted; embeddings are regenerated in the background.
10491
+ */
10492
+ 202: SuccessResponse;
10493
+ };
10494
+ export type ReprocessEmbeddingProviderSettingsResponse = ReprocessEmbeddingProviderSettingsResponses[keyof ReprocessEmbeddingProviderSettingsResponses];
10383
10495
  export type ValidateEmbeddingProviderSettingsData = {
10384
10496
  body: ValidateEmbeddingProviderRequest;
10385
10497
  path: {