> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.aventure.vc/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.aventure.vc/_mcp/server.

# Refine the company filter options

POST https://api.aventure.vc/v1/entities/filters/refine
Content-Type: application/json

Return filter metadata scoped by current filters. Each filter entry reports choiceOptionTotal and choiceOptionTruncated so CLI and MCP callers can tell when the displayed choiceOption list is only the top scoped subset. Use the filter search endpoint with the same scopeFilter to look up values not shown in the refine response.

Reference: https://docs.aventure.vc/api-reference/entity-filters/refine-entity-filters

## Authentication

- `Authorization` header (bearer token, required) — User bearer token: Clerk session JWT, Clerk OAuth access token, or Clerk API key

## Request

### Body (application/json)

This endpoint expects an EntityFilter.

- `acceleratorBrand` (list of string, optional) — Accelerator brand or operator name.
- `acceleratorCohort` (list of string, optional) — Accelerator batch or cohort label.
- `acceleratorName` (list of string, optional) — Specific accelerator program name.
- `acceleratorStatus` (list of string, optional) — Accelerator participation status.
- `affinity` (list of string, optional) — Affinity provider organization names accepted by the companies list filter. Affinity rows are member -> provider; use provider names here, not member names.
- `employeeCountRange` (list of IntRange, optional) — Inclusive reported employee-count ranges, in employees.
- `entityId` (list of string, optional) — Restrict results to specific entity IDs.
- `entityName` (list of string, optional) — Exact normalized match against entity brand or legal names.
- `featured` (boolean, optional, nullable) — Filter by featured status.
- `fundraiseActivity` (EntityFundraiseFilterCriteria, optional) — Fundraise activity
- `hasFundraising` (boolean, optional, nullable) — Filter to entities with fundraise activity.
- `headquartersCity` (list of string, optional) — Headquarters city values.
- `headquartersCountry` (list of string, optional) — Headquarters country values.
- `headquartersState` (list of string, optional) — Headquarters state or region values.
- `industry` (list of string, optional) — Industry classification values.
- `letter` (string, optional, nullable) — First letter of the display name.
- `location` (list of string, optional) — Geographic classification values.
- `logoOption` (EntityFilterLogoOption, optional) — Logo sort priority.
- `mainProduct` (list of string, optional) — Main product classification values.
- `operatingStatus` (list of enum, optional) — Operating states to include; omit to include every state.
  - Allowed values: `Operating`, `Acquired`, `Acquired Subsidiary`, `Closed`, `Closed (Acquihire)`, `Inactive`
- `person` (list of string, optional) — Associated person, matched by name.
- `portfolioHeadquartersCity` (list of string, optional) — Portfolio-company headquarters city values.
- `portfolioHeadquartersCountry` (list of string, optional) — Portfolio-company headquarters country values.
- `portfolioHeadquartersState` (list of string, optional) — Portfolio-company headquarters state or region values.
- `qualityGate` (enum, optional) — Named server-owned list quality gate.
  - Allowed values: `NONE`, `COMPANY_LISTING_READY`
- `slug` (list of string, optional) — Restrict results to entity slugs.
- `stage` (list of string, optional) — Investment stage classification values.
- `suppressNonOperating` (boolean, optional, nullable) — Suppress entities with terminal operating status.
- `suppressZeroTotalRaised` (boolean, optional, nullable) — Suppress entities whose total raised is zero.
- `tag` (list of string, optional) — General classification tag values.
- `textSearch` (string, optional, nullable) — Non-blank keyword/full-text search term. Use natural-search for plain-English or multi-constraint company requests.
- `typeCustomer` (list of string, optional) — Customer-type classification values.
- `typeModel` (list of string, optional) — Business-model classification values.
- `typeOwnership` (list of string, optional) — Ownership-model classification values.
- `typeRecord` (list of enum, optional) — Entity type filter. Organization expands to Company, Investment Firm, Nonprofit, and Government; omit to include every entity type.
  - Allowed values: `Company`, `Investment Firm`, `Fund`, `Nonprofit`, `Government`, `Organization`, `Business Line`, `Product`, `Service`
- `typeRevenue` (list of string, optional) — Revenue-model classification values.
- `typeTechnologyUsed` (list of string, optional) — Technology-used classification values.
- `url` (string, optional, nullable) — Current URL to match by normalized host and path.
- `urlDomain` (string, optional, nullable) — Current root domain to match when urlMatchMode=domain.
- `urlMatchMode` (enum, optional) — URL matching mode: hostPath uses host and path; domain uses the root domain.
  - Allowed values: `hostPath`, `domain`
- `urlType` (enum, optional, nullable) — Restrict URL matching to one URL type.
  - Allowed values: `website`, `linkedin`, `twitter`, `github`, `facebook`, `instagram`, `tiktok`, `youtube`, `subreddit`, `forum`, `documentation`, `support`, `statuspage`, `changelog`, `roadmap`, `discord`, `crunchbase`, `wellfound`, `angellist`, `glassdoor`, `theorg`, `ycombinator`, `wikipedia`, `pitchbook`, `morningstar`, `bloomberg`, `nyse`, `nasdaq`, `g2`, `producthunt`, `trustpilot`, `alternativeto`, `gartnerpeerinsights`, `getapp`, `sourceforge`, `appstore`, `googleplay`, `capterra`, `trustradius`, `hubspotmarketplace`, `slackappdirectory`, `awsmarketplace`, `salesforceappexchange`, `chromewebstore`, `vscodemarketplace`, `npm`, `pypi`, `maven`, `dockerhub`, `homebrew`, `crates`, `huggingface`
- `yearFoundedRange` (list of IntRange, optional) — Inclusive founding-year ranges, in calendar years.

## Response

### 200

OK

- `filter` (list of EntityFilterEntry, required) — Canonical filter entries for the active entity scope.
- `meta` (RefinementMeta, required) — Pagination and degradation state for this refinement.

## Errors

### 400 Bad Request Error

Bad Request

- `allowanceType` (enum, optional) — Which monthly allowance a BILLING_ALLOWANCE refusal exhausted.
  - Allowed values: `NEW_COMPANY`, `UPDATE`, `NEW_PERSON`, `UPDATE_PERSON`, `ENTITY_VIEW`, `PERSON_VIEW`
- `circuitBreaker` (string, optional, nullable)
- `code` (enum, optional) — 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.
  - Allowed values: `not_authorized`, `rateLimited`, `rate_limited`, `subscription_required`, `subscription_canceled`, `subscription_past_due`, `subscription_paused`, `billing_allowance_exhausted`, `billing_additional_usage_cap_reached`, `origin_detail_capacity`, `origin_detail_shutdown`, `suspectedShellStrip`, `suspected_shell_strip`, `url_surface_misclassification`, `JOBRUNR_DISABLED`, `jobrunr_disabled`, `JOBRUNR_STORAGE_UNAVAILABLE`, `jobrunr_storage_unavailable`, `rbac_lookup_unavailable`, `GEOCODE_PROVIDER_ERROR`, `geocode_provider_error`, `image_blocklist_match`, `image_monochrome`, `image_too_small`, `image_wrong_aspect`, `image_monogram`, `image_unreadable`, `image_processing_error`, `image_brand_mismatch`, `web_crawl_fetch_failed`, `primary_website_missing`, `news_rss_feed_fetch_failed`, `news_rss_article_fetch_failed`, `r2_fetch_failed`, `r2_delete_failed`, `r2_upload_failed`, `source_document_body_unavailable`, `source_document_capture_limit_exceeded`, `news_similarity_embedding_unavailable`, `search_provider_not_configured`, `search_provider_error`, `sec_edgar_fetch_failed`, `github_fetch_failed`, `INFERENCE_PROVIDER_ERROR`, `inference_provider_error`, `INFERENCE_PROVIDER_RESPONSE_EMPTY`, `inference_provider_response_empty`, `INFERENCE_PROVIDER_INVALID_JSON`, `inference_provider_invalid_json`, `INFERENCE_PROFILES_MISSING`, `inference_profiles_missing`, `INFERENCE_PROFILE_API_KEY_MISSING`, `inference_profile_api_key_missing`
- `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner
- `detail` (string, optional)
- `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. Create duplicate reviews and deterministic lookup ambiguity return DuplicateCreateReview; the returned candidates are the decision surface for update, create-with-override, or block. score/threshold rank review priority and are not proof that the requested record is absent.
- `error` (map from string to string, optional, nullable)
- `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path
- `feId` (string, optional, nullable)
- `field` (string, optional, nullable)
- `hammingDistance` (long, optional, nullable)
- `hint` (string, optional, nullable)
- `instance` (string, optional)
- `limit` (long, optional, nullable) — Cap the limitType meter allows for its current period.
- `limitType` (enum, optional) — Which meter refused the request; names what limit/used/remaining count.
  - Allowed values: `FORM`, `GLOBAL`, `SUBNET`, `IP`, `UNKNOWN`, `RESILIENCE4J`, `WEB_SEARCH`, `NATURAL_SEARCH`, `BILLING_ALLOWANCE`, `BILLING_ADDITIONAL_USAGE`, `CLERK_PUBLIC_ADMISSION`, `CLERK_SCRIPT_LOAD`, `ORIGIN_DETAIL`, `INFERENCE_PROVIDER`
- `matchedBlocklistKey` (string, optional, nullable)
- `mediaType` (string, optional, nullable)
- `moderationReason` (string, optional, nullable)
- `parseError` (string, optional, nullable)
- `path` (string, optional, nullable)
- `properties` (map from string to any, optional)
- `remaining` (long, optional, nullable) — Cap minus used for the limitType meter, never negative.
- `requiredRole` (string, optional, nullable)
- `resetAt` (datetime, optional, nullable) — When the limitType meter refills and the request can succeed again.
- `resolution` (ProblemResolution, optional, nullable) — Machine-readable next action for an aVenture ProblemDetail. For reviewCandidates, inspect ProblemDetail.details candidates and decide update, create-with-override, or block from those returned records.
- `retryAfterSeconds` (long, optional, nullable) — 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.
- `spanId` (string, optional, nullable)
- `status` (integer, optional)
- `suggestion` (string, optional, nullable)
- `suggestions` (map from string to string, optional, nullable)
- `suspectedFragment` (string, optional, nullable)
- `title` (string, optional)
- `traceId` (string, optional, nullable)
- `type` (string, optional)
- `unknownParameters` (list of string, optional, nullable)
- `used` (long, optional, nullable) — Requests already charged against the limitType meter this period.
- `validParameters` (list of string, optional, nullable)
- `value` (string, optional, nullable)
- `windowSeconds` (long, optional, nullable) — Length of a rolling throttle window; absent for period meters.

### 401 Unauthorized Error

Unauthorized

- `allowanceType` (enum, optional) — Which monthly allowance a BILLING_ALLOWANCE refusal exhausted.
  - Allowed values: `NEW_COMPANY`, `UPDATE`, `NEW_PERSON`, `UPDATE_PERSON`, `ENTITY_VIEW`, `PERSON_VIEW`
- `circuitBreaker` (string, optional, nullable)
- `code` (enum, optional) — 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.
  - Allowed values: `not_authorized`, `rateLimited`, `rate_limited`, `subscription_required`, `subscription_canceled`, `subscription_past_due`, `subscription_paused`, `billing_allowance_exhausted`, `billing_additional_usage_cap_reached`, `origin_detail_capacity`, `origin_detail_shutdown`, `suspectedShellStrip`, `suspected_shell_strip`, `url_surface_misclassification`, `JOBRUNR_DISABLED`, `jobrunr_disabled`, `JOBRUNR_STORAGE_UNAVAILABLE`, `jobrunr_storage_unavailable`, `rbac_lookup_unavailable`, `GEOCODE_PROVIDER_ERROR`, `geocode_provider_error`, `image_blocklist_match`, `image_monochrome`, `image_too_small`, `image_wrong_aspect`, `image_monogram`, `image_unreadable`, `image_processing_error`, `image_brand_mismatch`, `web_crawl_fetch_failed`, `primary_website_missing`, `news_rss_feed_fetch_failed`, `news_rss_article_fetch_failed`, `r2_fetch_failed`, `r2_delete_failed`, `r2_upload_failed`, `source_document_body_unavailable`, `source_document_capture_limit_exceeded`, `news_similarity_embedding_unavailable`, `search_provider_not_configured`, `search_provider_error`, `sec_edgar_fetch_failed`, `github_fetch_failed`, `INFERENCE_PROVIDER_ERROR`, `inference_provider_error`, `INFERENCE_PROVIDER_RESPONSE_EMPTY`, `inference_provider_response_empty`, `INFERENCE_PROVIDER_INVALID_JSON`, `inference_provider_invalid_json`, `INFERENCE_PROFILES_MISSING`, `inference_profiles_missing`, `INFERENCE_PROFILE_API_KEY_MISSING`, `inference_profile_api_key_missing`
- `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner
- `detail` (string, optional)
- `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. Create duplicate reviews and deterministic lookup ambiguity return DuplicateCreateReview; the returned candidates are the decision surface for update, create-with-override, or block. score/threshold rank review priority and are not proof that the requested record is absent.
- `error` (map from string to string, optional, nullable)
- `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path
- `feId` (string, optional, nullable)
- `field` (string, optional, nullable)
- `hammingDistance` (long, optional, nullable)
- `hint` (string, optional, nullable)
- `instance` (string, optional)
- `limit` (long, optional, nullable) — Cap the limitType meter allows for its current period.
- `limitType` (enum, optional) — Which meter refused the request; names what limit/used/remaining count.
  - Allowed values: `FORM`, `GLOBAL`, `SUBNET`, `IP`, `UNKNOWN`, `RESILIENCE4J`, `WEB_SEARCH`, `NATURAL_SEARCH`, `BILLING_ALLOWANCE`, `BILLING_ADDITIONAL_USAGE`, `CLERK_PUBLIC_ADMISSION`, `CLERK_SCRIPT_LOAD`, `ORIGIN_DETAIL`, `INFERENCE_PROVIDER`
- `matchedBlocklistKey` (string, optional, nullable)
- `mediaType` (string, optional, nullable)
- `moderationReason` (string, optional, nullable)
- `parseError` (string, optional, nullable)
- `path` (string, optional, nullable)
- `properties` (map from string to any, optional)
- `remaining` (long, optional, nullable) — Cap minus used for the limitType meter, never negative.
- `requiredRole` (string, optional, nullable)
- `resetAt` (datetime, optional, nullable) — When the limitType meter refills and the request can succeed again.
- `resolution` (ProblemResolution, optional, nullable) — Machine-readable next action for an aVenture ProblemDetail. For reviewCandidates, inspect ProblemDetail.details candidates and decide update, create-with-override, or block from those returned records.
- `retryAfterSeconds` (long, optional, nullable) — 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.
- `spanId` (string, optional, nullable)
- `status` (integer, optional)
- `suggestion` (string, optional, nullable)
- `suggestions` (map from string to string, optional, nullable)
- `suspectedFragment` (string, optional, nullable)
- `title` (string, optional)
- `traceId` (string, optional, nullable)
- `type` (string, optional)
- `unknownParameters` (list of string, optional, nullable)
- `used` (long, optional, nullable) — Requests already charged against the limitType meter this period.
- `validParameters` (list of string, optional, nullable)
- `value` (string, optional, nullable)
- `windowSeconds` (long, optional, nullable) — Length of a rolling throttle window; absent for period meters.

### 403 Forbidden Error

Forbidden

- `allowanceType` (enum, optional) — Which monthly allowance a BILLING_ALLOWANCE refusal exhausted.
  - Allowed values: `NEW_COMPANY`, `UPDATE`, `NEW_PERSON`, `UPDATE_PERSON`, `ENTITY_VIEW`, `PERSON_VIEW`
- `circuitBreaker` (string, optional, nullable)
- `code` (enum, optional) — 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.
  - Allowed values: `not_authorized`, `rateLimited`, `rate_limited`, `subscription_required`, `subscription_canceled`, `subscription_past_due`, `subscription_paused`, `billing_allowance_exhausted`, `billing_additional_usage_cap_reached`, `origin_detail_capacity`, `origin_detail_shutdown`, `suspectedShellStrip`, `suspected_shell_strip`, `url_surface_misclassification`, `JOBRUNR_DISABLED`, `jobrunr_disabled`, `JOBRUNR_STORAGE_UNAVAILABLE`, `jobrunr_storage_unavailable`, `rbac_lookup_unavailable`, `GEOCODE_PROVIDER_ERROR`, `geocode_provider_error`, `image_blocklist_match`, `image_monochrome`, `image_too_small`, `image_wrong_aspect`, `image_monogram`, `image_unreadable`, `image_processing_error`, `image_brand_mismatch`, `web_crawl_fetch_failed`, `primary_website_missing`, `news_rss_feed_fetch_failed`, `news_rss_article_fetch_failed`, `r2_fetch_failed`, `r2_delete_failed`, `r2_upload_failed`, `source_document_body_unavailable`, `source_document_capture_limit_exceeded`, `news_similarity_embedding_unavailable`, `search_provider_not_configured`, `search_provider_error`, `sec_edgar_fetch_failed`, `github_fetch_failed`, `INFERENCE_PROVIDER_ERROR`, `inference_provider_error`, `INFERENCE_PROVIDER_RESPONSE_EMPTY`, `inference_provider_response_empty`, `INFERENCE_PROVIDER_INVALID_JSON`, `inference_provider_invalid_json`, `INFERENCE_PROFILES_MISSING`, `inference_profiles_missing`, `INFERENCE_PROFILE_API_KEY_MISSING`, `inference_profile_api_key_missing`
- `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner
- `detail` (string, optional)
- `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. Create duplicate reviews and deterministic lookup ambiguity return DuplicateCreateReview; the returned candidates are the decision surface for update, create-with-override, or block. score/threshold rank review priority and are not proof that the requested record is absent.
- `error` (map from string to string, optional, nullable)
- `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path
- `feId` (string, optional, nullable)
- `field` (string, optional, nullable)
- `hammingDistance` (long, optional, nullable)
- `hint` (string, optional, nullable)
- `instance` (string, optional)
- `limit` (long, optional, nullable) — Cap the limitType meter allows for its current period.
- `limitType` (enum, optional) — Which meter refused the request; names what limit/used/remaining count.
  - Allowed values: `FORM`, `GLOBAL`, `SUBNET`, `IP`, `UNKNOWN`, `RESILIENCE4J`, `WEB_SEARCH`, `NATURAL_SEARCH`, `BILLING_ALLOWANCE`, `BILLING_ADDITIONAL_USAGE`, `CLERK_PUBLIC_ADMISSION`, `CLERK_SCRIPT_LOAD`, `ORIGIN_DETAIL`, `INFERENCE_PROVIDER`
- `matchedBlocklistKey` (string, optional, nullable)
- `mediaType` (string, optional, nullable)
- `moderationReason` (string, optional, nullable)
- `parseError` (string, optional, nullable)
- `path` (string, optional, nullable)
- `properties` (map from string to any, optional)
- `remaining` (long, optional, nullable) — Cap minus used for the limitType meter, never negative.
- `requiredRole` (string, optional, nullable)
- `resetAt` (datetime, optional, nullable) — When the limitType meter refills and the request can succeed again.
- `resolution` (ProblemResolution, optional, nullable) — Machine-readable next action for an aVenture ProblemDetail. For reviewCandidates, inspect ProblemDetail.details candidates and decide update, create-with-override, or block from those returned records.
- `retryAfterSeconds` (long, optional, nullable) — 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.
- `spanId` (string, optional, nullable)
- `status` (integer, optional)
- `suggestion` (string, optional, nullable)
- `suggestions` (map from string to string, optional, nullable)
- `suspectedFragment` (string, optional, nullable)
- `title` (string, optional)
- `traceId` (string, optional, nullable)
- `type` (string, optional)
- `unknownParameters` (list of string, optional, nullable)
- `used` (long, optional, nullable) — Requests already charged against the limitType meter this period.
- `validParameters` (list of string, optional, nullable)
- `value` (string, optional, nullable)
- `windowSeconds` (long, optional, nullable) — Length of a rolling throttle window; absent for period meters.

### 406 Not Acceptable Error

Not Acceptable

- `allowanceType` (enum, optional) — Which monthly allowance a BILLING_ALLOWANCE refusal exhausted.
  - Allowed values: `NEW_COMPANY`, `UPDATE`, `NEW_PERSON`, `UPDATE_PERSON`, `ENTITY_VIEW`, `PERSON_VIEW`
- `circuitBreaker` (string, optional, nullable)
- `code` (enum, optional) — 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.
  - Allowed values: `not_authorized`, `rateLimited`, `rate_limited`, `subscription_required`, `subscription_canceled`, `subscription_past_due`, `subscription_paused`, `billing_allowance_exhausted`, `billing_additional_usage_cap_reached`, `origin_detail_capacity`, `origin_detail_shutdown`, `suspectedShellStrip`, `suspected_shell_strip`, `url_surface_misclassification`, `JOBRUNR_DISABLED`, `jobrunr_disabled`, `JOBRUNR_STORAGE_UNAVAILABLE`, `jobrunr_storage_unavailable`, `rbac_lookup_unavailable`, `GEOCODE_PROVIDER_ERROR`, `geocode_provider_error`, `image_blocklist_match`, `image_monochrome`, `image_too_small`, `image_wrong_aspect`, `image_monogram`, `image_unreadable`, `image_processing_error`, `image_brand_mismatch`, `web_crawl_fetch_failed`, `primary_website_missing`, `news_rss_feed_fetch_failed`, `news_rss_article_fetch_failed`, `r2_fetch_failed`, `r2_delete_failed`, `r2_upload_failed`, `source_document_body_unavailable`, `source_document_capture_limit_exceeded`, `news_similarity_embedding_unavailable`, `search_provider_not_configured`, `search_provider_error`, `sec_edgar_fetch_failed`, `github_fetch_failed`, `INFERENCE_PROVIDER_ERROR`, `inference_provider_error`, `INFERENCE_PROVIDER_RESPONSE_EMPTY`, `inference_provider_response_empty`, `INFERENCE_PROVIDER_INVALID_JSON`, `inference_provider_invalid_json`, `INFERENCE_PROFILES_MISSING`, `inference_profiles_missing`, `INFERENCE_PROFILE_API_KEY_MISSING`, `inference_profile_api_key_missing`
- `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner
- `detail` (string, optional)
- `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. Create duplicate reviews and deterministic lookup ambiguity return DuplicateCreateReview; the returned candidates are the decision surface for update, create-with-override, or block. score/threshold rank review priority and are not proof that the requested record is absent.
- `error` (map from string to string, optional, nullable)
- `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path
- `feId` (string, optional, nullable)
- `field` (string, optional, nullable)
- `hammingDistance` (long, optional, nullable)
- `hint` (string, optional, nullable)
- `instance` (string, optional)
- `limit` (long, optional, nullable) — Cap the limitType meter allows for its current period.
- `limitType` (enum, optional) — Which meter refused the request; names what limit/used/remaining count.
  - Allowed values: `FORM`, `GLOBAL`, `SUBNET`, `IP`, `UNKNOWN`, `RESILIENCE4J`, `WEB_SEARCH`, `NATURAL_SEARCH`, `BILLING_ALLOWANCE`, `BILLING_ADDITIONAL_USAGE`, `CLERK_PUBLIC_ADMISSION`, `CLERK_SCRIPT_LOAD`, `ORIGIN_DETAIL`, `INFERENCE_PROVIDER`
- `matchedBlocklistKey` (string, optional, nullable)
- `mediaType` (string, optional, nullable)
- `moderationReason` (string, optional, nullable)
- `parseError` (string, optional, nullable)
- `path` (string, optional, nullable)
- `properties` (map from string to any, optional)
- `remaining` (long, optional, nullable) — Cap minus used for the limitType meter, never negative.
- `requiredRole` (string, optional, nullable)
- `resetAt` (datetime, optional, nullable) — When the limitType meter refills and the request can succeed again.
- `resolution` (ProblemResolution, optional, nullable) — Machine-readable next action for an aVenture ProblemDetail. For reviewCandidates, inspect ProblemDetail.details candidates and decide update, create-with-override, or block from those returned records.
- `retryAfterSeconds` (long, optional, nullable) — 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.
- `spanId` (string, optional, nullable)
- `status` (integer, optional)
- `suggestion` (string, optional, nullable)
- `suggestions` (map from string to string, optional, nullable)
- `suspectedFragment` (string, optional, nullable)
- `title` (string, optional)
- `traceId` (string, optional, nullable)
- `type` (string, optional)
- `unknownParameters` (list of string, optional, nullable)
- `used` (long, optional, nullable) — Requests already charged against the limitType meter this period.
- `validParameters` (list of string, optional, nullable)
- `value` (string, optional, nullable)
- `windowSeconds` (long, optional, nullable) — Length of a rolling throttle window; absent for period meters.

### 409 Conflict Error

Conflict

- `allowanceType` (enum, optional) — Which monthly allowance a BILLING_ALLOWANCE refusal exhausted.
  - Allowed values: `NEW_COMPANY`, `UPDATE`, `NEW_PERSON`, `UPDATE_PERSON`, `ENTITY_VIEW`, `PERSON_VIEW`
- `circuitBreaker` (string, optional, nullable)
- `code` (enum, optional) — 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.
  - Allowed values: `not_authorized`, `rateLimited`, `rate_limited`, `subscription_required`, `subscription_canceled`, `subscription_past_due`, `subscription_paused`, `billing_allowance_exhausted`, `billing_additional_usage_cap_reached`, `origin_detail_capacity`, `origin_detail_shutdown`, `suspectedShellStrip`, `suspected_shell_strip`, `url_surface_misclassification`, `JOBRUNR_DISABLED`, `jobrunr_disabled`, `JOBRUNR_STORAGE_UNAVAILABLE`, `jobrunr_storage_unavailable`, `rbac_lookup_unavailable`, `GEOCODE_PROVIDER_ERROR`, `geocode_provider_error`, `image_blocklist_match`, `image_monochrome`, `image_too_small`, `image_wrong_aspect`, `image_monogram`, `image_unreadable`, `image_processing_error`, `image_brand_mismatch`, `web_crawl_fetch_failed`, `primary_website_missing`, `news_rss_feed_fetch_failed`, `news_rss_article_fetch_failed`, `r2_fetch_failed`, `r2_delete_failed`, `r2_upload_failed`, `source_document_body_unavailable`, `source_document_capture_limit_exceeded`, `news_similarity_embedding_unavailable`, `search_provider_not_configured`, `search_provider_error`, `sec_edgar_fetch_failed`, `github_fetch_failed`, `INFERENCE_PROVIDER_ERROR`, `inference_provider_error`, `INFERENCE_PROVIDER_RESPONSE_EMPTY`, `inference_provider_response_empty`, `INFERENCE_PROVIDER_INVALID_JSON`, `inference_provider_invalid_json`, `INFERENCE_PROFILES_MISSING`, `inference_profiles_missing`, `INFERENCE_PROFILE_API_KEY_MISSING`, `inference_profile_api_key_missing`
- `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner
- `detail` (string, optional)
- `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. Create duplicate reviews and deterministic lookup ambiguity return DuplicateCreateReview; the returned candidates are the decision surface for update, create-with-override, or block. score/threshold rank review priority and are not proof that the requested record is absent.
- `error` (map from string to string, optional, nullable)
- `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path
- `feId` (string, optional, nullable)
- `field` (string, optional, nullable)
- `hammingDistance` (long, optional, nullable)
- `hint` (string, optional, nullable)
- `instance` (string, optional)
- `limit` (long, optional, nullable) — Cap the limitType meter allows for its current period.
- `limitType` (enum, optional) — Which meter refused the request; names what limit/used/remaining count.
  - Allowed values: `FORM`, `GLOBAL`, `SUBNET`, `IP`, `UNKNOWN`, `RESILIENCE4J`, `WEB_SEARCH`, `NATURAL_SEARCH`, `BILLING_ALLOWANCE`, `BILLING_ADDITIONAL_USAGE`, `CLERK_PUBLIC_ADMISSION`, `CLERK_SCRIPT_LOAD`, `ORIGIN_DETAIL`, `INFERENCE_PROVIDER`
- `matchedBlocklistKey` (string, optional, nullable)
- `mediaType` (string, optional, nullable)
- `moderationReason` (string, optional, nullable)
- `parseError` (string, optional, nullable)
- `path` (string, optional, nullable)
- `properties` (map from string to any, optional)
- `remaining` (long, optional, nullable) — Cap minus used for the limitType meter, never negative.
- `requiredRole` (string, optional, nullable)
- `resetAt` (datetime, optional, nullable) — When the limitType meter refills and the request can succeed again.
- `resolution` (ProblemResolution, optional, nullable) — Machine-readable next action for an aVenture ProblemDetail. For reviewCandidates, inspect ProblemDetail.details candidates and decide update, create-with-override, or block from those returned records.
- `retryAfterSeconds` (long, optional, nullable) — 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.
- `spanId` (string, optional, nullable)
- `status` (integer, optional)
- `suggestion` (string, optional, nullable)
- `suggestions` (map from string to string, optional, nullable)
- `suspectedFragment` (string, optional, nullable)
- `title` (string, optional)
- `traceId` (string, optional, nullable)
- `type` (string, optional)
- `unknownParameters` (list of string, optional, nullable)
- `used` (long, optional, nullable) — Requests already charged against the limitType meter this period.
- `validParameters` (list of string, optional, nullable)
- `value` (string, optional, nullable)
- `windowSeconds` (long, optional, nullable) — Length of a rolling throttle window; absent for period meters.

### 415 Unsupported Media Type Error

Unsupported Media Type

- `allowanceType` (enum, optional) — Which monthly allowance a BILLING_ALLOWANCE refusal exhausted.
  - Allowed values: `NEW_COMPANY`, `UPDATE`, `NEW_PERSON`, `UPDATE_PERSON`, `ENTITY_VIEW`, `PERSON_VIEW`
- `circuitBreaker` (string, optional, nullable)
- `code` (enum, optional) — 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.
  - Allowed values: `not_authorized`, `rateLimited`, `rate_limited`, `subscription_required`, `subscription_canceled`, `subscription_past_due`, `subscription_paused`, `billing_allowance_exhausted`, `billing_additional_usage_cap_reached`, `origin_detail_capacity`, `origin_detail_shutdown`, `suspectedShellStrip`, `suspected_shell_strip`, `url_surface_misclassification`, `JOBRUNR_DISABLED`, `jobrunr_disabled`, `JOBRUNR_STORAGE_UNAVAILABLE`, `jobrunr_storage_unavailable`, `rbac_lookup_unavailable`, `GEOCODE_PROVIDER_ERROR`, `geocode_provider_error`, `image_blocklist_match`, `image_monochrome`, `image_too_small`, `image_wrong_aspect`, `image_monogram`, `image_unreadable`, `image_processing_error`, `image_brand_mismatch`, `web_crawl_fetch_failed`, `primary_website_missing`, `news_rss_feed_fetch_failed`, `news_rss_article_fetch_failed`, `r2_fetch_failed`, `r2_delete_failed`, `r2_upload_failed`, `source_document_body_unavailable`, `source_document_capture_limit_exceeded`, `news_similarity_embedding_unavailable`, `search_provider_not_configured`, `search_provider_error`, `sec_edgar_fetch_failed`, `github_fetch_failed`, `INFERENCE_PROVIDER_ERROR`, `inference_provider_error`, `INFERENCE_PROVIDER_RESPONSE_EMPTY`, `inference_provider_response_empty`, `INFERENCE_PROVIDER_INVALID_JSON`, `inference_provider_invalid_json`, `INFERENCE_PROFILES_MISSING`, `inference_profiles_missing`, `INFERENCE_PROFILE_API_KEY_MISSING`, `inference_profile_api_key_missing`
- `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner
- `detail` (string, optional)
- `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. Create duplicate reviews and deterministic lookup ambiguity return DuplicateCreateReview; the returned candidates are the decision surface for update, create-with-override, or block. score/threshold rank review priority and are not proof that the requested record is absent.
- `error` (map from string to string, optional, nullable)
- `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path
- `feId` (string, optional, nullable)
- `field` (string, optional, nullable)
- `hammingDistance` (long, optional, nullable)
- `hint` (string, optional, nullable)
- `instance` (string, optional)
- `limit` (long, optional, nullable) — Cap the limitType meter allows for its current period.
- `limitType` (enum, optional) — Which meter refused the request; names what limit/used/remaining count.
  - Allowed values: `FORM`, `GLOBAL`, `SUBNET`, `IP`, `UNKNOWN`, `RESILIENCE4J`, `WEB_SEARCH`, `NATURAL_SEARCH`, `BILLING_ALLOWANCE`, `BILLING_ADDITIONAL_USAGE`, `CLERK_PUBLIC_ADMISSION`, `CLERK_SCRIPT_LOAD`, `ORIGIN_DETAIL`, `INFERENCE_PROVIDER`
- `matchedBlocklistKey` (string, optional, nullable)
- `mediaType` (string, optional, nullable)
- `moderationReason` (string, optional, nullable)
- `parseError` (string, optional, nullable)
- `path` (string, optional, nullable)
- `properties` (map from string to any, optional)
- `remaining` (long, optional, nullable) — Cap minus used for the limitType meter, never negative.
- `requiredRole` (string, optional, nullable)
- `resetAt` (datetime, optional, nullable) — When the limitType meter refills and the request can succeed again.
- `resolution` (ProblemResolution, optional, nullable) — Machine-readable next action for an aVenture ProblemDetail. For reviewCandidates, inspect ProblemDetail.details candidates and decide update, create-with-override, or block from those returned records.
- `retryAfterSeconds` (long, optional, nullable) — 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.
- `spanId` (string, optional, nullable)
- `status` (integer, optional)
- `suggestion` (string, optional, nullable)
- `suggestions` (map from string to string, optional, nullable)
- `suspectedFragment` (string, optional, nullable)
- `title` (string, optional)
- `traceId` (string, optional, nullable)
- `type` (string, optional)
- `unknownParameters` (list of string, optional, nullable)
- `used` (long, optional, nullable) — Requests already charged against the limitType meter this period.
- `validParameters` (list of string, optional, nullable)
- `value` (string, optional, nullable)
- `windowSeconds` (long, optional, nullable) — Length of a rolling throttle window; absent for period meters.

### 422 Unprocessable Entity Error

Unprocessable Content

- `allowanceType` (enum, optional) — Which monthly allowance a BILLING_ALLOWANCE refusal exhausted.
  - Allowed values: `NEW_COMPANY`, `UPDATE`, `NEW_PERSON`, `UPDATE_PERSON`, `ENTITY_VIEW`, `PERSON_VIEW`
- `circuitBreaker` (string, optional, nullable)
- `code` (enum, optional) — 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.
  - Allowed values: `not_authorized`, `rateLimited`, `rate_limited`, `subscription_required`, `subscription_canceled`, `subscription_past_due`, `subscription_paused`, `billing_allowance_exhausted`, `billing_additional_usage_cap_reached`, `origin_detail_capacity`, `origin_detail_shutdown`, `suspectedShellStrip`, `suspected_shell_strip`, `url_surface_misclassification`, `JOBRUNR_DISABLED`, `jobrunr_disabled`, `JOBRUNR_STORAGE_UNAVAILABLE`, `jobrunr_storage_unavailable`, `rbac_lookup_unavailable`, `GEOCODE_PROVIDER_ERROR`, `geocode_provider_error`, `image_blocklist_match`, `image_monochrome`, `image_too_small`, `image_wrong_aspect`, `image_monogram`, `image_unreadable`, `image_processing_error`, `image_brand_mismatch`, `web_crawl_fetch_failed`, `primary_website_missing`, `news_rss_feed_fetch_failed`, `news_rss_article_fetch_failed`, `r2_fetch_failed`, `r2_delete_failed`, `r2_upload_failed`, `source_document_body_unavailable`, `source_document_capture_limit_exceeded`, `news_similarity_embedding_unavailable`, `search_provider_not_configured`, `search_provider_error`, `sec_edgar_fetch_failed`, `github_fetch_failed`, `INFERENCE_PROVIDER_ERROR`, `inference_provider_error`, `INFERENCE_PROVIDER_RESPONSE_EMPTY`, `inference_provider_response_empty`, `INFERENCE_PROVIDER_INVALID_JSON`, `inference_provider_invalid_json`, `INFERENCE_PROFILES_MISSING`, `inference_profiles_missing`, `INFERENCE_PROFILE_API_KEY_MISSING`, `inference_profile_api_key_missing`
- `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner
- `detail` (string, optional)
- `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. Create duplicate reviews and deterministic lookup ambiguity return DuplicateCreateReview; the returned candidates are the decision surface for update, create-with-override, or block. score/threshold rank review priority and are not proof that the requested record is absent.
- `error` (map from string to string, optional, nullable)
- `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path
- `feId` (string, optional, nullable)
- `field` (string, optional, nullable)
- `hammingDistance` (long, optional, nullable)
- `hint` (string, optional, nullable)
- `instance` (string, optional)
- `limit` (long, optional, nullable) — Cap the limitType meter allows for its current period.
- `limitType` (enum, optional) — Which meter refused the request; names what limit/used/remaining count.
  - Allowed values: `FORM`, `GLOBAL`, `SUBNET`, `IP`, `UNKNOWN`, `RESILIENCE4J`, `WEB_SEARCH`, `NATURAL_SEARCH`, `BILLING_ALLOWANCE`, `BILLING_ADDITIONAL_USAGE`, `CLERK_PUBLIC_ADMISSION`, `CLERK_SCRIPT_LOAD`, `ORIGIN_DETAIL`, `INFERENCE_PROVIDER`
- `matchedBlocklistKey` (string, optional, nullable)
- `mediaType` (string, optional, nullable)
- `moderationReason` (string, optional, nullable)
- `parseError` (string, optional, nullable)
- `path` (string, optional, nullable)
- `properties` (map from string to any, optional)
- `remaining` (long, optional, nullable) — Cap minus used for the limitType meter, never negative.
- `requiredRole` (string, optional, nullable)
- `resetAt` (datetime, optional, nullable) — When the limitType meter refills and the request can succeed again.
- `resolution` (ProblemResolution, optional, nullable) — Machine-readable next action for an aVenture ProblemDetail. For reviewCandidates, inspect ProblemDetail.details candidates and decide update, create-with-override, or block from those returned records.
- `retryAfterSeconds` (long, optional, nullable) — 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.
- `spanId` (string, optional, nullable)
- `status` (integer, optional)
- `suggestion` (string, optional, nullable)
- `suggestions` (map from string to string, optional, nullable)
- `suspectedFragment` (string, optional, nullable)
- `title` (string, optional)
- `traceId` (string, optional, nullable)
- `type` (string, optional)
- `unknownParameters` (list of string, optional, nullable)
- `used` (long, optional, nullable) — Requests already charged against the limitType meter this period.
- `validParameters` (list of string, optional, nullable)
- `value` (string, optional, nullable)
- `windowSeconds` (long, optional, nullable) — Length of a rolling throttle window; absent for period meters.

### 429 Too Many Requests Error

Too Many Requests

- `allowanceType` (enum, optional) — Which monthly allowance a BILLING_ALLOWANCE refusal exhausted.
  - Allowed values: `NEW_COMPANY`, `UPDATE`, `NEW_PERSON`, `UPDATE_PERSON`, `ENTITY_VIEW`, `PERSON_VIEW`
- `circuitBreaker` (string, optional, nullable)
- `code` (enum, optional) — 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.
  - Allowed values: `not_authorized`, `rateLimited`, `rate_limited`, `subscription_required`, `subscription_canceled`, `subscription_past_due`, `subscription_paused`, `billing_allowance_exhausted`, `billing_additional_usage_cap_reached`, `origin_detail_capacity`, `origin_detail_shutdown`, `suspectedShellStrip`, `suspected_shell_strip`, `url_surface_misclassification`, `JOBRUNR_DISABLED`, `jobrunr_disabled`, `JOBRUNR_STORAGE_UNAVAILABLE`, `jobrunr_storage_unavailable`, `rbac_lookup_unavailable`, `GEOCODE_PROVIDER_ERROR`, `geocode_provider_error`, `image_blocklist_match`, `image_monochrome`, `image_too_small`, `image_wrong_aspect`, `image_monogram`, `image_unreadable`, `image_processing_error`, `image_brand_mismatch`, `web_crawl_fetch_failed`, `primary_website_missing`, `news_rss_feed_fetch_failed`, `news_rss_article_fetch_failed`, `r2_fetch_failed`, `r2_delete_failed`, `r2_upload_failed`, `source_document_body_unavailable`, `source_document_capture_limit_exceeded`, `news_similarity_embedding_unavailable`, `search_provider_not_configured`, `search_provider_error`, `sec_edgar_fetch_failed`, `github_fetch_failed`, `INFERENCE_PROVIDER_ERROR`, `inference_provider_error`, `INFERENCE_PROVIDER_RESPONSE_EMPTY`, `inference_provider_response_empty`, `INFERENCE_PROVIDER_INVALID_JSON`, `inference_provider_invalid_json`, `INFERENCE_PROFILES_MISSING`, `inference_profiles_missing`, `INFERENCE_PROFILE_API_KEY_MISSING`, `inference_profile_api_key_missing`
- `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner
- `detail` (string, optional)
- `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. Create duplicate reviews and deterministic lookup ambiguity return DuplicateCreateReview; the returned candidates are the decision surface for update, create-with-override, or block. score/threshold rank review priority and are not proof that the requested record is absent.
- `error` (map from string to string, optional, nullable)
- `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path
- `feId` (string, optional, nullable)
- `field` (string, optional, nullable)
- `hammingDistance` (long, optional, nullable)
- `hint` (string, optional, nullable)
- `instance` (string, optional)
- `limit` (long, optional, nullable) — Cap the limitType meter allows for its current period.
- `limitType` (enum, optional) — Which meter refused the request; names what limit/used/remaining count.
  - Allowed values: `FORM`, `GLOBAL`, `SUBNET`, `IP`, `UNKNOWN`, `RESILIENCE4J`, `WEB_SEARCH`, `NATURAL_SEARCH`, `BILLING_ALLOWANCE`, `BILLING_ADDITIONAL_USAGE`, `CLERK_PUBLIC_ADMISSION`, `CLERK_SCRIPT_LOAD`, `ORIGIN_DETAIL`, `INFERENCE_PROVIDER`
- `matchedBlocklistKey` (string, optional, nullable)
- `mediaType` (string, optional, nullable)
- `moderationReason` (string, optional, nullable)
- `parseError` (string, optional, nullable)
- `path` (string, optional, nullable)
- `properties` (map from string to any, optional)
- `remaining` (long, optional, nullable) — Cap minus used for the limitType meter, never negative.
- `requiredRole` (string, optional, nullable)
- `resetAt` (datetime, optional, nullable) — When the limitType meter refills and the request can succeed again.
- `resolution` (ProblemResolution, optional, nullable) — Machine-readable next action for an aVenture ProblemDetail. For reviewCandidates, inspect ProblemDetail.details candidates and decide update, create-with-override, or block from those returned records.
- `retryAfterSeconds` (long, optional, nullable) — 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.
- `spanId` (string, optional, nullable)
- `status` (integer, optional)
- `suggestion` (string, optional, nullable)
- `suggestions` (map from string to string, optional, nullable)
- `suspectedFragment` (string, optional, nullable)
- `title` (string, optional)
- `traceId` (string, optional, nullable)
- `type` (string, optional)
- `unknownParameters` (list of string, optional, nullable)
- `used` (long, optional, nullable) — Requests already charged against the limitType meter this period.
- `validParameters` (list of string, optional, nullable)
- `value` (string, optional, nullable)
- `windowSeconds` (long, optional, nullable) — Length of a rolling throttle window; absent for period meters.

### 500 Internal Server Error

Internal Server Error

- `allowanceType` (enum, optional) — Which monthly allowance a BILLING_ALLOWANCE refusal exhausted.
  - Allowed values: `NEW_COMPANY`, `UPDATE`, `NEW_PERSON`, `UPDATE_PERSON`, `ENTITY_VIEW`, `PERSON_VIEW`
- `circuitBreaker` (string, optional, nullable)
- `code` (enum, optional) — 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.
  - Allowed values: `not_authorized`, `rateLimited`, `rate_limited`, `subscription_required`, `subscription_canceled`, `subscription_past_due`, `subscription_paused`, `billing_allowance_exhausted`, `billing_additional_usage_cap_reached`, `origin_detail_capacity`, `origin_detail_shutdown`, `suspectedShellStrip`, `suspected_shell_strip`, `url_surface_misclassification`, `JOBRUNR_DISABLED`, `jobrunr_disabled`, `JOBRUNR_STORAGE_UNAVAILABLE`, `jobrunr_storage_unavailable`, `rbac_lookup_unavailable`, `GEOCODE_PROVIDER_ERROR`, `geocode_provider_error`, `image_blocklist_match`, `image_monochrome`, `image_too_small`, `image_wrong_aspect`, `image_monogram`, `image_unreadable`, `image_processing_error`, `image_brand_mismatch`, `web_crawl_fetch_failed`, `primary_website_missing`, `news_rss_feed_fetch_failed`, `news_rss_article_fetch_failed`, `r2_fetch_failed`, `r2_delete_failed`, `r2_upload_failed`, `source_document_body_unavailable`, `source_document_capture_limit_exceeded`, `news_similarity_embedding_unavailable`, `search_provider_not_configured`, `search_provider_error`, `sec_edgar_fetch_failed`, `github_fetch_failed`, `INFERENCE_PROVIDER_ERROR`, `inference_provider_error`, `INFERENCE_PROVIDER_RESPONSE_EMPTY`, `inference_provider_response_empty`, `INFERENCE_PROVIDER_INVALID_JSON`, `inference_provider_invalid_json`, `INFERENCE_PROFILES_MISSING`, `inference_profiles_missing`, `INFERENCE_PROFILE_API_KEY_MISSING`, `inference_profile_api_key_missing`
- `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner
- `detail` (string, optional)
- `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. Create duplicate reviews and deterministic lookup ambiguity return DuplicateCreateReview; the returned candidates are the decision surface for update, create-with-override, or block. score/threshold rank review priority and are not proof that the requested record is absent.
- `error` (map from string to string, optional, nullable)
- `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path
- `feId` (string, optional, nullable)
- `field` (string, optional, nullable)
- `hammingDistance` (long, optional, nullable)
- `hint` (string, optional, nullable)
- `instance` (string, optional)
- `limit` (long, optional, nullable) — Cap the limitType meter allows for its current period.
- `limitType` (enum, optional) — Which meter refused the request; names what limit/used/remaining count.
  - Allowed values: `FORM`, `GLOBAL`, `SUBNET`, `IP`, `UNKNOWN`, `RESILIENCE4J`, `WEB_SEARCH`, `NATURAL_SEARCH`, `BILLING_ALLOWANCE`, `BILLING_ADDITIONAL_USAGE`, `CLERK_PUBLIC_ADMISSION`, `CLERK_SCRIPT_LOAD`, `ORIGIN_DETAIL`, `INFERENCE_PROVIDER`
- `matchedBlocklistKey` (string, optional, nullable)
- `mediaType` (string, optional, nullable)
- `moderationReason` (string, optional, nullable)
- `parseError` (string, optional, nullable)
- `path` (string, optional, nullable)
- `properties` (map from string to any, optional)
- `remaining` (long, optional, nullable) — Cap minus used for the limitType meter, never negative.
- `requiredRole` (string, optional, nullable)
- `resetAt` (datetime, optional, nullable) — When the limitType meter refills and the request can succeed again.
- `resolution` (ProblemResolution, optional, nullable) — Machine-readable next action for an aVenture ProblemDetail. For reviewCandidates, inspect ProblemDetail.details candidates and decide update, create-with-override, or block from those returned records.
- `retryAfterSeconds` (long, optional, nullable) — 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.
- `spanId` (string, optional, nullable)
- `status` (integer, optional)
- `suggestion` (string, optional, nullable)
- `suggestions` (map from string to string, optional, nullable)
- `suspectedFragment` (string, optional, nullable)
- `title` (string, optional)
- `traceId` (string, optional, nullable)
- `type` (string, optional)
- `unknownParameters` (list of string, optional, nullable)
- `used` (long, optional, nullable) — Requests already charged against the limitType meter this period.
- `validParameters` (list of string, optional, nullable)
- `value` (string, optional, nullable)
- `windowSeconds` (long, optional, nullable) — Length of a rolling throttle window; absent for period meters.

### 503 Service Unavailable Error

Service Unavailable

- `allowanceType` (enum, optional) — Which monthly allowance a BILLING_ALLOWANCE refusal exhausted.
  - Allowed values: `NEW_COMPANY`, `UPDATE`, `NEW_PERSON`, `UPDATE_PERSON`, `ENTITY_VIEW`, `PERSON_VIEW`
- `circuitBreaker` (string, optional, nullable)
- `code` (enum, optional) — 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.
  - Allowed values: `not_authorized`, `rateLimited`, `rate_limited`, `subscription_required`, `subscription_canceled`, `subscription_past_due`, `subscription_paused`, `billing_allowance_exhausted`, `billing_additional_usage_cap_reached`, `origin_detail_capacity`, `origin_detail_shutdown`, `suspectedShellStrip`, `suspected_shell_strip`, `url_surface_misclassification`, `JOBRUNR_DISABLED`, `jobrunr_disabled`, `JOBRUNR_STORAGE_UNAVAILABLE`, `jobrunr_storage_unavailable`, `rbac_lookup_unavailable`, `GEOCODE_PROVIDER_ERROR`, `geocode_provider_error`, `image_blocklist_match`, `image_monochrome`, `image_too_small`, `image_wrong_aspect`, `image_monogram`, `image_unreadable`, `image_processing_error`, `image_brand_mismatch`, `web_crawl_fetch_failed`, `primary_website_missing`, `news_rss_feed_fetch_failed`, `news_rss_article_fetch_failed`, `r2_fetch_failed`, `r2_delete_failed`, `r2_upload_failed`, `source_document_body_unavailable`, `source_document_capture_limit_exceeded`, `news_similarity_embedding_unavailable`, `search_provider_not_configured`, `search_provider_error`, `sec_edgar_fetch_failed`, `github_fetch_failed`, `INFERENCE_PROVIDER_ERROR`, `inference_provider_error`, `INFERENCE_PROVIDER_RESPONSE_EMPTY`, `inference_provider_response_empty`, `INFERENCE_PROVIDER_INVALID_JSON`, `inference_provider_invalid_json`, `INFERENCE_PROFILES_MISSING`, `inference_profiles_missing`, `INFERENCE_PROFILE_API_KEY_MISSING`, `inference_profile_api_key_missing`
- `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner
- `detail` (string, optional)
- `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. Create duplicate reviews and deterministic lookup ambiguity return DuplicateCreateReview; the returned candidates are the decision surface for update, create-with-override, or block. score/threshold rank review priority and are not proof that the requested record is absent.
- `error` (map from string to string, optional, nullable)
- `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path
- `feId` (string, optional, nullable)
- `field` (string, optional, nullable)
- `hammingDistance` (long, optional, nullable)
- `hint` (string, optional, nullable)
- `instance` (string, optional)
- `limit` (long, optional, nullable) — Cap the limitType meter allows for its current period.
- `limitType` (enum, optional) — Which meter refused the request; names what limit/used/remaining count.
  - Allowed values: `FORM`, `GLOBAL`, `SUBNET`, `IP`, `UNKNOWN`, `RESILIENCE4J`, `WEB_SEARCH`, `NATURAL_SEARCH`, `BILLING_ALLOWANCE`, `BILLING_ADDITIONAL_USAGE`, `CLERK_PUBLIC_ADMISSION`, `CLERK_SCRIPT_LOAD`, `ORIGIN_DETAIL`, `INFERENCE_PROVIDER`
- `matchedBlocklistKey` (string, optional, nullable)
- `mediaType` (string, optional, nullable)
- `moderationReason` (string, optional, nullable)
- `parseError` (string, optional, nullable)
- `path` (string, optional, nullable)
- `properties` (map from string to any, optional)
- `remaining` (long, optional, nullable) — Cap minus used for the limitType meter, never negative.
- `requiredRole` (string, optional, nullable)
- `resetAt` (datetime, optional, nullable) — When the limitType meter refills and the request can succeed again.
- `resolution` (ProblemResolution, optional, nullable) — Machine-readable next action for an aVenture ProblemDetail. For reviewCandidates, inspect ProblemDetail.details candidates and decide update, create-with-override, or block from those returned records.
- `retryAfterSeconds` (long, optional, nullable) — 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.
- `spanId` (string, optional, nullable)
- `status` (integer, optional)
- `suggestion` (string, optional, nullable)
- `suggestions` (map from string to string, optional, nullable)
- `suspectedFragment` (string, optional, nullable)
- `title` (string, optional)
- `traceId` (string, optional, nullable)
- `type` (string, optional)
- `unknownParameters` (list of string, optional, nullable)
- `used` (long, optional, nullable) — Requests already charged against the limitType meter this period.
- `validParameters` (list of string, optional, nullable)
- `value` (string, optional, nullable)
- `windowSeconds` (long, optional, nullable) — Length of a rolling throttle window; absent for period meters.

## Types

### IntRange

Integer range for count-based filter criteria

- `max` (integer, optional, nullable) — Inclusive maximum integer.
- `min` (integer, optional, nullable) — Inclusive minimum integer.

### EntityFundraiseFilterCriteria

Fundraise and investment filters for entity search

- `amountInvestedRange` (list of DecimalRange, optional)
- `amountRaisedRange` (list of DecimalRange, optional)
- `investedCompanyName` (list of string, optional) — Portfolio company names. Exact, case-sensitive match on the portfolio company's brand or legal name; restricts returned entities to investors in those companies.
- `investorActivity` (InvestorActivityFilter, optional) — Aggregate investor activity filters.
- `lastRoundYearRange` (list of IntRange, optional)
- `round` (list of string, optional) — Fundraise round labels, such as Seed or Series A.
- `totalRaisedRange` (list of DecimalRange, optional)
- `valuationRange` (list of DecimalRange, optional)

### EntityFilterLogoOption

Logo sort priority for entity search

- `sortPriority` (enum, optional) — Logo sort priority.
  - Allowed values: `NONE`, `ANY_LOGO_FIRST`, `REAL_LOGO_FIRST`

### EntityFilterEntry

Filter entry payload served by list filter endpoints

- `chart` (list of ChartBucket, required) — Chart filter values
- `choiceOption` (list of EntityFilterChoice, required) — Choice option filter values
- `controlType` (enum, required) — Control type used to render the filter
  - Allowed values: `checkbox`, `range`, `currencyRange`, `dateRange`
- `filterKey` (string, required) — Canonical filter key
- `label` (string, required) — Display label for the filter
- `choiceOptionTotal` (integer, optional, nullable) — Total eligible choice option values for this filter
- `choiceOptionTruncated` (boolean, optional, nullable) — Whether additional eligible choices exist beyond choiceOption
- `filterMeta` (EntityFilterMeta, optional, nullable) — Optional entity-specific filter metadata
- `scope` (EntityFilterScope, optional, nullable) — Optional numeric scope for the filter

### RefinementMeta

Meta

- `degraded` (boolean, required) — Whether retrying may improve scoped choice totals
- `limit` (integer, required) — Maximum entities sampled for displayed choices.
- `page` (integer, required) — Zero-based result page used to build the refinement.
- `total` (integer, optional, nullable) — Total entities matching the active filter; null when unavailable.

### CurrentSlugOwner

Current slug owner

- `id` (string, required)
- `isHidden` (boolean, required)
- `resourceType` (enum, required) — Resource type whose slug is being changed
  - Allowed values: `entity`, `person`, `news`, `blog`, `content`
- `showOnSitemap` (boolean, required)
- `slug` (string, required)
- `deletedAt` (datetime, optional, nullable)
- `nameBrand` (string, optional, nullable)

### DomainConflictDetails

Polymorphic envelope for RFC 9457 ProblemDetail.details on HTTP 409 responses. The concrete variant depends on the conflict kind: URL ownership collisions return UrlDuplicateConflict; ambiguous strict URL lookups return StrictUrlLookupConflict; create-time duplicate review gates return DuplicateCreateReview; classification writes that touch an inactive tag bucket return ClassificationInactiveTagDetails; news publication+URL uniqueness violations return NewsSourceUrlConflict. Inspect ProblemDetail.code/type and the field set present on details to identify the variant.

### RedirectSlugPath

Redirect slug path

- `oldUrl` (string, required)
- `newUrl` (string, optional, nullable)
- `targetCurrentSlug` (string, optional, nullable)
- `targetId` (string, optional, nullable)
- `targetResourceType` (enum, optional, nullable) — Resource type whose slug is being changed
  - Allowed values: `entity`, `person`, `news`, `blog`, `content`

### ProblemResolution

Machine-readable next action for an aVenture ProblemDetail. For reviewCandidates, inspect ProblemDetail.details candidates and decide update, create-with-override, or block from those returned records.

- `action` (enum, required) — Next action category for the client or agent.
  - Allowed values: `setField`, `setParameter`, `removeParameter`, `useEndpoint`, `reviewCandidates`, `authenticate`
- `acceptedValue` (list of string, optional, nullable) — Accepted values for the field or parameter, when enumerable.
- `endpoint` (string, optional, nullable) — Endpoint to call for the next action, when applicable.
- `fieldPath` (string, optional, nullable) — Request-body field path that needs attention, when applicable.
- `parameter` (string, optional, nullable) — Query parameter that needs attention, when applicable.
- `retryable` (boolean, optional, nullable) — Whether the same logical request can be retried after the next action.

### DecimalRange

Decimal range for monetary and numeric filter criteria

- `max` (double, optional, nullable) — Inclusive maximum decimal number, such as 220000 or 123456.78.
- `min` (double, optional, nullable) — Inclusive minimum decimal number, such as 220000 or 123456.78.

### InvestorActivityFilter

Aggregate investor activity filters from distinct fundraise deals and USD amounts.

- `averageAmountInvestedUsdRange` (list of DecimalRange, optional)
- `largestAmountInvestedUsdRange` (list of DecimalRange, optional)
- `smallestAmountInvestedUsdRange` (list of DecimalRange, optional)
- `totalAmountInvestedUsdRange` (list of DecimalRange, optional)
- `totalInvestmentRange` (list of IntRange, optional)

### ChartBucket

Typed bucket for range histogram charts

- `amount` (long, required) — Amount
- `end` (long, required) — Exclusive bucket end value
- `start` (long, required) — Inclusive bucket start value

### EntityFilterChoice

Filter choice payload served by filter endpoints

- `label` (string, required) — Display label for the option
- `value` (string, required) — Canonical option value
- `scope` (EntityFilterScope, optional, nullable) — Optional numeric scope for the option

### EntityFilterMeta

API response fragment for entity filter metadata

- `ui` (EntityFilterUiMeta, optional, nullable) — UI metadata for rendering entity filter controls

### EntityFilterScope

Numeric min/max bounds for range filter values

- `max` (long, optional, nullable) — Maximum scope value
- `min` (long, optional, nullable) — Minimum scope value

### UrlDuplicateConflict

Typed extension on ProblemDetail.details for HTTP 409 when a create/update attempts to set a URL with urlType=website (or another exclusive urlType) that is already a current URL on a different entity or person. The existingJoin list names every current owner of the normalized URL; resolve by demoting the existing owner (isCurrent=false, isPrimary=false) before promoting the new owner.

- `existingJoin` (list of UrlDuplicateJoin, required) — Every current owner that already holds the normalized URL with this urlType. Non-empty when this conflict is emitted.
- `fragmentIgnored` (boolean, required) — True when URL fragment differences were ignored during duplicate matching (i.e., the conflict ignores everything after '#').
- `guidance` (string, required) — Human-readable guidance on how to resolve the conflict. Defaults to the standard inspect-then-demote/promote sequence.
- `requestedOwner` (EntityPersonOwner, required) — Owner the caller attempted to attach the URL to.
- `url` (string, required) — Raw URL as submitted by the caller (pre-normalization).
- `urlType` (string, required) — URL type submitted by the caller (e.g., 'website', 'twitter'). The conflict applies only within this urlType.
- `normalizedUrl` (string, optional, nullable) — Normalized URL match key used for duplicate detection. Null when normalization could not produce a stable key (e.g., malformed input).

### StrictUrlLookupConflict

Typed extension on ProblemDetail.details for HTTP 409 when a strict URL lookup (GET /v1/entities/lookup?url=...) resolves to more than one current owner. The candidate lists return every current owner that matches the normalized URL key; the caller must add disambiguating signals (urlType, typeRecord, slug) to resolve to a single owner.

- `candidateEntityId` (list of string, required) — Every entity id that currently owns the normalized URL. May be empty when the conflict is between persons; combined with candidatePersonId always > 1.
- `candidatePersonId` (list of string, required) — Every person id that currently owns the normalized URL. May be empty when the conflict is between entities; combined with candidateEntityId always > 1.
- `hint` (string, required) — Human-readable hint describing which disambiguating query parameters to add.
- `url` (string, required) — Raw URL the caller queried.
- `normalizedUrl` (string, optional, nullable) — Normalized URL match key the lookup resolved against. Null when normalization could not produce a stable key.
- `urlType` (string, optional, nullable) — URL type the caller specified, or null if the lookup did not constrain by urlType.

### DuplicateCreateReview

Candidate-review conflict details returned in ProblemDetail.details for create gates and deterministic lookup ambiguity. The returned candidates are the decision surface: update the matching candidate, create with duplicate override only when every candidate is distinct from the source-backed target, or block when identity is unresolved. score and threshold rank review priority; they are not proof that the requested record is absent.

- `threshold` (integer, required) — Review threshold used by duplicate scoring. Scores below this value can still be useful candidate context; this value does not prove absence or authorize create.
- `candidate` (list of SearchDuplicateCandidateScore, optional, nullable) — Entity/person candidates returned by lookup or create duplicate review. If a candidate is the requested record, read/update that candidate by id. Create with duplicate override only after every candidate is reviewed as distinct.
- `newsCandidate` (list of NewsCandidateScore, optional, nullable) — News candidates returned by lookup or create duplicate review. If a candidate is the requested article, read/update that article by id. Otherwise block until source evidence proves a distinct article.
- `overridePath` (string, optional, nullable) — Create endpoint to retry only after reviewing the returned candidates and supplying overrideGate=duplicate and overrideReason as query parameters. Null for detail lookup ambiguity, where the next action is review/update/block.

### ClassificationInactiveTagDetails

ProblemDetail.details for HTTP 409 when a classification value exists but is inactive.

- `availableOverrides` (list of enum, required) — Allowed inactiveTagOverride values for this conflict
  - Allowed values: `REACTIVATE`, `ATTACH_INACTIVE`
- `slug` (string, required) — Existing dormant value slug or lookup key
- `tagId` (integer, required) — Existing tag id in res_type_ref

### NewsSourceUrlConflict

Typed extension on ProblemDetail.details for HTTP 409 when a news mutation's publication + newsUrlOriginal pair already belongs to another article. The returned fields identify the existing article so the caller can read/update it instead of creating a duplicate.

- `conflictingArticleId` (integer, required) — Existing article id (NewsId.value) that already owns this publication + URL pair.
- `conflictingArticleSlug` (string, required) — Existing article slug, or empty string when the existing article has no slug. Use with GET /v1/news/lookup?slug= to fetch the conflicting article.
- `conflictingArticleTitle` (string, required) — Existing article title for human-readable diagnostics.

### EntityFilterUiMeta

UI-only metadata used for rendering entity filter panels

- `headquartersOption` (EntityFilterHeadquartersOptionSet, optional, nullable) — Headquarters option hierarchy

### UrlDuplicateJoin

URL ownership join row identifying which entity or person currently owns a normalized URL.

- `owner` (EntityPersonOwner, required) — Owner of the URL: either entityId or personId is populated depending on the owner kind. Use the populated id to read or update the owner's URL.
- `urlId` (integer, required) — Internal URL row id (res_weburl.id) — opaque to API clients.

### EntityPersonOwner

Exactly one of entityId or personId is set; ids only, no name fields. Resolve display names with GET /v1/entities/detail or GET /v1/people/\{personId}.

- `entityId` (string, optional, nullable) — Canonical entity UUID
- `personId` (string, optional, nullable) — Canonical person UUID

### SearchDuplicateCandidateScore

Duplicate candidate scoring result. Use id/name/slug/typeRecord/reason to decide whether the candidate is the requested record. score ranks review priority; it does not prove absence.

- `id` (string, required) — Candidate id to read or update when this candidate is the requested record.
- `reason` (list of string, required) — Match reasons such as name-exact, slug-exact, url-match, url-current, url-type, or precomputed-similarity. url-match proves the supplied URL/domain matched; url-current additionally proves the candidate still holds that address today, so a candidate with url-match but no url-current matched only through a URL it no longer uses, such as an acquisition redirect. url-type only means the candidate has the same URL category and is review context, not URL identity evidence.
- `score` (integer, required) — Ranking score for duplicate review. It is not an absence proof; a low score can still be the intended record when reason/name/slug/typeRecord match.
- `externalId` (string, optional, nullable) — Matched external identifier when duplicate scoring used one.
- `name` (string, optional, nullable) — Candidate display name from the existing record.
- `operatingStatus` (string, optional, nullable) — Current operating status for entity candidates.
- `publicPath` (string, optional, nullable) — Public API/UI path for the candidate when available.
- `slug` (string, optional, nullable) — Candidate slug from the existing record.
- `typeRecord` (enum, optional, nullable) — Candidate entity type from the existing record.
  - Allowed values: `Company`, `Investment Firm`, `Fund`, `Nonprofit`, `Government`, `Organization`, `Business Line`, `Product`, `Service`

### NewsCandidateScore

Duplicate candidate scoring result for news articles. Use id/slug/externalId/reason to decide whether the candidate is the requested article. score ranks review priority; it does not prove absence.

- `id` (integer, required) — News article id to read or update when this candidate is the requested article.
- `reason` (list of string, required) — Match reasons for reviewing the candidate. Exact reasons are decision signals regardless of whether score crosses the review threshold.
- `score` (integer, required) — Ranking score for duplicate review. It is not an absence proof; a low score can still be the intended article when reason/slug/externalId match.
- `externalId` (string, optional, nullable) — Matched external article identifier when duplicate scoring used one.
- `slug` (string, optional, nullable) — Candidate article slug from the existing record.

### EntityFilterHeadquartersOptionSet

Headquarters option hierarchy

- `country` (list of EntityFilterHeadquartersCountry, required) — Countries with their states and cities

### EntityFilterHeadquartersCountry

Country with its states (and optionally cities)

- `country` (string, required) — Country name
- `state` (list of EntityFilterHeadquartersStateCity, required) — States within the country

### EntityFilterHeadquartersStateCity

City within a state

- `city` (list of string, required) — Cities within the state; empty when only states were requested
- `state` (string, required) — State name

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "filter": [
    {
      "chart": [
        {
          "amount": 1,
          "end": 1,
          "start": 1
        }
      ],
      "choiceOption": [
        {
          "label": "string",
          "value": "string",
          "scope": {
            "max": 1,
            "min": 1
          }
        }
      ],
      "controlType": "checkbox",
      "filterKey": "string",
      "label": "string",
      "choiceOptionTotal": 1,
      "choiceOptionTruncated": true,
      "filterMeta": {
        "ui": {
          "headquartersOption": {
            "country": [
              {
                "country": "string",
                "state": [
                  {
                    "city": [
                      "string"
                    ],
                    "state": "string"
                  }
                ]
              }
            ]
          }
        }
      },
      "scope": {
        "max": 1,
        "min": 1
      }
    }
  ],
  "meta": {
    "degraded": true,
    "limit": 1,
    "page": 1,
    "total": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.aventure.vc/v1/entities/filters/refine"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.aventure.vc/v1/entities/filters/refine';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aventure.vc/v1/entities/filters/refine"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.aventure.vc/v1/entities/filters/refine")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.aventure.vc/v1/entities/filters/refine")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.aventure.vc/v1/entities/filters/refine', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.aventure.vc/v1/entities/filters/refine");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.aventure.vc/v1/entities/filters/refine")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```