> 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. # Share a Directory View POST https://api.aventure.vc/v1/directory/shared Content-Type: application/json Publishes the exact filter and sort a /companies, /investors, or /people page shows under the supplied UUID, with a model-written heading, title, and description. The view must match at least one public record and may set only public filter fields. Reusing the UUID with the same view, or sharing a view already published, returns that publication; a different view under a used UUID is rejected. The publication is readable without authentication. Reference: https://docs.aventure.vc/api-reference/search/create-shared-directory ## Authentication - `Authorization` header (bearer token, required) — Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token ## Request ### Body (application/json) This endpoint expects a SharedDirectoryMutation. - `directory` (enum, optional, nullable) — Directory page the view filters. - Allowed values: `companies`, `investors`, `people` - `entityFilter` (EntityListFilter, optional, nullable) — Body the companies or investors page sends to entity search. - `id` (string, optional, nullable) — Stable sharing UUID generated once and reused across retries. - `personFilter` (PersonFilter, optional, nullable) — Body the people page sends to person search. - `sort` (string, optional, nullable) — Sort the page sends, as property,asc or property,desc. ## Response ### 200 OK - `description` (string, required) — Search-result description, at most 155 characters. - `publication` (SharedDirectoryList, required) — Public directory publication metadata. - `title` (string, required) — Search-result title, at most 60 characters. - `entityFilter` (EntityListFilter, optional, nullable) — Entity filter of a companies or investors view. - `personFilter` (PersonFilter, optional, nullable) — Person filter of a people view. - `sort` (string, optional, nullable) — Sort as property,direction; absent uses the directory default. ## Errors ### 400 Bad Request Error Bad Request - `allowanceType` (enum, optional) — Which monthly allowance a BILLING_ALLOWANCE refusal exhausted. - Allowed values: `COMPANY`, `PERSON`, `ENTITY_VIEW`, `ENTITY_BRAND`, `PERSON_VIEW`, `WEB_SEARCH` - `circuitBreaker` (string, optional, nullable) - `code` (string, optional, nullable) — 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 describe server-side conditions a caller cannot fix: surface the error and stop rather than retry. - `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner - `detail` (string, optional) - `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. - `disposition` (enum, optional) — Whether a service-unavailable failure can be retried. - Allowed values: `TRANSIENT`, `TERMINAL` - `error` (map from string to string, optional, nullable) - `existingRecordId` (string, optional, nullable) — On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. - `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path - `feId` (string, optional, nullable) - `field` (string, optional, nullable) - `filedRunId` (list of string, optional, nullable) — Research request ids a batch filed or reused for its other records before returning this error; absent for every other error. - `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` (string, optional, nullable) — Which meter refused the request; names what limit/used/remaining count. - `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) - `proseViolation` (list of ProseViolation, optional, nullable) — Every rejected passage of a PROSE_REJECTED write, once per problem it shows; absent for every other problem. - `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: `COMPANY`, `PERSON`, `ENTITY_VIEW`, `ENTITY_BRAND`, `PERSON_VIEW`, `WEB_SEARCH` - `circuitBreaker` (string, optional, nullable) - `code` (string, optional, nullable) — 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 describe server-side conditions a caller cannot fix: surface the error and stop rather than retry. - `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner - `detail` (string, optional) - `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. - `disposition` (enum, optional) — Whether a service-unavailable failure can be retried. - Allowed values: `TRANSIENT`, `TERMINAL` - `error` (map from string to string, optional, nullable) - `existingRecordId` (string, optional, nullable) — On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. - `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path - `feId` (string, optional, nullable) - `field` (string, optional, nullable) - `filedRunId` (list of string, optional, nullable) — Research request ids a batch filed or reused for its other records before returning this error; absent for every other error. - `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` (string, optional, nullable) — Which meter refused the request; names what limit/used/remaining count. - `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) - `proseViolation` (list of ProseViolation, optional, nullable) — Every rejected passage of a PROSE_REJECTED write, once per problem it shows; absent for every other problem. - `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: `COMPANY`, `PERSON`, `ENTITY_VIEW`, `ENTITY_BRAND`, `PERSON_VIEW`, `WEB_SEARCH` - `circuitBreaker` (string, optional, nullable) - `code` (string, optional, nullable) — 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 describe server-side conditions a caller cannot fix: surface the error and stop rather than retry. - `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner - `detail` (string, optional) - `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. - `disposition` (enum, optional) — Whether a service-unavailable failure can be retried. - Allowed values: `TRANSIENT`, `TERMINAL` - `error` (map from string to string, optional, nullable) - `existingRecordId` (string, optional, nullable) — On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. - `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path - `feId` (string, optional, nullable) - `field` (string, optional, nullable) - `filedRunId` (list of string, optional, nullable) — Research request ids a batch filed or reused for its other records before returning this error; absent for every other error. - `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` (string, optional, nullable) — Which meter refused the request; names what limit/used/remaining count. - `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) - `proseViolation` (list of ProseViolation, optional, nullable) — Every rejected passage of a PROSE_REJECTED write, once per problem it shows; absent for every other problem. - `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: `COMPANY`, `PERSON`, `ENTITY_VIEW`, `ENTITY_BRAND`, `PERSON_VIEW`, `WEB_SEARCH` - `circuitBreaker` (string, optional, nullable) - `code` (string, optional, nullable) — 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 describe server-side conditions a caller cannot fix: surface the error and stop rather than retry. - `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner - `detail` (string, optional) - `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. - `disposition` (enum, optional) — Whether a service-unavailable failure can be retried. - Allowed values: `TRANSIENT`, `TERMINAL` - `error` (map from string to string, optional, nullable) - `existingRecordId` (string, optional, nullable) — On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. - `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path - `feId` (string, optional, nullable) - `field` (string, optional, nullable) - `filedRunId` (list of string, optional, nullable) — Research request ids a batch filed or reused for its other records before returning this error; absent for every other error. - `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` (string, optional, nullable) — Which meter refused the request; names what limit/used/remaining count. - `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) - `proseViolation` (list of ProseViolation, optional, nullable) — Every rejected passage of a PROSE_REJECTED write, once per problem it shows; absent for every other problem. - `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: `COMPANY`, `PERSON`, `ENTITY_VIEW`, `ENTITY_BRAND`, `PERSON_VIEW`, `WEB_SEARCH` - `circuitBreaker` (string, optional, nullable) - `code` (string, optional, nullable) — 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 describe server-side conditions a caller cannot fix: surface the error and stop rather than retry. - `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner - `detail` (string, optional) - `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. - `disposition` (enum, optional) — Whether a service-unavailable failure can be retried. - Allowed values: `TRANSIENT`, `TERMINAL` - `error` (map from string to string, optional, nullable) - `existingRecordId` (string, optional, nullable) — On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. - `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path - `feId` (string, optional, nullable) - `field` (string, optional, nullable) - `filedRunId` (list of string, optional, nullable) — Research request ids a batch filed or reused for its other records before returning this error; absent for every other error. - `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` (string, optional, nullable) — Which meter refused the request; names what limit/used/remaining count. - `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) - `proseViolation` (list of ProseViolation, optional, nullable) — Every rejected passage of a PROSE_REJECTED write, once per problem it shows; absent for every other problem. - `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: `COMPANY`, `PERSON`, `ENTITY_VIEW`, `ENTITY_BRAND`, `PERSON_VIEW`, `WEB_SEARCH` - `circuitBreaker` (string, optional, nullable) - `code` (string, optional, nullable) — 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 describe server-side conditions a caller cannot fix: surface the error and stop rather than retry. - `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner - `detail` (string, optional) - `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. - `disposition` (enum, optional) — Whether a service-unavailable failure can be retried. - Allowed values: `TRANSIENT`, `TERMINAL` - `error` (map from string to string, optional, nullable) - `existingRecordId` (string, optional, nullable) — On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. - `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path - `feId` (string, optional, nullable) - `field` (string, optional, nullable) - `filedRunId` (list of string, optional, nullable) — Research request ids a batch filed or reused for its other records before returning this error; absent for every other error. - `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` (string, optional, nullable) — Which meter refused the request; names what limit/used/remaining count. - `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) - `proseViolation` (list of ProseViolation, optional, nullable) — Every rejected passage of a PROSE_REJECTED write, once per problem it shows; absent for every other problem. - `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: `COMPANY`, `PERSON`, `ENTITY_VIEW`, `ENTITY_BRAND`, `PERSON_VIEW`, `WEB_SEARCH` - `circuitBreaker` (string, optional, nullable) - `code` (string, optional, nullable) — 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 describe server-side conditions a caller cannot fix: surface the error and stop rather than retry. - `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner - `detail` (string, optional) - `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. - `disposition` (enum, optional) — Whether a service-unavailable failure can be retried. - Allowed values: `TRANSIENT`, `TERMINAL` - `error` (map from string to string, optional, nullable) - `existingRecordId` (string, optional, nullable) — On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. - `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path - `feId` (string, optional, nullable) - `field` (string, optional, nullable) - `filedRunId` (list of string, optional, nullable) — Research request ids a batch filed or reused for its other records before returning this error; absent for every other error. - `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` (string, optional, nullable) — Which meter refused the request; names what limit/used/remaining count. - `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) - `proseViolation` (list of ProseViolation, optional, nullable) — Every rejected passage of a PROSE_REJECTED write, once per problem it shows; absent for every other problem. - `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: `COMPANY`, `PERSON`, `ENTITY_VIEW`, `ENTITY_BRAND`, `PERSON_VIEW`, `WEB_SEARCH` - `circuitBreaker` (string, optional, nullable) - `code` (string, optional, nullable) — 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 describe server-side conditions a caller cannot fix: surface the error and stop rather than retry. - `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner - `detail` (string, optional) - `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. - `disposition` (enum, optional) — Whether a service-unavailable failure can be retried. - Allowed values: `TRANSIENT`, `TERMINAL` - `error` (map from string to string, optional, nullable) - `existingRecordId` (string, optional, nullable) — On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. - `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path - `feId` (string, optional, nullable) - `field` (string, optional, nullable) - `filedRunId` (list of string, optional, nullable) — Research request ids a batch filed or reused for its other records before returning this error; absent for every other error. - `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` (string, optional, nullable) — Which meter refused the request; names what limit/used/remaining count. - `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) - `proseViolation` (list of ProseViolation, optional, nullable) — Every rejected passage of a PROSE_REJECTED write, once per problem it shows; absent for every other problem. - `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: `COMPANY`, `PERSON`, `ENTITY_VIEW`, `ENTITY_BRAND`, `PERSON_VIEW`, `WEB_SEARCH` - `circuitBreaker` (string, optional, nullable) - `code` (string, optional, nullable) — 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 describe server-side conditions a caller cannot fix: surface the error and stop rather than retry. - `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner - `detail` (string, optional) - `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. - `disposition` (enum, optional) — Whether a service-unavailable failure can be retried. - Allowed values: `TRANSIENT`, `TERMINAL` - `error` (map from string to string, optional, nullable) - `existingRecordId` (string, optional, nullable) — On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. - `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path - `feId` (string, optional, nullable) - `field` (string, optional, nullable) - `filedRunId` (list of string, optional, nullable) — Research request ids a batch filed or reused for its other records before returning this error; absent for every other error. - `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` (string, optional, nullable) — Which meter refused the request; names what limit/used/remaining count. - `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) - `proseViolation` (list of ProseViolation, optional, nullable) — Every rejected passage of a PROSE_REJECTED write, once per problem it shows; absent for every other problem. - `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: `COMPANY`, `PERSON`, `ENTITY_VIEW`, `ENTITY_BRAND`, `PERSON_VIEW`, `WEB_SEARCH` - `circuitBreaker` (string, optional, nullable) - `code` (string, optional, nullable) — 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 describe server-side conditions a caller cannot fix: surface the error and stop rather than retry. - `conflictingRecord` (CurrentSlugOwner, optional, nullable) — Current slug owner - `detail` (string, optional) - `details` (DomainConflictDetails, optional, nullable) — Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. - `disposition` (enum, optional) — Whether a service-unavailable failure can be retried. - Allowed values: `TRANSIENT`, `TERMINAL` - `error` (map from string to string, optional, nullable) - `existingRecordId` (string, optional, nullable) — On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. - `existingRedirect` (RedirectSlugPath, optional, nullable) — Redirect slug path - `feId` (string, optional, nullable) - `field` (string, optional, nullable) - `filedRunId` (list of string, optional, nullable) — Research request ids a batch filed or reused for its other records before returning this error; absent for every other error. - `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` (string, optional, nullable) — Which meter refused the request; names what limit/used/remaining count. - `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) - `proseViolation` (list of ProseViolation, optional, nullable) — Every rejected passage of a PROSE_REJECTED write, once per problem it shows; absent for every other problem. - `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 ### EntityListFilter Entity list filters and saved-view query state including semantic entity search. semanticQuery executes on GET /v1/entities and POST /v1/entities/search; saved views persist it for replay. Every other reused EntityFilter surface accepts the base EntityFilter, which omits semanticQuery. There is no query field: send free text describing the companies as semanticQuery, a keyword as textSearch, or a known company name as entityName. - `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. - `closedLast` (boolean, optional) — Rank closed entities (Closed, Closed (Acquihire), Inactive) after every other textSearch or semanticQuery match, ahead of relevance and sort; omitted means true. false ranks them by relevance alone. Filter them out with operatingStatus or suppressNonOperating. - `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, legal, or alias 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` - `originCountry` (list of string, optional) — Countries an entity is from: its headquarters country or the country of its current origin (founding) address, never a legal seat alone. What a nationality adjective (Colombian startups) means; headquartersCountry is only where it is based now. - `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) — Server-owned list quality gate. - Allowed values: `NONE`, `COMPANY_LISTING_READY` - `rankByProminence` (boolean, optional, nullable) — Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. - `semanticQuery` (string, optional, nullable) — Free-text semantic search phrase, this body's query text (there is no query field), such as "AI tools for dental clinics". To find one company by name, send entityName instead. Executable on POST /v1/entities/search; saved views persist it for replay. A semantic page ranks a bounded nearest-neighbor window: totalElements counts the ranked candidates reachable through continuation, not every matching entity. - `slug` (list of string, optional) — Restrict results to entity slugs. - `stage` (list of string, optional) — Investment stage classification values. - `suppressLateStage` (boolean, optional, nullable) — Exclude public and acquired companies (including acquired subsidiaries); what startup means. Private companies at any round stay, as do companies without a recorded stage or operating status. - `suppressNonOperating` (boolean, optional, nullable) — Suppress entities with terminal operating status. - `suppressZeroTotalRaised` (boolean, optional, nullable) — Suppress entities with zero or unknown USD total raised. - `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, nullable) — URL matching mode: hostPath uses host and path; domain uses the root domain. Omitted, it is domain when urlDomain is set, else hostPath. - Allowed values: `hostPath`, `domain` - `urlType` (string, optional, nullable) — Restrict URL matching to one URL type. - `yearFoundedRange` (list of IntRange, optional) — Inclusive founding-year ranges, in calendar years. ### PersonFilter Canonical person criteria contract for GET/POST/batch endpoints - `arrayFilter` (PersonListArrayFilter, optional) — Array and range filters - `entityFilter` (EntityFilter, optional) — Constraints on the associated entity, as on POST /v1/search/natural/entities: a person matches when an association (current unless isCurrent=false) points at an entity matching every field and visible in entity listings, such as yearFoundedRange, hasFundraising, or fundraiseActivity.totalRaisedRange. Omit for no associated-entity constraint. - `entityId` (string, optional, nullable) — Associated entity UUID. - `entitySlug` (string, optional, nullable) — Associated entity slug. - `firstName` (string, optional, nullable) — Person first name. - `includeAddress` (boolean, optional, nullable) — Include addresses on each person - `includeUrl` (boolean, optional, nullable) — Include URL links on each person - `investorActivity` (InvestorActivityFilter, optional) — Aggregate investor activity filters. - `isCurrent` (boolean, optional, nullable) — Filter current associations. - `lastName` (string, optional, nullable) — Person last name. - `letter` (string, optional, nullable) — First-name initial. - `personId` (list of string, optional) — Restrict results to specific person IDs. Omit or use [] for no ID restriction. - `personName` (list of string, optional) — Exact normalized match against a person's full name or slug. - `role` (string, optional, nullable) — Associated entity role or title. - `search` (string, optional, nullable) — Search keyword or phrase. Single characters valid; stop words rejected. - `semanticQuery` (string, optional, nullable) — Semantic person search phrase. A semantic page ranks a bounded nearest-neighbor window: totalElements counts the ranked candidates reachable through continuation, not every matching person. - `status` (string, optional, nullable) — Person workflow status. ### SharedDirectoryList Public directory publication metadata. - `createdAt` (datetime, required) - `directory` (enum, required) — Public directory page whose filtered view is shared. - Allowed values: `companies`, `investors`, `people` - `heading` (string, required) — Page heading the model wrote for the view. - `id` (string, required) — Stable shared-directory UUID - `slug` (string, required) — Canonical lowercase URL slug for the resource ### 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 Details of an HTTP 409 conflict. conflictType names the shape: URL_DUPLICATE when the URL is already a current URL on another record; STRICT_URL_LOOKUP when an exact URL lookup matches more than one record; DUPLICATE_CREATE_REVIEW when a create or lookup returns candidate records to review; CLASSIFICATION_INACTIVE_TAG when a classification value exists but is inactive; NEWS_SOURCE_URL when another article already has the same publication and URL. - `conflictType`: `CLASSIFICATION_INACTIVE_TAG` (CLASSIFICATION_INACTIVE_TAG) - `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 - `conflictType`: `DUPLICATE_CREATE_REVIEW` (DUPLICATE_CREATE_REVIEW) - `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. - `conflictType`: `NEWS_SOURCE_URL` (NEWS_SOURCE_URL) - `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. - `conflictType`: `STRICT_URL_LOOKUP` (STRICT_URL_LOOKUP) - `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. - `conflictType`: `URL_DUPLICATE` (URL_DUPLICATE) - `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). ### 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` ### ProseViolation One rejected passage and one problem it shows; a passage with several problems appears once per problem. - `overridable` (boolean, required) — Whether proseOverrideReason can accept this problem; ProblemDetail.hint says when an override is allowed. - `passage` (string, required) — The rejected sentence, the whole text for a text-contract violation, or the source URL for a legal-page source. - `problem` (string, required) — The problem this passage shows. - `reason` (string, required) — Why the passage was rejected and how to fix it. ### 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 or path parameter that needs attention, when applicable. - `retryable` (boolean, optional, nullable) — Whether the same logical request can be retried after the next action. ### 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) — Investor-level amount-invested ranges in the transaction currency. Use plain JSON numbers. - `amountRaisedRange` (list of DecimalRange, optional) — Per-round amount-raised ranges in USD. Use plain JSON numbers. - `dateAnnouncedRange` (DateRange, optional, nullable) — Inclusive announcement timestamp bounds on the same fundraise transaction as round and amountRaisedRange. Announcement dates do not establish funding completion dates. - `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. - `investedCountry` (list of string, optional) — Countries of the companies an investor backed, as country names or ids; a deal matches when its company's current headquarters is in one of them. Restricts returned entities to investors with such a deal inside the investment-activity horizon; with investedRound or investedIndustry, the same deal must match each. - `investedIndustry` (list of string, optional) — Industry terms for the companies an investor backed, such as Software, Artificial Intelligence, or Fintech; a term matches a portfolio company whose industry or industry classification name contains it as whole words, case-insensitively. Restricts returned entities to investors with such a deal inside the investment-activity horizon; with investedRound, the same deal must match both. - `investedRound` (list of string, optional) — Round labels of the deals an investor joined, such as Seed, Pre-Seed, or Series A; restricts returned entities to investors with such a deal inside the investment-activity horizon. - `investorActivity` (InvestorActivityFilter, optional) — Aggregate investor activity filters. - `investorName` (list of string, optional) — Investor names. Exact, case-sensitive match on an investor entity's brand or legal name or an individual investor's full name; restricts returned entities to companies with a fundraise that investor joined. - `lastRoundYearRange` (list of IntRange, optional) — Last-round-year ranges for each entity's most recent fundraise round. - `rankByInvestmentActivity` (boolean, optional, nullable) — True ranks returned investors by recent deal activity ahead of any sort: each deal inside investedRound, investedIndustry, and investedCountry (every deal when all are empty) adds a weight that decays to zero over the investment-activity horizon, nudged by the investor's known USD check. Restricts returned entities to investors with such a deal. - `round` (list of string, optional) — Fundraise round labels, such as Seed or Series A. - `totalRaisedRange` (list of DecimalRange, optional) — Total-raised ranges across all rounds in USD. Use plain JSON numbers. - `valuationRange` (list of DecimalRange, optional) — Post-money valuation ranges in USD. ### EntityFilterLogoOption Logo sort priority for entity search - `sortPriority` (enum, optional) — Logo sort priority. - Allowed values: `NONE`, `ANY_LOGO_FIRST`, `REAL_LOGO_FIRST` ### PersonListArrayFilter Array and range filters for person list endpoints - `amountInvestedRange` (list of DecimalRange, optional, nullable) - `amountRaisedRange` (list of DecimalRange, optional, nullable) - `entityName` (list of string, optional, nullable) — Associated entity names. - `investedCompany` (list of string, optional, nullable) — Invested company names. - `personTitle` (list of string, optional, nullable) — Person titles. - `round` (list of string, optional, nullable) — Fundraise round labels. - `totalInvestmentCount` (list of IntRange, optional, nullable) - `typeRecord` (list of enum, optional, nullable) — Associated entity type scope. Omit or use [] for any associated type. - Allowed values: `Company`, `Investment Firm`, `Fund`, `Nonprofit`, `Government`, `Organization`, `Business Line`, `Product`, `Service` ### EntityFilter Entity list and search filters. GET flattens these fields as query parameters; POST accepts the same shape as JSON. - `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. - `closedLast` (boolean, optional) — Rank closed entities (Closed, Closed (Acquihire), Inactive) after every other textSearch or semanticQuery match, ahead of relevance and sort; omitted means true. false ranks them by relevance alone. Filter them out with operatingStatus or suppressNonOperating. - `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, legal, or alias 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` - `originCountry` (list of string, optional) — Countries an entity is from: its headquarters country or the country of its current origin (founding) address, never a legal seat alone. What a nationality adjective (Colombian startups) means; headquartersCountry is only where it is based now. - `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) — Server-owned list quality gate. - Allowed values: `NONE`, `COMPANY_LISTING_READY` - `rankByProminence` (boolean, optional, nullable) — Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. - `slug` (list of string, optional) — Restrict results to entity slugs. - `stage` (list of string, optional) — Investment stage classification values. - `suppressLateStage` (boolean, optional, nullable) — Exclude public and acquired companies (including acquired subsidiaries); what startup means. Private companies at any round stay, as do companies without a recorded stage or operating status. - `suppressNonOperating` (boolean, optional, nullable) — Suppress entities with terminal operating status. - `suppressZeroTotalRaised` (boolean, optional, nullable) — Suppress entities with zero or unknown USD total raised. - `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, nullable) — URL matching mode: hostPath uses host and path; domain uses the root domain. Omitted, it is domain when urlDomain is set, else hostPath. - Allowed values: `hostPath`, `domain` - `urlType` (string, optional, nullable) — Restrict URL matching to one URL type. - `yearFoundedRange` (list of IntRange, optional) — Inclusive founding-year ranges, in calendar years. ### InvestorActivityFilter Aggregate investor activity filters from distinct fundraise deals and USD amounts. - `averageAmountInvestedUsdRange` (list of DecimalRange, optional) — Average USD amount-invested ranges with inclusive bounds. - `largestAmountInvestedUsdRange` (list of DecimalRange, optional) — Largest USD amount-invested ranges with inclusive bounds. - `smallestAmountInvestedUsdRange` (list of DecimalRange, optional) — Smallest USD amount-invested ranges with inclusive bounds. - `totalAmountInvestedUsdRange` (list of DecimalRange, optional) — Total USD amount-invested ranges with inclusive bounds. - `totalInvestmentRange` (list of IntRange, optional) — Distinct fundraise-deal count ranges for an investor, with inclusive integer bounds. ### 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. - `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. - `score` (integer, optional) — 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. - `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. ### UrlDuplicateJoin Entity or person that 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) — Identifier of the existing URL record that already holds this address. ### 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) — Owning entity id; set only when personId is absent. - `personId` (string, optional, nullable) — Owning person id; set only when entityId is absent. ### 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. ### DateRange ISO-8601 timestamp range for temporal filters. - `max` (datetime, optional, nullable) — Inclusive latest timestamp. - `min` (datetime, optional, nullable) — Inclusive earliest timestamp. ## Examples **Request** ```json {} ``` **Response** ```json { "description": "string", "publication": { "createdAt": "2024-01-15T09:30:00Z", "directory": "companies", "heading": "string", "id": "string", "slug": "aventure-vc" }, "title": "string", "entityFilter": { "acceleratorBrand": [ "string" ], "acceleratorCohort": [ "string" ], "acceleratorName": [ "string" ], "acceleratorStatus": [ "string" ], "affinity": [ "string" ], "closedLast": true, "employeeCountRange": [ { "max": 1, "min": 1 } ], "entityId": [ "string" ], "entityName": [ "string" ], "featured": true, "fundraiseActivity": { "amountInvestedRange": [ { "max": 1.1, "min": 1.1 } ], "amountRaisedRange": [ { "max": 1.1, "min": 1.1 } ], "dateAnnouncedRange": { "max": "2024-01-15T09:30:00Z", "min": "2024-01-15T09:30:00Z" }, "investedCompanyName": [ "string" ], "investedCountry": [ "string" ], "investedIndustry": [ "string" ], "investedRound": [ "string" ], "investorActivity": { "averageAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "largestAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "smallestAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "totalAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "totalInvestmentRange": [ { "max": 1, "min": 1 } ] }, "investorName": [ "string" ], "lastRoundYearRange": [ { "max": 1, "min": 1 } ], "rankByInvestmentActivity": true, "round": [ "string" ], "totalRaisedRange": [ { "max": 1.1, "min": 1.1 } ], "valuationRange": [ { "max": 1.1, "min": 1.1 } ] }, "hasFundraising": true, "headquartersCity": [ "string" ], "headquartersCountry": [ "string" ], "headquartersState": [ "string" ], "industry": [ "string" ], "letter": "string", "location": [ "string" ], "logoOption": { "sortPriority": "NONE" }, "mainProduct": [ "string" ], "operatingStatus": [ "Operating" ], "originCountry": [ "string" ], "person": [ "string" ], "portfolioHeadquartersCity": [ "string" ], "portfolioHeadquartersCountry": [ "string" ], "portfolioHeadquartersState": [ "string" ], "qualityGate": "NONE", "rankByProminence": true, "semanticQuery": "string", "slug": [ "aventure-vc" ], "stage": [ "string" ], "suppressLateStage": true, "suppressNonOperating": true, "suppressZeroTotalRaised": true, "tag": [ "string" ], "textSearch": "string", "typeCustomer": [ "string" ], "typeModel": [ "string" ], "typeOwnership": [ "string" ], "typeRecord": [ "Company" ], "typeRevenue": [ "string" ], "typeTechnologyUsed": [ "string" ], "url": "string", "urlDomain": "example.com", "urlMatchMode": "domain", "urlType": "website", "yearFoundedRange": [ { "max": 1, "min": 1 } ] }, "personFilter": { "arrayFilter": { "amountInvestedRange": [ { "max": 1.1, "min": 1.1 } ], "amountRaisedRange": [ { "max": 1.1, "min": 1.1 } ], "entityName": [ "string" ], "investedCompany": [ "string" ], "personTitle": [ "string" ], "round": [ "string" ], "totalInvestmentCount": [ { "max": 1, "min": 1 } ], "typeRecord": [ "Company" ] }, "entityFilter": { "acceleratorBrand": [ "string" ], "acceleratorCohort": [ "string" ], "acceleratorName": [ "string" ], "acceleratorStatus": [ "string" ], "affinity": [ "string" ], "closedLast": true, "employeeCountRange": [ { "max": 1, "min": 1 } ], "entityId": [ "string" ], "entityName": [ "string" ], "featured": true, "fundraiseActivity": { "amountInvestedRange": [ { "max": 1.1, "min": 1.1 } ], "amountRaisedRange": [ { "max": 1.1, "min": 1.1 } ], "dateAnnouncedRange": { "max": "2024-01-15T09:30:00Z", "min": "2024-01-15T09:30:00Z" }, "investedCompanyName": [ "string" ], "investedCountry": [ "string" ], "investedIndustry": [ "string" ], "investedRound": [ "string" ], "investorActivity": { "averageAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "largestAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "smallestAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "totalAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "totalInvestmentRange": [ { "max": 1, "min": 1 } ] }, "investorName": [ "string" ], "lastRoundYearRange": [ { "max": 1, "min": 1 } ], "rankByInvestmentActivity": true, "round": [ "string" ], "totalRaisedRange": [ { "max": 1.1, "min": 1.1 } ], "valuationRange": [ { "max": 1.1, "min": 1.1 } ] }, "hasFundraising": true, "headquartersCity": [ "string" ], "headquartersCountry": [ "string" ], "headquartersState": [ "string" ], "industry": [ "string" ], "letter": "string", "location": [ "string" ], "logoOption": { "sortPriority": "NONE" }, "mainProduct": [ "string" ], "operatingStatus": [ "Operating" ], "originCountry": [ "string" ], "person": [ "string" ], "portfolioHeadquartersCity": [ "string" ], "portfolioHeadquartersCountry": [ "string" ], "portfolioHeadquartersState": [ "string" ], "qualityGate": "NONE", "rankByProminence": true, "slug": [ "aventure-vc" ], "stage": [ "string" ], "suppressLateStage": true, "suppressNonOperating": true, "suppressZeroTotalRaised": true, "tag": [ "string" ], "textSearch": "string", "typeCustomer": [ "string" ], "typeModel": [ "string" ], "typeOwnership": [ "string" ], "typeRecord": [ "Company" ], "typeRevenue": [ "string" ], "typeTechnologyUsed": [ "string" ], "url": "string", "urlDomain": "example.com", "urlMatchMode": "domain", "urlType": "website", "yearFoundedRange": [ { "max": 1, "min": 1 } ] }, "entityId": "string", "entitySlug": "string", "firstName": "string", "includeAddress": true, "includeUrl": true, "investorActivity": { "averageAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "largestAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "smallestAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "totalAmountInvestedUsdRange": [ { "max": 1.1, "min": 1.1 } ], "totalInvestmentRange": [ { "max": 1, "min": 1 } ] }, "isCurrent": true, "lastName": "string", "letter": "A", "personId": [ "string" ], "personName": [ "string" ], "role": "string", "search": "AI", "semanticQuery": "string", "status": "string" }, "sort": "string" } ``` **SDK Code** ```python import requests url = "https://api.aventure.vc/v1/directory/shared" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.aventure.vc/v1/directory/shared'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', '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/directory/shared" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") 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/directory/shared") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' 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 response = Unirest.post("https://api.aventure.vc/v1/directory/shared") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('POST', 'https://api.aventure.vc/v1/directory/shared', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.aventure.vc/v1/directory/shared"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "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/directory/shared")! 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() ```