@aventurevc/api-schemas 0.7.302 → 0.7.329

package/dist/fundraise/data-confidence.js

@@ -4,9 +4,6 @@ import { z } from "zod/v4";
  * Fundraise data confidence label
  *
  * @openapiSchema FundraiseDataConfidence
- * @endpoint GET /v1/entities
- * @endpoint GET /v1/entities/detail
- * @endpoint GET /v1/entities/detail/similar
  * @endpoint GET /v1/entities/lookup
  * @endpoint GET /v1/entities/summary
  * @endpoint GET /v1/search/link
@@ -20,13 +17,13 @@ import { z } from "zod/v4";
  * @endpoint GET /v1/entities/{entityId}/products/suggestions
  * @endpoint GET /v1/entities/{entityId}/relationships/suggestions
  * @endpoint GET /v1/entities/{entityId}/similar
- * @endpoint POST /v1/entities/batch
- * @endpoint POST /v1/entities/detail/batch
  * @endpoint POST /v1/entities/lookup/batch
  * @endpoint POST /v1/entities/lookup/matches
  * @endpoint POST /v1/entities/natural-search
  * @endpoint POST /v1/entities/search
+ * @endpoint POST /v1/search
  * @endpoint POST /v1/search/all
+ * @endpoint POST /v1/search/natural/entities
  * @usedBySchema EntityAcquisitionSchema
  * @usedBySchema EntityFundraiseTransactionSchema
  * @contractShape fundraise.data-confidence

package/dist/fundraise/financial-instrument-type.d.ts

@@ -3,8 +3,8 @@ import { z } from "zod/v4";
  * Fundraise financial instrument type — the vehicle a round or investor join used
  *
  * @openapiSchema FundraiseFinancialInstrumentType
- * @endpoint GET /v1/entities/detail/fundraise-investor-joins
- * @endpoint GET /v1/entities/detail/fundraise-investor-joins/{joinId}
+ * @endpoint GET /v1/entities/{entityId}/fundraise-investor-joins
+ * @endpoint GET /v1/entities/{entityId}/fundraise-investor-joins/{joinId}
  * @usedBySchema EntityFundraiseInvestorJoinSchema
  * @contractShape fundraise.financial-instrument-type
  * @contractRole canonical

package/dist/fundraise/financial-instrument-type.js

@@ -4,8 +4,8 @@ import { z } from "zod/v4";
  * Fundraise financial instrument type — the vehicle a round or investor join used
  *
  * @openapiSchema FundraiseFinancialInstrumentType
- * @endpoint GET /v1/entities/detail/fundraise-investor-joins
- * @endpoint GET /v1/entities/detail/fundraise-investor-joins/{joinId}
+ * @endpoint GET /v1/entities/{entityId}/fundraise-investor-joins
+ * @endpoint GET /v1/entities/{entityId}/fundraise-investor-joins/{joinId}
  * @usedBySchema EntityFundraiseInvestorJoinSchema
  * @contractShape fundraise.financial-instrument-type
  * @contractRole canonical

package/dist/fundraise/investment-attribution-type.d.ts

@@ -3,13 +3,8 @@ import { z } from "zod/v4";
  * How a fundraise investor attribution row was selected for an investor view.
  *
  * @openapiSchema FundraiseInvestmentAttributionType
- * @endpoint GET /v1/entities
- * @endpoint GET /v1/entities/detail
- * @endpoint GET /v1/entities/detail/similar
  * @endpoint GET /v1/entities/lookup
  * @endpoint GET /v1/entities/summary
- * @endpoint GET /v1/people/detail
- * @endpoint GET /v1/people/detail/investments
  * @endpoint GET /v1/people/lookup
  * @endpoint GET /v1/search/link
  * @endpoint GET /v1/entities/{entityId}
@@ -22,16 +17,15 @@ import { z } from "zod/v4";
  * @endpoint GET /v1/entities/{entityId}/relationships/suggestions
  * @endpoint GET /v1/entities/{entityId}/similar
  * @endpoint GET /v1/people/{personId}
- * @endpoint POST /v1/entities/batch
- * @endpoint POST /v1/entities/detail/batch
+ * @endpoint GET /v1/people/{personId}/investments
  * @endpoint POST /v1/entities/lookup/batch
  * @endpoint POST /v1/entities/lookup/matches
  * @endpoint POST /v1/entities/natural-search
  * @endpoint POST /v1/entities/search
- * @endpoint POST /v1/people/batch
- * @endpoint POST /v1/people/detail/batch
  * @endpoint POST /v1/people/lookup/batch
+ * @endpoint POST /v1/search
  * @endpoint POST /v1/search/all
+ * @endpoint POST /v1/search/natural/entities
  * @usedBySchema FundraiseInvestmentAttributionSchema
  * @contractShape fundraise.investment-attribution-type
  * @contractRole canonical

package/dist/fundraise/investment-attribution-type.js

@@ -4,13 +4,8 @@ import { z } from "zod/v4";
  * How a fundraise investor attribution row was selected for an investor view.
  *
  * @openapiSchema FundraiseInvestmentAttributionType
- * @endpoint GET /v1/entities
- * @endpoint GET /v1/entities/detail
- * @endpoint GET /v1/entities/detail/similar
  * @endpoint GET /v1/entities/lookup
  * @endpoint GET /v1/entities/summary
- * @endpoint GET /v1/people/detail
- * @endpoint GET /v1/people/detail/investments
  * @endpoint GET /v1/people/lookup
  * @endpoint GET /v1/search/link
  * @endpoint GET /v1/entities/{entityId}
@@ -23,16 +18,15 @@ import { z } from "zod/v4";
  * @endpoint GET /v1/entities/{entityId}/relationships/suggestions
  * @endpoint GET /v1/entities/{entityId}/similar
  * @endpoint GET /v1/people/{personId}
- * @endpoint POST /v1/entities/batch
- * @endpoint POST /v1/entities/detail/batch
+ * @endpoint GET /v1/people/{personId}/investments
  * @endpoint POST /v1/entities/lookup/batch
  * @endpoint POST /v1/entities/lookup/matches
  * @endpoint POST /v1/entities/natural-search
  * @endpoint POST /v1/entities/search
- * @endpoint POST /v1/people/batch
- * @endpoint POST /v1/people/detail/batch
  * @endpoint POST /v1/people/lookup/batch
+ * @endpoint POST /v1/search
  * @endpoint POST /v1/search/all
+ * @endpoint POST /v1/search/natural/entities
  * @usedBySchema FundraiseInvestmentAttributionSchema
  * @contractShape fundraise.investment-attribution-type
  * @contractRole canonical

package/dist/fundraise/investment-attribution.d.ts

@@ -3,13 +3,8 @@ import { z } from "zod/v4";
  * Investor-specific attribution for one fundraise participation row
  *
  * @openapiSchema FundraiseInvestmentAttribution
- * @endpoint GET /v1/entities
- * @endpoint GET /v1/entities/detail
- * @endpoint GET /v1/entities/detail/similar
  * @endpoint GET /v1/entities/lookup
  * @endpoint GET /v1/entities/summary
- * @endpoint GET /v1/people/detail
- * @endpoint GET /v1/people/detail/investments
  * @endpoint GET /v1/people/lookup
  * @endpoint GET /v1/search/link
  * @endpoint GET /v1/entities/{entityId}
@@ -22,16 +17,15 @@ import { z } from "zod/v4";
  * @endpoint GET /v1/entities/{entityId}/relationships/suggestions
  * @endpoint GET /v1/entities/{entityId}/similar
  * @endpoint GET /v1/people/{personId}
- * @endpoint POST /v1/entities/batch
- * @endpoint POST /v1/entities/detail/batch
+ * @endpoint GET /v1/people/{personId}/investments
  * @endpoint POST /v1/entities/lookup/batch
  * @endpoint POST /v1/entities/lookup/matches
  * @endpoint POST /v1/entities/natural-search
  * @endpoint POST /v1/entities/search
- * @endpoint POST /v1/people/batch
- * @endpoint POST /v1/people/detail/batch
  * @endpoint POST /v1/people/lookup/batch
+ * @endpoint POST /v1/search
  * @endpoint POST /v1/search/all
+ * @endpoint POST /v1/search/natural/entities
  * @usedBySchema EntityFundraiseTransactionSchema
  * @usedBySchema EntityInvestorParticipationSchema
  * @usedBySchema PersonInvestmentSchema

package/dist/fundraise/investment-attribution.js

@@ -6,13 +6,8 @@ import { RoundLabelSchema } from "../round/label.js";
  * Investor-specific attribution for one fundraise participation row
  *
  * @openapiSchema FundraiseInvestmentAttribution
- * @endpoint GET /v1/entities
- * @endpoint GET /v1/entities/detail
- * @endpoint GET /v1/entities/detail/similar
  * @endpoint GET /v1/entities/lookup
  * @endpoint GET /v1/entities/summary
- * @endpoint GET /v1/people/detail
- * @endpoint GET /v1/people/detail/investments
  * @endpoint GET /v1/people/lookup
  * @endpoint GET /v1/search/link
  * @endpoint GET /v1/entities/{entityId}
@@ -25,16 +20,15 @@ import { RoundLabelSchema } from "../round/label.js";
  * @endpoint GET /v1/entities/{entityId}/relationships/suggestions
  * @endpoint GET /v1/entities/{entityId}/similar
  * @endpoint GET /v1/people/{personId}
- * @endpoint POST /v1/entities/batch
- * @endpoint POST /v1/entities/detail/batch
+ * @endpoint GET /v1/people/{personId}/investments
  * @endpoint POST /v1/entities/lookup/batch
  * @endpoint POST /v1/entities/lookup/matches
  * @endpoint POST /v1/entities/natural-search
  * @endpoint POST /v1/entities/search
- * @endpoint POST /v1/people/batch
- * @endpoint POST /v1/people/detail/batch
  * @endpoint POST /v1/people/lookup/batch
+ * @endpoint POST /v1/search
  * @endpoint POST /v1/search/all
+ * @endpoint POST /v1/search/natural/entities
  * @usedBySchema EntityFundraiseTransactionSchema
  * @usedBySchema EntityInvestorParticipationSchema
  * @usedBySchema PersonInvestmentSchema

package/dist/help/citation.d.ts

@@ -17,6 +17,7 @@ type HelpCitationDefinition = z.infer<typeof HelpCitationSchemaDefinition>;
  *
  * @openapiSchema HelpCitation
  * @endpoint POST /v1/agents/help
+ * @endpoint POST /v1/help
  * @usedBySchema AgentHelpSchema
  * @contractShape help.citation
  * @contractRole canonical

package/dist/help/citation.js

@@ -16,6 +16,7 @@ const HelpCitationSchemaDefinition = z.object({
  *
  * @openapiSchema HelpCitation
  * @endpoint POST /v1/agents/help
+ * @endpoint POST /v1/help
  * @usedBySchema AgentHelpSchema
  * @contractShape help.citation
  * @contractRole canonical

package/dist/help/scope.d.ts

@@ -4,6 +4,7 @@ import { z } from "zod/v4";
  *
  * @openapiSchema HelpScope
  * @endpoint POST /v1/agents/help
+ * @endpoint POST /v1/help
  * @usedBySchema AgentHelpQuestionSchema
  * @contractShape help.scope
  * @contractRole canonical

package/dist/help/scope.js

@@ -5,6 +5,7 @@ import { z } from "zod/v4";
  *
  * @openapiSchema HelpScope
  * @endpoint POST /v1/agents/help
+ * @endpoint POST /v1/help
  * @usedBySchema AgentHelpQuestionSchema
  * @contractShape help.scope
  * @contractRole canonical

package/dist/help/source-type.d.ts

@@ -4,6 +4,7 @@ import { z } from "zod/v4";
  *
  * @openapiSchema HelpSourceType
  * @endpoint POST /v1/agents/help
+ * @endpoint POST /v1/help
  * @usedBySchema HelpCitationSchema
  * @contractShape help.source-type
  * @contractRole canonical

package/dist/help/source-type.js

@@ -5,6 +5,7 @@ import { z } from "zod/v4";
  *
  * @openapiSchema HelpSourceType
  * @endpoint POST /v1/agents/help
+ * @endpoint POST /v1/help
  * @usedBySchema HelpCitationSchema
  * @contractShape help.source-type
  * @contractRole canonical

package/dist/http/problem-detail.d.ts

@@ -1,5 +1,13 @@
 import { z } from "zod/v4";
 declare const ProblemDetailSchemaDefinition: z.ZodObject<{
+    allowanceType: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        ENTITY_VIEW: "ENTITY_VIEW";
+        NEW_COMPANY: "NEW_COMPANY";
+        NEW_PERSON: "NEW_PERSON";
+        PERSON_VIEW: "PERSON_VIEW";
+        UPDATE: "UPDATE";
+        UPDATE_PERSON: "UPDATE_PERSON";
+    }>>>;
     circuitBreaker: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     code: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         GEOCODE_PROVIDER_ERROR: "GEOCODE_PROVIDER_ERROR";
@@ -10,7 +18,10 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
         INFERENCE_PROVIDER_RESPONSE_EMPTY: "INFERENCE_PROVIDER_RESPONSE_EMPTY";
         JOBRUNR_DISABLED: "JOBRUNR_DISABLED";
         JOBRUNR_STORAGE_UNAVAILABLE: "JOBRUNR_STORAGE_UNAVAILABLE";
+        billing_additional_usage_cap_reached: "billing_additional_usage_cap_reached";
+        billing_allowance_exhausted: "billing_allowance_exhausted";
         frontend_cache_epoch_mode_not_targeted: "frontend_cache_epoch_mode_not_targeted";
+        geocode_provider_error: "geocode_provider_error";
         github_fetch_failed: "github_fetch_failed";
         image_blocklist_match: "image_blocklist_match";
         image_brand_mismatch: "image_brand_mismatch";
@@ -20,16 +31,25 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
         image_too_small: "image_too_small";
         image_unreadable: "image_unreadable";
         image_wrong_aspect: "image_wrong_aspect";
+        inference_profile_api_key_missing: "inference_profile_api_key_missing";
+        inference_profiles_missing: "inference_profiles_missing";
+        inference_provider_error: "inference_provider_error";
+        inference_provider_invalid_json: "inference_provider_invalid_json";
+        inference_provider_response_empty: "inference_provider_response_empty";
+        jobrunr_disabled: "jobrunr_disabled";
+        jobrunr_storage_unavailable: "jobrunr_storage_unavailable";
         news_rss_article_fetch_failed: "news_rss_article_fetch_failed";
         news_rss_feed_fetch_failed: "news_rss_feed_fetch_failed";
         news_similarity_embedding_unavailable: "news_similarity_embedding_unavailable";
         not_authorized: "not_authorized";
         origin_detail_capacity: "origin_detail_capacity";
         origin_detail_shutdown: "origin_detail_shutdown";
+        primary_website_missing: "primary_website_missing";
         r2_delete_failed: "r2_delete_failed";
         r2_fetch_failed: "r2_fetch_failed";
         r2_upload_failed: "r2_upload_failed";
         rateLimited: "rateLimited";
+        rate_limited: "rate_limited";
         rbac_lookup_unavailable: "rbac_lookup_unavailable";
         search_provider_error: "search_provider_error";
         search_provider_not_configured: "search_provider_not_configured";
@@ -37,8 +57,12 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
         sentry_api_error: "sentry_api_error";
         source_document_body_unavailable: "source_document_body_unavailable";
         source_document_capture_limit_exceeded: "source_document_capture_limit_exceeded";
+        subscription_canceled: "subscription_canceled";
+        subscription_past_due: "subscription_past_due";
+        subscription_paused: "subscription_paused";
+        subscription_required: "subscription_required";
         suspectedShellStrip: "suspectedShellStrip";
-        swagger_headers_unconfigured: "swagger_headers_unconfigured";
+        suspected_shell_strip: "suspected_shell_strip";
         url_surface_misclassification: "url_surface_misclassification";
         web_crawl_fetch_failed: "web_crawl_fetch_failed";
     }>>>;
@@ -186,6 +210,7 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
     instance: z.ZodOptional<z.ZodString>;
     limit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     limitType: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        BILLING_ADDITIONAL_USAGE: "BILLING_ADDITIONAL_USAGE";
         BILLING_ALLOWANCE: "BILLING_ALLOWANCE";
         CLERK_PUBLIC_ADMISSION: "CLERK_PUBLIC_ADMISSION";
         CLERK_SCRIPT_LOAD: "CLERK_SCRIPT_LOAD";

package/dist/http/problem-detail.js

@@ -6,49 +6,124 @@ import { ProblemResolutionSchema } from "../problem/resolution.js";
 import { CurrentSlugOwnerSchema } from "../redirect/current-slug-owner.js";
 import { RedirectSlugPathSchema } from "../redirect/redirect-slug-path.js";
 const ProblemDetailSchemaDefinition = z.object({
+    /** Which monthly allowance a BILLING_ALLOWANCE refusal exhausted. */
+    allowanceType: z
+        .enum(["NEW_COMPANY", "UPDATE", "NEW_PERSON", "UPDATE_PERSON", "ENTITY_VIEW", "PERSON_VIEW"])
+        .nullish(),
     circuitBreaker: z.string().nullish(),
     /** Machine-readable secondary code on ProblemDetail.code. Agents should branch on this value when the HTTP status alone does not identify the recovery path. Code groups include auth/session, rate limiting, job infrastructure, RBAC, external providers, image processing, R2 storage, search, and inference. Many codes indicate infra/admin-only conditions where the correct agent action is to surface the error and stop, not retry. */
     code: z
         .enum([
+        /** Caller is authenticated but lacks the required role for this operation. Agent action: surface the requiredRole field on the ProblemDetail and stop; do not retry without role escalation. */
         "not_authorized",
+        /** Request was throttled. Agent action: wait at least retryAfterSeconds (also on ProblemDetail) before retrying. Repeated 429s on the same key indicate a burst-rate violation, not a sustained-rate one. */
         "rateLimited",
+        /** Request was throttled. Agent action: wait at least retryAfterSeconds (also on ProblemDetail) before retrying. Repeated 429s on the same key indicate a burst-rate violation, not a sustained-rate one. */
+        "rate_limited",
+        /** Caller is authenticated but the subscription on their account does not include this operation. Agent action: surface ProblemDetail.detail explaining the subscription requirement and stop. The identical request cannot succeed until the account changes plan, so never retry it. */
+        "subscription_required",
+        /** Caller's subscription was canceled or its first payment expired unpaid, so it no longer includes this operation. Agent action: surface ProblemDetail.detail and stop; the account must subscribe again through the resolution's Checkout endpoint before the identical request can succeed. */
+        "subscription_canceled",
+        /** Caller's subscription has a failed or unfinished payment, so it does not include this operation until the payment succeeds. Agent action: surface ProblemDetail.detail and stop; the account must update its payment method through the resolution's Billing Portal endpoint. */
+        "subscription_past_due",
+        /** Caller's subscription is paused, so it does not include this operation. Agent action: surface ProblemDetail.detail and stop; the account must resume the subscription through the resolution's Billing Portal endpoint. */
+        "subscription_paused",
+        /** The caller's metered allowance for this operation is spent for the current period. Agent action: stop and report ProblemDetail.allowanceType, limit, used, remaining, and resetAt; resetAt is when the meter refills and is typically weeks away. Do not retry inside the period even though the status is 429. */
+        "billing_allowance_exhausted",
+        /** The caller's monthly allowance is spent and the next additional-usage unit would pass the monthly spend cap or the prepaid credit left. Agent action: stop and report ProblemDetail.allowanceType, limit, used, remaining, and resetAt; raise the cap or buy credit through /v1/billing/additional-usage, or wait for resetAt. */
+        "billing_additional_usage_cap_reached",
+        /** Detail-origin cold-miss coalescing is saturated. Agent action: treat as backend capacity impairment, back off, and inspect backend pool/bulkhead metrics; this is not a caller throttle. */
         "origin_detail_capacity",
+        /** Detail-origin cold-miss scheduler rejected work because this instance is shutting down for a redeploy. Agent action: retry shortly; the platform routes the retry to a healthy instance. This is deploy-window noise, not a capacity defect — do not treat it as backend saturation. */
         "origin_detail_shutdown",
+        /** Request prose looks shell-mangled around a money phrase: either shell expansion stripped a leading dollar sign ('50 million' where '$50 million' was meant) or an escape character survived into the text ('\$50 million', standalone '/$50 million'). Agent action: write '$' literally and re-run with JSON body input via --from-file or stdin, or ANSI-C $'...' quoting; use allowSuspectedShellStrip only when the value is intentional. */
         "suspectedShellStrip",
+        /** Request prose looks shell-mangled around a money phrase: either shell expansion stripped a leading dollar sign ('50 million' where '$50 million' was meant) or an escape character survived into the text ('\$50 million', standalone '/$50 million'). Agent action: write '$' literally and re-run with JSON body input via --from-file or stdin, or ANSI-C $'...' quoting; use allowSuspectedShellStrip only when the value is intentional. */
+        "suspected_shell_strip",
+        /** A URL was submitted to the wrong write surface. Agent action: move the URL to the specific surface named by ProblemDetail.hint/resolution, for example EntityUrl.urlType=ycombinator via entities urls create instead of News.newsUrlOriginal. */
         "url_surface_misclassification",
+        /** JobRunr background worker is disabled in this environment. Agent action: stop (this is an admin/ops configuration condition, not a retriable user error). */
         "JOBRUNR_DISABLED",
+        /** JobRunr background worker is disabled in this environment. Agent action: stop (this is an admin/ops configuration condition, not a retriable user error). */
+        "jobrunr_disabled",
+        /** JobRunr backing storage (Postgres) is unavailable. Agent action: stop; retrying will not help until DB connectivity is restored. */
         "JOBRUNR_STORAGE_UNAVAILABLE",
+        /** JobRunr backing storage (Postgres) is unavailable. Agent action: stop; retrying will not help until DB connectivity is restored. */
+        "jobrunr_storage_unavailable",
+        /** RBAC role lookup failed (app_user read did not return). Agent action: retry once; persistent failure indicates a database outage. */
         "rbac_lookup_unavailable",
+        /** Geocoding provider (Google Maps Platform) call failed. Agent action: surface the error; address fields can be submitted without normalization as a fallback. */
         "GEOCODE_PROVIDER_ERROR",
+        /** Geocoding provider (Google Maps Platform) call failed. Agent action: surface the error; address fields can be submitted without normalization as a fallback. */
+        "geocode_provider_error",
+        /** Sentry API call failed (used by error-triage endpoints). Agent action: surface; Sentry outages do not affect the primary application path. */
         "sentry_api_error",
-        "swagger_headers_unconfigured",
+        /** Frontend cache epoch requires the cache invalidation outbox consumer to run in targeted mode. Agent action: stop polling; this 503 is a designed cutover guard, and only the operator switching the outbox mode to targeted (docs/database/cache-invalidation.md) makes the epoch readable. */
         "frontend_cache_epoch_mode_not_targeted",
+        /** Image upload matched a blocklist entry (visually similar to a known bad asset). Agent action: do not retry the same image; supply a different image or stop. */
         "image_blocklist_match",
+        /** Image upload was blank or a flat monochrome canvas. Agent action: supply a source image with visible logo or photo detail; retrying the same bytes will not pass. */
         "image_monochrome",
+        /** Image upload failed minimum dimension/file-size check. Agent action: supply a higher-resolution source image; retrying the same one will not pass. */
         "image_too_small",
+        /** Image upload's visible content is a wide banner/wordmark when a square logo or photo was required. Agent action: supply a square (or near-square) source image — a favicon, app icon, square logo, or cropped headshot — not a horizontal wordmark or og:image banner; retrying the same bytes will not pass. */
         "image_wrong_aspect",
+        /** Image upload was classified as a monogram (single letter / generated initial) when a real photograph or logo was required. Agent action: supply a non-monogram image or set permitMonogram=true on the read endpoint if a monogram is acceptable for the use case. */
         "image_monogram",
+        /** Image upload could not be decoded (corrupt file, unsupported format). Agent action: supply a valid PNG/JPEG/WebP; retrying the same bytes will not pass. */
         "image_unreadable",
+        /** Image processing pipeline (resize/encode/hash) threw an unexpected error. Agent action: retry once; persistent failure indicates an infra issue. */
         "image_processing_error",
+        /** Logo/photo upload was rejected because the server-side brand-match vision check found it does not depict the target's own brand (a generic favicon, a parent/provider/acquirer mark, an OpenGraph/banner/social card, or an unrelated image). Agent action: supply the target entity's OWN brand mark and re-run; retrying the same image, or any generic/og/banner/parent asset, will not pass. */
         "image_brand_mismatch",
+        /** An outbound fetch from an external target site (robots.txt, sitemap, page, or logo or thumbnail image) failed after retries or with the breaker open. Agent action: the failure belongs to the target; crawl jobs may fall back to rendered extraction; do not retry immediately. */
         "web_crawl_fetch_failed",
+        /** A crawl-run request named an entity or person that has no current primary website URL. Agent action: add or activate the owner's website URL, then resubmit; retrying the unchanged request cannot succeed. */
+        "primary_website_missing",
+        /** RSS news-ingest feed fetch failed after retries or with the breaker open. Agent action: inspect the configured feed URL and upstream status; do not retry the enqueue immediately. */
         "news_rss_feed_fetch_failed",
+        /** RSS news-ingest article page fetch failed after retries or with the breaker open. Agent action: inspect the source article URL and upstream status; the ingest job may skip that article. */
         "news_rss_article_fetch_failed",
+        /** Cloudflare R2 object fetch failed during a read operation. Agent action: retry once with backoff; persistent failure indicates R2 outage or asset deletion. */
         "r2_fetch_failed",
+        /** Cloudflare R2 object delete failed during a cleanup operation. Agent action: surface; retrying may produce duplicate-delete errors. */
         "r2_delete_failed",
+        /** Cloudflare R2 object upload failed during a write operation. Agent action: retry once with the same payload; persistent failure indicates R2 outage. */
         "r2_upload_failed",
+        /** Stored source-document raw bytes could not be served: the row's inline-or-R2 raw authority is incomplete or failed digest verification. Agent action: surface; the stored authority needs operator reconciliation before this body can be read. */
         "source_document_body_unavailable",
+        /** A source-document capture stopped before retaining a provider response over this service's configured byte limit. Agent action: this is a designed containment boundary, not a provider outage or a service defect; do not retry the same request expecting a different outcome. */
         "source_document_capture_limit_exceeded",
+        /** News similarity cannot run because the target embedding is unavailable or live similarity capacity is full. Agent action: surface the 503 and retry later; this endpoint does not fall back to lexical ranking. */
         "news_similarity_embedding_unavailable",
+        /** Search provider (e.g., SerpAPI) is not configured for this environment. Agent action: stop; admin/ops must configure the provider key before this endpoint will succeed. */
         "search_provider_not_configured",
+        /** Search provider call failed. Agent action: surface; provider outages affect search endpoints only. */
         "search_provider_error",
+        /** SEC EDGAR lookup failed (ticker catalog or company submissions). Agent action: surface; SEC outages or rate limiting affect the public-company preview endpoint only. */
         "sec_edgar_fetch_failed",
+        /** GitHub repository fetch failed (account, listing, or single repo). Agent action: surface; GitHub outages or rate limiting affect github-repo sync endpoints only. */
         "github_fetch_failed",
+        /** LLM inference provider call failed. Agent action: retry once with backoff; persistent failure indicates provider outage or invalid profile config. */
         "INFERENCE_PROVIDER_ERROR",
+        /** LLM inference provider call failed. Agent action: retry once with backoff; persistent failure indicates provider outage or invalid profile config. */
+        "inference_provider_error",
+        /** LLM inference provider returned an empty response body. Agent action: retry once; persistent empty responses indicate prompt or provider misconfiguration. */
         "INFERENCE_PROVIDER_RESPONSE_EMPTY",
+        /** LLM inference provider returned an empty response body. Agent action: retry once; persistent empty responses indicate prompt or provider misconfiguration. */
+        "inference_provider_response_empty",
+        /** LLM inference provider returned a response that failed JSON parsing. Agent action: surface; the prompt or response schema may need adjustment. */
         "INFERENCE_PROVIDER_INVALID_JSON",
+        /** LLM inference provider returned a response that failed JSON parsing. Agent action: surface; the prompt or response schema may need adjustment. */
+        "inference_provider_invalid_json",
+        /** Inference profile catalog is missing or empty. Agent action: stop; admin/ops must configure inference profiles before this endpoint will succeed. */
         "INFERENCE_PROFILES_MISSING",
+        /** Inference profile catalog is missing or empty. Agent action: stop; admin/ops must configure inference profiles before this endpoint will succeed. */
+        "inference_profiles_missing",
+        /** Inference profile is configured but its API key is missing from secret storage. Agent action: stop; admin/ops must populate the API key in secret storage. */
         "INFERENCE_PROFILE_API_KEY_MISSING",
+        /** Inference profile is configured but its API key is missing from secret storage. Agent action: stop; admin/ops must populate the API key in secret storage. */
+        "inference_profile_api_key_missing",
     ])
         .nullish(),
     conflictingRecord: CurrentSlugOwnerSchema.nullish(),
@@ -62,7 +137,9 @@ const ProblemDetailSchemaDefinition = z.object({
     hammingDistance: z.number().int().nullish(),
     hint: z.string().nullish(),
     instance: z.string().optional(),
+    /** Cap the limitType meter allows for its current period. */
     limit: z.number().int().nullish(),
+    /** Which meter refused the request; names what limit/used/remaining count. */
     limitType: z
         .enum([
         "FORM",
@@ -74,6 +151,7 @@ const ProblemDetailSchemaDefinition = z.object({
         "WEB_SEARCH",
         "NATURAL_SEARCH",
         "BILLING_ALLOWANCE",
+        "BILLING_ADDITIONAL_USAGE",
         "CLERK_PUBLIC_ADMISSION",
         "CLERK_SCRIPT_LOAD",
         "ORIGIN_DETAIL",
@@ -86,10 +164,13 @@ const ProblemDetailSchemaDefinition = z.object({
     parseError: z.string().nullish(),
     path: z.string().nullish(),
     properties: z.record(z.string(), JsonValueSchema).optional(),
+    /** Cap minus used for the limitType meter, never negative. */
     remaining: z.number().int().nullish(),
     requiredRole: z.string().nullish(),
+    /** When the limitType meter refills and the request can succeed again. */
     resetAt: z.iso.datetime({ offset: true }).nullish(),
     resolution: ProblemResolutionSchema.nullish(),
+    /** Seconds to wait before the same request can succeed. A BILLING_ALLOWANCE meter resets at the UTC month boundary, so this reaches weeks: read limitType before treating it as a burst backoff. */
     retryAfterSeconds: z.number().int().nullish(),
     spanId: z.string().nullish(),
     status: z.int().optional(),
@@ -100,9 +181,11 @@ const ProblemDetailSchemaDefinition = z.object({
     traceId: z.string().nullish(),
     type: z.string().optional(),
     unknownParameters: z.array(z.string()).nullish(),
+    /** Requests already charged against the limitType meter this period. */
     used: z.number().int().nullish(),
     validParameters: z.array(z.string()).nullish(),
     value: z.string().nullish(),
+    /** Length of a rolling throttle window; absent for period meters. */
     windowSeconds: z.number().int().nullish(),
 });
 /**

package/dist/identification/candidate.d.ts

@@ -0,0 +1,42 @@
+import { z } from "zod/v4";
+/**
+ * One existing record considered as the subject.
+ *
+ * @openapiSchema IdentificationCandidate
+ * @endpoint POST /v1/entities/lookup
+ * @endpoint POST /v1/lookup
+ * @endpoint POST /v1/people/lookup
+ * @usedBySchema IdentificationSchema
+ * @contractShape identification.candidate
+ * @contractRole canonical
+ */
+export declare const IdentificationCandidateSchema: z.ZodObject<{
+    owner: z.ZodObject<{
+        entityId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+        personId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+    }, z.core.$strip>;
+    probability: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    record: z.ZodType<{
+        externalId?: string | null | undefined;
+        id: string;
+        name?: string | null | undefined;
+        operatingStatus?: string | null | undefined;
+        publicPath?: string | null | undefined;
+        reason: string[];
+        score: number;
+        slug?: string | null | undefined;
+        typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
+    }, unknown, z.core.$ZodTypeInternals<{
+        externalId?: string | null | undefined;
+        id: string;
+        name?: string | null | undefined;
+        operatingStatus?: string | null | undefined;
+        publicPath?: string | null | undefined;
+        reason: string[];
+        score: number;
+        slug?: string | null | undefined;
+        typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
+    }, unknown>>;
+}, z.core.$strip>;
+export type IdentificationCandidate = z.infer<typeof IdentificationCandidateSchema>;
+//# sourceMappingURL=candidate.d.ts.map

package/dist/identification/candidate.js

@@ -0,0 +1,24 @@
+// 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
+import { z } from "zod/v4";
+import { EntityPersonOwnerSchema } from "../entity/person-owner.js";
+import { SearchDuplicateCandidateScoreSchema } from "../search/duplicate-candidate-score.js";
+/**
+ * One existing record considered as the subject.
+ *
+ * @openapiSchema IdentificationCandidate
+ * @endpoint POST /v1/entities/lookup
+ * @endpoint POST /v1/lookup
+ * @endpoint POST /v1/people/lookup
+ * @usedBySchema IdentificationSchema
+ * @contractShape identification.candidate
+ * @contractRole canonical
+ */
+export const IdentificationCandidateSchema = z.object({
+    /** Whether the record is a company (entityId) or a person (personId); read it with entities get --entity-id or people get --person-id. */
+    owner: EntityPersonOwnerSchema,
+    /** Decision-model probability, 0 to 1, that this record is the subject; absent when the answer came from URL proof or the model did not judge this record. */
+    probability: z.number().nullish(),
+    /** The record with its duplicate-check score and reasons; score 0 with no reason means only vector similarity proposed it. */
+    record: SearchDuplicateCandidateScoreSchema,
+});
+//# sourceMappingURL=candidate.js.map