@aventurevc/api-schemas 0.8.174 → 0.8.176

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.
Files changed (120) hide show
  1. package/dist/agent/help-question.d.ts +1 -1
  2. package/dist/agent/help-question.js +4 -4
  3. package/dist/agent/help.d.ts +1 -1
  4. package/dist/agent/help.js +1 -1
  5. package/dist/classification/catalog-bucket.js +2 -2
  6. package/dist/classification/catalog.d.ts +1 -1
  7. package/dist/classification/catalog.js +1 -1
  8. package/dist/classification/inactive-tag-details.d.ts +7 -0
  9. package/dist/classification/inactive-tag-details.js +4 -1
  10. package/dist/domain/conflict-details.d.ts +11 -1
  11. package/dist/domain/conflict-details.js +1 -1
  12. package/dist/domain/conflict-type.d.ts +24 -0
  13. package/dist/domain/conflict-type.js +27 -0
  14. package/dist/duplicate/create-review.d.ts +7 -0
  15. package/dist/duplicate/create-review.js +3 -0
  16. package/dist/enrichment/mode.d.ts +2 -2
  17. package/dist/enrichment/mode.js +2 -2
  18. package/dist/entity/alias-type.d.ts +1 -1
  19. package/dist/entity/alias-type.js +1 -1
  20. package/dist/entity/classification-suggestion.d.ts +1 -1
  21. package/dist/entity/classification-suggestion.js +3 -3
  22. package/dist/entity/classification.d.ts +1 -1
  23. package/dist/entity/classification.js +2 -2
  24. package/dist/entity/enrichment.js +1 -1
  25. package/dist/entity/entity.d.ts +2 -2
  26. package/dist/entity/entity.js +2 -2
  27. package/dist/entity/image.d.ts +1 -1
  28. package/dist/entity/image.js +1 -1
  29. package/dist/entity/investments-param.d.ts +0 -1
  30. package/dist/entity/investments-param.js +0 -2
  31. package/dist/entity/investors-param.d.ts +1 -1
  32. package/dist/entity/investors-param.js +2 -2
  33. package/dist/entity/lookup-batch-param.d.ts +0 -1
  34. package/dist/entity/lookup-batch-param.js +0 -2
  35. package/dist/entity/lookup-exact-param.d.ts +0 -1
  36. package/dist/entity/lookup-exact-param.js +0 -2
  37. package/dist/entity/name-alias-entity-alias-type.d.ts +1 -1
  38. package/dist/entity/name-alias-entity-alias-type.js +1 -1
  39. package/dist/entity/people-param.d.ts +0 -1
  40. package/dist/entity/people-param.js +0 -2
  41. package/dist/entity/relationship.js +3 -3
  42. package/dist/entity/research-detail.d.ts +1 -1
  43. package/dist/entity/research-detail.js +1 -1
  44. package/dist/entity/search-param.d.ts +0 -1
  45. package/dist/entity/search-param.js +1 -3
  46. package/dist/entity/sitemap.d.ts +1 -1
  47. package/dist/entity/sitemap.js +1 -1
  48. package/dist/entity/tag.d.ts +1 -1
  49. package/dist/entity/tag.js +8 -8
  50. package/dist/entity/valuation-data-confidence.d.ts +1 -1
  51. package/dist/entity/valuation-data-confidence.js +1 -1
  52. package/dist/federated/natural-search.js +4 -4
  53. package/dist/harness/chassis.d.ts +2 -2
  54. package/dist/harness/chassis.js +2 -2
  55. package/dist/harness/llm-api.d.ts +2 -2
  56. package/dist/harness/llm-api.js +2 -2
  57. package/dist/harness/run-create.d.ts +1 -1
  58. package/dist/harness/run-create.js +1 -1
  59. package/dist/harness/run-detail.d.ts +2 -2
  60. package/dist/harness/run-detail.js +5 -5
  61. package/dist/harness/run-environment.d.ts +2 -5
  62. package/dist/harness/run-environment.js +2 -5
  63. package/dist/harness/run-lane.d.ts +2 -2
  64. package/dist/harness/run-lane.js +2 -2
  65. package/dist/harness/run-progress.d.ts +1 -1
  66. package/dist/harness/run-progress.js +2 -2
  67. package/dist/harness/run-status.d.ts +3 -3
  68. package/dist/harness/run-status.js +3 -3
  69. package/dist/harness/run-type.d.ts +3 -3
  70. package/dist/harness/run-type.js +3 -3
  71. package/dist/harness/run.d.ts +3 -3
  72. package/dist/harness/run.js +10 -10
  73. package/dist/help/resolution.js +1 -1
  74. package/dist/http/problem-detail.d.ts +10 -0
  75. package/dist/http/problem-detail.js +18 -3
  76. package/dist/identification/candidate.js +4 -4
  77. package/dist/identification/identification.d.ts +2 -4
  78. package/dist/identification/identification.js +7 -11
  79. package/dist/identification/subject.js +1 -1
  80. package/dist/lookup/job-mention.d.ts +3 -5
  81. package/dist/lookup/job-mention.js +5 -5
  82. package/dist/lookup/job-mutation.js +2 -2
  83. package/dist/lookup/job.d.ts +4 -10
  84. package/dist/lookup/mention.js +1 -1
  85. package/dist/media/upload.js +1 -1
  86. package/dist/mention/lookup.d.ts +2 -6
  87. package/dist/natural/search-result.js +1 -1
  88. package/dist/natural/search.js +4 -4
  89. package/dist/news/resolved-entity-link.js +1 -0
  90. package/dist/news/source-url-conflict.d.ts +7 -0
  91. package/dist/news/source-url-conflict.js +3 -0
  92. package/dist/openapi-component-manifest.js +4 -9
  93. package/dist/person/lookup-batch-param.d.ts +0 -1
  94. package/dist/person/lookup-batch-param.js +0 -2
  95. package/dist/person/lookup-exact-param.d.ts +0 -1
  96. package/dist/person/lookup-exact-param.js +0 -2
  97. package/dist/person/natural-search-result.js +1 -1
  98. package/dist/person/search-param.d.ts +0 -1
  99. package/dist/person/search-param.js +0 -2
  100. package/dist/research/finding.d.ts +1 -1
  101. package/dist/research/finding.js +1 -1
  102. package/dist/search/search.d.ts +0 -8
  103. package/dist/search/search.js +4 -11
  104. package/dist/standardized/classification.d.ts +1 -1
  105. package/dist/standardized/classification.js +4 -4
  106. package/dist/strict/url-lookup-conflict.d.ts +7 -0
  107. package/dist/strict/url-lookup-conflict.js +3 -0
  108. package/dist/system/status.js +1 -1
  109. package/dist/url/duplicate-conflict.d.ts +7 -0
  110. package/dist/url/duplicate-conflict.js +3 -0
  111. package/dist/url/duplicate-join.d.ts +1 -1
  112. package/dist/url/duplicate-join.js +2 -2
  113. package/dist/web/search.d.ts +0 -6
  114. package/package.json +1 -1
  115. package/dist/datasource/data-source-type.d.ts +0 -24
  116. package/dist/datasource/data-source-type.js +0 -24
  117. package/dist/datasource/provenance-actor-type.d.ts +0 -15
  118. package/dist/datasource/provenance-actor-type.js +0 -12
  119. package/dist/suppression/reason.d.ts +0 -17
  120. package/dist/suppression/reason.js +0 -16
@@ -32,12 +32,12 @@ export interface EntityNameAliasEntityAliasTypeSchemaInput extends z.input<typeo
32
32
  * @endpoint GET /v1/entities/{entityId}/similar
33
33
  * @endpoint GET /v1/entities/{entityId}/similar/summary
34
34
  * @endpoint GET /v1/entities/relationships/{relationshipId}
35
- * @endpoint GET /v1/harness/runs/{runId}
36
35
  * @endpoint GET /v1/lookup-jobs/{jobId}
37
36
  * @endpoint GET /v1/news/{newsId}/related-entities
38
37
  * @endpoint GET /v1/people/{personId}
39
38
  * @endpoint GET /v1/people/{personId}/graph
40
39
  * @endpoint GET /v1/people/{personId}/investments
40
+ * @endpoint GET /v1/research-runs/{runId}
41
41
  * @endpoint GET /v1/search/link/jobs/{jobId}
42
42
  * @endpoint GET /v1/search/shared/{id}
43
43
  * @endpoint GET /v1/search/shared/slug/{slug}
@@ -31,12 +31,12 @@ const EntityNameAliasEntityAliasTypeSchemaDefinition = z.object({
31
31
  * @endpoint GET /v1/entities/{entityId}/similar
32
32
  * @endpoint GET /v1/entities/{entityId}/similar/summary
33
33
  * @endpoint GET /v1/entities/relationships/{relationshipId}
34
- * @endpoint GET /v1/harness/runs/{runId}
35
34
  * @endpoint GET /v1/lookup-jobs/{jobId}
36
35
  * @endpoint GET /v1/news/{newsId}/related-entities
37
36
  * @endpoint GET /v1/people/{personId}
38
37
  * @endpoint GET /v1/people/{personId}/graph
39
38
  * @endpoint GET /v1/people/{personId}/investments
39
+ * @endpoint GET /v1/research-runs/{runId}
40
40
  * @endpoint GET /v1/search/link/jobs/{jobId}
41
41
  * @endpoint GET /v1/search/shared/{id}
42
42
  * @endpoint GET /v1/search/shared/slug/{slug}
@@ -15,7 +15,6 @@ export declare const EntityPeopleParamSchema: z.ZodObject<{
15
15
  sort: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
16
16
  countOnly: z.ZodOptional<z.ZodBoolean>;
17
17
  includeAddress: z.ZodOptional<z.ZodBoolean>;
18
- includePrivate: z.ZodOptional<z.ZodBoolean>;
19
18
  includeUrl: z.ZodOptional<z.ZodBoolean>;
20
19
  isCurrent: z.ZodOptional<z.ZodBoolean>;
21
20
  permitMonogram: z.ZodOptional<z.ZodBoolean>;
@@ -16,8 +16,6 @@ export const EntityPeopleParamSchema = PageParamSchema.extend({
16
16
  countOnly: z.boolean().optional(),
17
17
  /** Include person address records */
18
18
  includeAddress: z.boolean().optional(),
19
- /** Includes associations on hidden entities when the caller has private-visibility authority. Omit to use the caller's default visibility. */
20
- includePrivate: z.boolean().optional(),
21
19
  /** Include person URL records */
22
20
  includeUrl: z.boolean().optional(),
23
21
  /** Current association filter */
@@ -18,9 +18,9 @@ const EntityRelationshipSchemaDefinition = z.object({
18
18
  entity: EntitySchema,
19
19
  /** Integer entity_relationship.id row id, not an entity UUID */
20
20
  id: z.int().nullish(),
21
- /** Current-state curation flag for this relationship row. Default relationship reads return only rows where isCurrent=true and isPrimary=true. */
21
+ /** Whether this relationship is current. Default relationship reads return only rows where isCurrent=true and isPrimary=true. */
22
22
  isCurrent: z.boolean().nullish(),
23
- /** Primary/renderable curation flag for this relationship row. isCurrent=false or isPrimary=false hides the row from default relationship reads. */
23
+ /** Whether this relationship is the primary one shown. isCurrent=false or isPrimary=false hides the row from default relationship reads. */
24
24
  isPrimary: z.boolean().nullish(),
25
25
  /** Published page behind this relationship, read from the provenance event that wrote it; absent for internal sources. */
26
26
  publicSource: EntityResearchPublicSourceSchema.nullish(),
@@ -28,7 +28,7 @@ const EntityRelationshipSchemaDefinition = z.object({
28
28
  get relationship() {
29
29
  return z.array(EntityRelationshipSchemaDefinition);
30
30
  },
31
- /** Canonical relationship type, one of: acceleratorParticipant, acquirer, affinity, calculated, competingProductService, competitor, customer, fundManagerFirm, parent, productService, serviceProvider, similarCompany, spinOffFrom, successor. Similarity endpoint rows use stored relationship types when a curation row exists and calculated when the row comes from semantic/vector similarity. */
31
+ /** Canonical relationship type, one of: acceleratorParticipant, acquirer, affinity, calculated, competingProductService, competitor, customer, fundManagerFirm, parent, productService, serviceProvider, similarCompany, spinOffFrom, successor. Similarity endpoint rows use the stored relationship type when one exists and calculated when the row comes from similarity alone. */
32
32
  relationshipType: z.string(),
33
33
  /** Canonical source entity UUID stored on the relationship row. Compare with the requested entity id and `/v1/entities/relationships/types` sourceRole/targetRole to orient directional relationships such as parent. */
34
34
  sourceEntityId: z.uuid().nullish(),
@@ -40,7 +40,7 @@ type EntityResearchDetailDefinition = z.infer<typeof EntityResearchDetailSchemaD
40
40
  export interface EntityResearchDetailSchemaInput extends z.input<typeof EntityResearchDetailSchemaDefinition> {
41
41
  }
42
42
  /**
43
- * Canonical research detail row for research.res_entity_detail
43
+ * Research detail record for an entity.
44
44
  *
45
45
  * @openapiSchema EntityResearchDetail
46
46
  * @endpoint GET /v1/entities
@@ -26,7 +26,7 @@ const EntityResearchDetailSchemaDefinition = z.object({
26
26
  valueType: EntityResearchValueTypeSchema,
27
27
  });
28
28
  /**
29
- * Canonical research detail row for research.res_entity_detail
29
+ * Research detail record for an entity.
30
30
  *
31
31
  * @openapiSchema EntityResearchDetail
32
32
  * @endpoint GET /v1/entities
@@ -16,7 +16,6 @@ export declare const EntitySearchParamSchema: z.ZodObject<{
16
16
  countOnly: z.ZodOptional<z.ZodBoolean>;
17
17
  cursor: z.ZodOptional<z.ZodString>;
18
18
  includeFullDetail: z.ZodOptional<z.ZodBoolean>;
19
- includePrivate: z.ZodOptional<z.ZodBoolean>;
20
19
  permitMonogram: z.ZodOptional<z.ZodBoolean>;
21
20
  }, z.core.$strip>;
22
21
  export type EntitySearchParam = z.infer<typeof EntitySearchParamSchema>;
@@ -16,10 +16,8 @@ export const EntitySearchParamSchema = PageParamSchema.extend({
16
16
  countOnly: z.boolean().optional(),
17
17
  /** Opaque entity cursor; reuse filters and sort. Cursor is unsupported with countOnly; semanticQuery depends on the endpoint. */
18
18
  cursor: z.string().optional(),
19
- /** Privileged read flag. Must be true to return the /v1/entities/detail payload. */
19
+ /** Set true to return each match as its full company detail record instead of the list row; responses are much larger. */
20
20
  includeFullDetail: z.boolean().optional(),
21
- /** Includes hidden or off-sitemap entities when the caller has private-visibility authority. Omit to use the caller's default visibility. */
22
- includePrivate: z.boolean().optional(),
23
21
  /** Allow generated monogram logos in results. */
24
22
  permitMonogram: z.boolean().optional(),
25
23
  });
@@ -21,12 +21,12 @@ import { z } from "zod/v4";
21
21
  * @endpoint GET /v1/entities/{entityId}/similar
22
22
  * @endpoint GET /v1/entities/{entityId}/similar/summary
23
23
  * @endpoint GET /v1/entities/relationships/{relationshipId}
24
- * @endpoint GET /v1/harness/runs/{runId}
25
24
  * @endpoint GET /v1/lookup-jobs/{jobId}
26
25
  * @endpoint GET /v1/news/{newsId}/related-entities
27
26
  * @endpoint GET /v1/people/{personId}
28
27
  * @endpoint GET /v1/people/{personId}/graph
29
28
  * @endpoint GET /v1/people/{personId}/investments
29
+ * @endpoint GET /v1/research-runs/{runId}
30
30
  * @endpoint GET /v1/search/link/jobs/{jobId}
31
31
  * @endpoint GET /v1/search/shared/{id}
32
32
  * @endpoint GET /v1/search/shared/slug/{slug}
@@ -22,12 +22,12 @@ import { z } from "zod/v4";
22
22
  * @endpoint GET /v1/entities/{entityId}/similar
23
23
  * @endpoint GET /v1/entities/{entityId}/similar/summary
24
24
  * @endpoint GET /v1/entities/relationships/{relationshipId}
25
- * @endpoint GET /v1/harness/runs/{runId}
26
25
  * @endpoint GET /v1/lookup-jobs/{jobId}
27
26
  * @endpoint GET /v1/news/{newsId}/related-entities
28
27
  * @endpoint GET /v1/people/{personId}
29
28
  * @endpoint GET /v1/people/{personId}/graph
30
29
  * @endpoint GET /v1/people/{personId}/investments
30
+ * @endpoint GET /v1/research-runs/{runId}
31
31
  * @endpoint GET /v1/search/link/jobs/{jobId}
32
32
  * @endpoint GET /v1/search/shared/{id}
33
33
  * @endpoint GET /v1/search/shared/slug/{slug}
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Canonical classification tag projection. Catalog/search responses describe registry tags; entity-classification responses include classificationId plus join state.
3
+ * Classification tag. Catalog and search responses describe the tag itself; entity classification responses also carry classificationId and the entity's current and primary flags.
4
4
  *
5
5
  * @openapiSchema EntityTag
6
6
  * @endpoint GET /v1/entities
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  import { ClassificationSchema } from "../classification/classification.js";
4
4
  /**
5
- * Canonical classification tag projection. Catalog/search responses describe registry tags; entity-classification responses include classificationId plus join state.
5
+ * Classification tag. Catalog and search responses describe the tag itself; entity classification responses also carry classificationId and the entity's current and primary flags.
6
6
  *
7
7
  * @openapiSchema EntityTag
8
8
  * @endpoint GET /v1/entities
@@ -35,19 +35,19 @@ import { ClassificationSchema } from "../classification/classification.js";
35
35
  * @contractRole canonical
36
36
  */
37
37
  export const EntityTagSchema = z.intersection(ClassificationSchema, z.object({
38
- /** Canonical entity-classification bucket key. Use this as EntityClassificationMutation.type when creating by type plus name; `type` remains the registry wire value for tag search and catalog round-trips. */
38
+ /** Canonical classification bucket key; `type` is the value tag search and the catalog accept. */
39
39
  bucket: z.string().nullish(),
40
- /** Entity classification join row id for update/delete; present on entity classification responses and null on discovery responses. */
40
+ /** Id of this classification on the entity; null in catalog and search results. */
41
41
  classificationId: z.int().nullish(),
42
42
  /** Whether this bucket permits creating missing values by type plus name. */
43
43
  creatable: z.boolean(),
44
- /** Registry tag creation timestamp, not the entity join timestamp. */
44
+ /** Tag creation timestamp, not the time the entity received this tag. */
45
45
  createdAt: z.iso.datetime({ offset: true }).nullish(),
46
- /** Classification tag registry id from res_type_ref; use as EntityClassificationMutation.tagId. */
46
+ /** Classification tag id. */
47
47
  id: z.int(),
48
- /** Current-state flag for this context: registry active flag in discovery, entity join current flag in entity-classification responses. */
48
+ /** In catalog and search results, whether the tag is active; in entity classification responses, whether the classification is current for the entity. */
49
49
  isCurrent: z.boolean().nullish(),
50
- /** Entity join primary flag within its bucket; null on catalog/tag discovery. */
50
+ /** Whether this is the entity's primary classification in its bucket; null in catalog and search results. */
51
51
  isPrimary: z.boolean().nullish(),
52
52
  /** Name */
53
53
  name: z.string().max(255),
@@ -59,7 +59,7 @@ export const EntityTagSchema = z.intersection(ClassificationSchema, z.object({
59
59
  .nullish(),
60
60
  /** Canonical tag classification type */
61
61
  type: z.string(),
62
- /** Registry tag update timestamp; join updates return isCurrent/isPrimary but no join updatedAt. */
62
+ /** Tag update timestamp, not the time the entity's classification changed. */
63
63
  updatedAt: z.iso.datetime({ offset: true }).nullish(),
64
64
  /** Whether this existing tag can be joined through tagId. */
65
65
  writable: z.boolean(),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Confidence tier stored verbatim in res_entity_detail.data_confidence.
3
+ * Confidence tier for this data point.
4
4
  *
5
5
  * @openapiSchema EntityValuationDataConfidence
6
6
  * @endpoint GET /v1/entities/{entityId}/employee-counts
@@ -1,7 +1,7 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
3
  /**
4
- * Confidence tier stored verbatim in res_entity_detail.data_confidence.
4
+ * Confidence tier for this data point.
5
5
  *
6
6
  * @openapiSchema EntityValuationDataConfidence
7
7
  * @endpoint GET /v1/entities/{entityId}/employee-counts
@@ -5,15 +5,15 @@ import { ReasoningEffortSchema } from "../reasoning/effort.js";
5
5
  import { SearchCacheModeSchema } from "../search/cache-mode.js";
6
6
  import { SearchModeSchema } from "../search/mode.js";
7
7
  const FederatedNaturalSearchSchemaDefinition = z.object({
8
- /** Optional chat model for the synthesis answer; null uses the catalog's search answer model. The same allowlist as `model` applies. The answer writes the page heading, title, and description, so this compares answer models without changing the catalog. */
8
+ /** Optional supported model for the written answer, which also supplies the page heading, title, and description. Omit it to use the default; an unsupported model answers 422. */
9
9
  answerModel: z.string().nullish(),
10
- /** Search-stage cache policy. use reuses cached search work; bypass computes fresh without retaining outputs; refresh computes fresh and replaces normal entries. Record and immutable query-vector caches retain their own policy. Callers without private-data access always run use. */
10
+ /** Cache policy. use reuses earlier search work; bypass and refresh compute fresh results and are honored only for accounts with private-data access. */
11
11
  cacheMode: SearchCacheModeSchema.default("use").optional(),
12
12
  /** Explicit entity constraints for the entity scope only, as on POST /v1/search/natural/entities: caller-supplied fields override planner values. The person and news scopes ignore it. */
13
13
  entityFilter: EntityFilterSchema.optional(),
14
14
  /** Search strategy to run. Defaults to `auto`: the fast name layer runs first (a single-token query as keyword search, a multiword query as an exact normalized name) and the language-model planner runs only on a miss, so name lookups never pay for planning. Any other value forces exactly that strategy: `exact` and `keyword` skip planner model resolution and its rate limit. Entity and person natural-search take every value but `hybrid`; news and federated search accept only `auto` and `keyword`; content search accepts `auto`, `keyword`, `semantic`, and `hybrid` (`semantic` and `hybrid` only for one entity's or person's content). */
15
15
  mode: SearchModeSchema.default("auto").optional(),
16
- /** Optional chat model for planning; null uses the configured natural-search default. A caller without admin authority may only choose an allowlisted model; admin callers are unrestricted. */
16
+ /** Optional supported model for planning the search. Omit it to use the default; an unsupported model answers 422. */
17
17
  model: z.string().nullish(),
18
18
  /** News scope page size; omitted uses the size query parameter, under the same page-size cap. */
19
19
  newsSize: z.int().nullish(),
@@ -21,7 +21,7 @@ const FederatedNaturalSearchSchemaDefinition = z.object({
21
21
  personSize: z.int().nullish(),
22
22
  /** Plain-English search request. */
23
23
  query: z.string().min(1),
24
- /** Optional reasoning effort for every model call this search makes: the query planner and the synthesis answer. Each call sends the nearest level its model supports, the lower one on a tie. Callers without private-data access are capped at `medium`: an explicit value above it is lowered, and when it is null the resolved effort — the per-model default, the tier default, or, absent an app default, the gateway's own — is still bounded at `medium`. */
24
+ /** Optional reasoning effort for every model call this search makes: the query planner and the synthesis answer. Each call sends the nearest level its model supports, the lower one on a tie. Accounts without private-data access are capped at `medium`; higher values are lowered. */
25
25
  reasoningEffort: ReasoningEffortSchema.nullish(),
26
26
  /** Search catalog revision this search reads its qualifier prompts and startup vocabulary from, to compare catalog edits; null reads the current revision. Callers without private-data access always read the current revision. An unknown revision returns 404. */
27
27
  searchCatalogRevision: z.int().nullish(),
@@ -3,11 +3,11 @@ import { z } from "zod/v4";
3
3
  * Agent loop a harness run executes on: the Claude Agent SDK or the Pi agent SDK
4
4
  *
5
5
  * @openapiSchema HarnessChassis
6
- * @endpoint GET /v1/harness/runs/{runId}
6
+ * @endpoint GET /v1/research-runs/{runId}
7
7
  * @endpoint POST /v1/enrichments
8
8
  * @endpoint POST /v1/entities/{entityId}/enrichments
9
- * @endpoint POST /v1/harness/runs
10
9
  * @endpoint POST /v1/people/{personId}/enrichments
10
+ * @endpoint POST /v1/research-runs
11
11
  * @usedBySchema HarnessRunSchema
12
12
  * @contractShape harness.chassis
13
13
  * @contractRole canonical
@@ -4,11 +4,11 @@ import { z } from "zod/v4";
4
4
  * Agent loop a harness run executes on: the Claude Agent SDK or the Pi agent SDK
5
5
  *
6
6
  * @openapiSchema HarnessChassis
7
- * @endpoint GET /v1/harness/runs/{runId}
7
+ * @endpoint GET /v1/research-runs/{runId}
8
8
  * @endpoint POST /v1/enrichments
9
9
  * @endpoint POST /v1/entities/{entityId}/enrichments
10
- * @endpoint POST /v1/harness/runs
11
10
  * @endpoint POST /v1/people/{personId}/enrichments
11
+ * @endpoint POST /v1/research-runs
12
12
  * @usedBySchema HarnessRunSchema
13
13
  * @contractShape harness.chassis
14
14
  * @contractRole canonical
@@ -3,11 +3,11 @@ import { z } from "zod/v4";
3
3
  * Gateway wire API for a run's LLM calls: Anthropic Messages, OpenAI Chat Completions, or OpenAI Responses
4
4
  *
5
5
  * @openapiSchema HarnessLlmApi
6
- * @endpoint GET /v1/harness/runs/{runId}
6
+ * @endpoint GET /v1/research-runs/{runId}
7
7
  * @endpoint POST /v1/enrichments
8
8
  * @endpoint POST /v1/entities/{entityId}/enrichments
9
- * @endpoint POST /v1/harness/runs
10
9
  * @endpoint POST /v1/people/{personId}/enrichments
10
+ * @endpoint POST /v1/research-runs
11
11
  * @usedBySchema HarnessRunSchema
12
12
  * @contractShape harness.llm-api
13
13
  * @contractRole canonical
@@ -4,11 +4,11 @@ import { z } from "zod/v4";
4
4
  * Gateway wire API for a run's LLM calls: Anthropic Messages, OpenAI Chat Completions, or OpenAI Responses
5
5
  *
6
6
  * @openapiSchema HarnessLlmApi
7
- * @endpoint GET /v1/harness/runs/{runId}
7
+ * @endpoint GET /v1/research-runs/{runId}
8
8
  * @endpoint POST /v1/enrichments
9
9
  * @endpoint POST /v1/entities/{entityId}/enrichments
10
- * @endpoint POST /v1/harness/runs
11
10
  * @endpoint POST /v1/people/{personId}/enrichments
11
+ * @endpoint POST /v1/research-runs
12
12
  * @usedBySchema HarnessRunSchema
13
13
  * @contractShape harness.llm-api
14
14
  * @contractRole canonical
@@ -28,7 +28,7 @@ export interface HarnessRunCreateSchemaInput extends z.input<typeof HarnessRunCr
28
28
  * Create one harness enrichment run
29
29
  *
30
30
  * @openapiSchema HarnessRunCreate
31
- * @endpoint POST /v1/harness/runs
31
+ * @endpoint POST /v1/research-runs
32
32
  * @contractShape harness.run-create
33
33
  * @contractRole canonical
34
34
  */
@@ -22,7 +22,7 @@ const HarnessRunCreateSchemaDefinition = z.object({
22
22
  * Create one harness enrichment run
23
23
  *
24
24
  * @openapiSchema HarnessRunCreate
25
- * @endpoint POST /v1/harness/runs
25
+ * @endpoint POST /v1/research-runs
26
26
  * @contractShape harness.run-create
27
27
  * @contractRole canonical
28
28
  */
@@ -172,10 +172,10 @@ type HarnessRunDetailDefinition = z.infer<typeof HarnessRunDetailSchemaDefinitio
172
172
  export interface HarnessRunDetailSchemaInput extends z.input<typeof HarnessRunDetailSchemaDefinition> {
173
173
  }
174
174
  /**
175
- * Harness run with its resolved public entity
175
+ * Research run with the profile it resolved to
176
176
  *
177
177
  * @openapiSchema HarnessRunDetail
178
- * @endpoint GET /v1/harness/runs/{runId}
178
+ * @endpoint GET /v1/research-runs/{runId}
179
179
  * @contractShape harness.run-detail
180
180
  * @contractRole canonical
181
181
  */
@@ -4,22 +4,22 @@ import { EntitySchema } from "../entity/entity.js";
4
4
  import { HarnessRunProgressSchema } from "./run-progress.js";
5
5
  import { HarnessRunSchema } from "./run.js";
6
6
  const HarnessRunDetailSchemaDefinition = z.object({
7
- /** Current public entity resolved from the run slug */
7
+ /** Current public profile the run resolved to */
8
8
  entity: EntitySchema.nullish(),
9
- /** Parsed principal-facing loop progress; null when the raw run status is absent or invalid */
9
+ /** Latest research progress; null when none is available */
10
10
  latestStatus: HarnessRunProgressSchema.nullish(),
11
11
  /** Parent organization's core record when the resolved entity is a Product/Service; null for every other entity type */
12
12
  provider: EntitySchema.nullish(),
13
13
  /** Exact renderable public profile URL for the resolved entity */
14
14
  publicUrl: z.string().nullish(),
15
- /** Canonical harness run */
15
+ /** The research run */
16
16
  run: HarnessRunSchema,
17
17
  });
18
18
  /**
19
- * Harness run with its resolved public entity
19
+ * Research run with the profile it resolved to
20
20
  *
21
21
  * @openapiSchema HarnessRunDetail
22
- * @endpoint GET /v1/harness/runs/{runId}
22
+ * @endpoint GET /v1/research-runs/{runId}
23
23
  * @contractShape harness.run-detail
24
24
  * @contractRole canonical
25
25
  */
@@ -3,15 +3,12 @@ import { z } from "zod/v4";
3
3
  * Owning API environment
4
4
  *
5
5
  * @openapiSchema HarnessRunEnvironment
6
- * @endpoint GET /v1/harness/runs/{runId}
7
- * @endpoint GET /v1/web/searches/jobs/{jobId}
6
+ * @endpoint GET /v1/research-runs/{runId}
8
7
  * @endpoint POST /v1/enrichments
9
8
  * @endpoint POST /v1/entities/{entityId}/enrichments
10
- * @endpoint POST /v1/harness/runs
11
9
  * @endpoint POST /v1/people/{personId}/enrichments
12
- * @endpoint POST /v1/web/search
10
+ * @endpoint POST /v1/research-runs
13
11
  * @usedBySchema HarnessRunSchema
14
- * @usedBySchema SearchSchema
15
12
  * @contractShape harness.run-environment
16
13
  * @contractRole canonical
17
14
  */
@@ -4,15 +4,12 @@ import { z } from "zod/v4";
4
4
  * Owning API environment
5
5
  *
6
6
  * @openapiSchema HarnessRunEnvironment
7
- * @endpoint GET /v1/harness/runs/{runId}
8
- * @endpoint GET /v1/web/searches/jobs/{jobId}
7
+ * @endpoint GET /v1/research-runs/{runId}
9
8
  * @endpoint POST /v1/enrichments
10
9
  * @endpoint POST /v1/entities/{entityId}/enrichments
11
- * @endpoint POST /v1/harness/runs
12
10
  * @endpoint POST /v1/people/{personId}/enrichments
13
- * @endpoint POST /v1/web/search
11
+ * @endpoint POST /v1/research-runs
14
12
  * @usedBySchema HarnessRunSchema
15
- * @usedBySchema SearchSchema
16
13
  * @contractShape harness.run-environment
17
14
  * @contractRole canonical
18
15
  */
@@ -3,11 +3,11 @@ import { z } from "zod/v4";
3
3
  * Queue lane for admission priority: interactive client work vs background backlog
4
4
  *
5
5
  * @openapiSchema HarnessRunLane
6
- * @endpoint GET /v1/harness/runs/{runId}
6
+ * @endpoint GET /v1/research-runs/{runId}
7
7
  * @endpoint POST /v1/enrichments
8
8
  * @endpoint POST /v1/entities/{entityId}/enrichments
9
- * @endpoint POST /v1/harness/runs
10
9
  * @endpoint POST /v1/people/{personId}/enrichments
10
+ * @endpoint POST /v1/research-runs
11
11
  * @usedBySchema HarnessRunSchema
12
12
  * @contractShape harness.run-lane
13
13
  * @contractRole canonical
@@ -4,11 +4,11 @@ import { z } from "zod/v4";
4
4
  * Queue lane for admission priority: interactive client work vs background backlog
5
5
  *
6
6
  * @openapiSchema HarnessRunLane
7
- * @endpoint GET /v1/harness/runs/{runId}
7
+ * @endpoint GET /v1/research-runs/{runId}
8
8
  * @endpoint POST /v1/enrichments
9
9
  * @endpoint POST /v1/entities/{entityId}/enrichments
10
- * @endpoint POST /v1/harness/runs
11
10
  * @endpoint POST /v1/people/{personId}/enrichments
11
+ * @endpoint POST /v1/research-runs
12
12
  * @usedBySchema HarnessRunSchema
13
13
  * @contractShape harness.run-lane
14
14
  * @contractRole canonical
@@ -3,7 +3,7 @@ import { z } from "zod/v4";
3
3
  * Current public progress of a harness run
4
4
  *
5
5
  * @openapiSchema HarnessRunProgress
6
- * @endpoint GET /v1/harness/runs/{runId}
6
+ * @endpoint GET /v1/research-runs/{runId}
7
7
  * @usedBySchema HarnessRunDetailSchema
8
8
  * @contractShape harness.run-progress
9
9
  * @contractRole canonical
@@ -4,7 +4,7 @@ import { z } from "zod/v4";
4
4
  * Current public progress of a harness run
5
5
  *
6
6
  * @openapiSchema HarnessRunProgress
7
- * @endpoint GET /v1/harness/runs/{runId}
7
+ * @endpoint GET /v1/research-runs/{runId}
8
8
  * @usedBySchema HarnessRunDetailSchema
9
9
  * @contractShape harness.run-progress
10
10
  * @contractRole canonical
@@ -18,7 +18,7 @@ export const HarnessRunProgressSchema = z.object({
18
18
  .regex(/^[a-z0-9_-]+$/)
19
19
  .max(255)
20
20
  .nullable(),
21
- /** Concrete completion gates that remain unmet */
21
+ /** Profile sections the run has not finished yet */
22
22
  gateRemaining: z.array(z.string()),
23
23
  /** Optional progress note from the loop */
24
24
  note: z.string().nullish(),
@@ -1,13 +1,13 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Harness run lifecycle state
3
+ * Research run lifecycle state
4
4
  *
5
5
  * @openapiSchema HarnessRunStatus
6
- * @endpoint GET /v1/harness/runs/{runId}
6
+ * @endpoint GET /v1/research-runs/{runId}
7
7
  * @endpoint POST /v1/enrichments
8
8
  * @endpoint POST /v1/entities/{entityId}/enrichments
9
- * @endpoint POST /v1/harness/runs
10
9
  * @endpoint POST /v1/people/{personId}/enrichments
10
+ * @endpoint POST /v1/research-runs
11
11
  * @usedBySchema HarnessRunSchema
12
12
  * @contractShape harness.run-status
13
13
  * @contractRole canonical
@@ -1,14 +1,14 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
3
  /**
4
- * Harness run lifecycle state
4
+ * Research run lifecycle state
5
5
  *
6
6
  * @openapiSchema HarnessRunStatus
7
- * @endpoint GET /v1/harness/runs/{runId}
7
+ * @endpoint GET /v1/research-runs/{runId}
8
8
  * @endpoint POST /v1/enrichments
9
9
  * @endpoint POST /v1/entities/{entityId}/enrichments
10
- * @endpoint POST /v1/harness/runs
11
10
  * @endpoint POST /v1/people/{personId}/enrichments
11
+ * @endpoint POST /v1/research-runs
12
12
  * @usedBySchema HarnessRunSchema
13
13
  * @contractShape harness.run-status
14
14
  * @contractRole canonical
@@ -1,13 +1,13 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Harness run kind: full enrichment loop or bounded micro-task
3
+ * Research run kind: a caller-filed research request or a narrower scheduled run
4
4
  *
5
5
  * @openapiSchema HarnessRunType
6
- * @endpoint GET /v1/harness/runs/{runId}
6
+ * @endpoint GET /v1/research-runs/{runId}
7
7
  * @endpoint POST /v1/enrichments
8
8
  * @endpoint POST /v1/entities/{entityId}/enrichments
9
- * @endpoint POST /v1/harness/runs
10
9
  * @endpoint POST /v1/people/{personId}/enrichments
10
+ * @endpoint POST /v1/research-runs
11
11
  * @usedBySchema HarnessRunSchema
12
12
  * @contractShape harness.run-type
13
13
  * @contractRole canonical
@@ -1,14 +1,14 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
3
  /**
4
- * Harness run kind: full enrichment loop or bounded micro-task
4
+ * Research run kind: a caller-filed research request or a narrower scheduled run
5
5
  *
6
6
  * @openapiSchema HarnessRunType
7
- * @endpoint GET /v1/harness/runs/{runId}
7
+ * @endpoint GET /v1/research-runs/{runId}
8
8
  * @endpoint POST /v1/enrichments
9
9
  * @endpoint POST /v1/entities/{entityId}/enrichments
10
- * @endpoint POST /v1/harness/runs
11
10
  * @endpoint POST /v1/people/{personId}/enrichments
11
+ * @endpoint POST /v1/research-runs
12
12
  * @usedBySchema HarnessRunSchema
13
13
  * @contractShape harness.run-type
14
14
  * @contractRole canonical
@@ -1,13 +1,13 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * One harness enrichment run
3
+ * One research run on a company, Product, Service, or person
4
4
  *
5
5
  * @openapiSchema HarnessRun
6
- * @endpoint GET /v1/harness/runs/{runId}
6
+ * @endpoint GET /v1/research-runs/{runId}
7
7
  * @endpoint POST /v1/enrichments
8
8
  * @endpoint POST /v1/entities/{entityId}/enrichments
9
- * @endpoint POST /v1/harness/runs
10
9
  * @endpoint POST /v1/people/{personId}/enrichments
10
+ * @endpoint POST /v1/research-runs
11
11
  * @usedBySchema EnrichmentSchema
12
12
  * @usedBySchema HarnessRunDetailSchema
13
13
  * @contractShape harness.run