enrichment

Preflight Enrich Row Async

Changed on
post/api/v1/enrichment/enrich_async/{enrichment_id}/preflight

Request

  • Base URL
    https://api.maia-analytics.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.maia-analytics.com/api/v1/enrichment/enrich_async/{enrichment_id}/preflight
  • Auth
    HTTP bearer

Request body

feature_idsstring[] nullable
selection_limitinteger nullable
allowance_confirmation_fingerprintstring nullable
high_priorityboolean

Execute with high priority if True

point_actionboolean

True for a deliberate single-cell enrichment. Only a point action skips the coordinator; column kickoffs stay coordinator-keyed even when they resolve to a single row.

Example request

{
  "feature_ids": [
    "00000000-0000-0000-0000-000000000001"
  ]
}

Response

Successful Response

admittedboolean required

Changes

  • 604ea84d0ff7Revision changes
    • warning

      deleted the query request parameter token

    • warning

      added the new budget_exhausted enum value to the / response property for the response status

    • warning

      added the new budget_unavailable enum value to the / response property for the response status

    • warning

      added the new confirmation_required enum value to the / response property for the response status

    • warning

      added the new paid_access_blocked enum value to the / response property for the response status

    • warning

      added the new run_unaffordable enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      removed the discovery_allowance_confirmation_required enum value from the / response property for the response status

    • info

      removed the discovery_allowance_exhausted enum value from the / response property for the response status

    • info

      removed the discovery_allowance_run_unaffordable enum value from the / response property for the response status

    • info

      removed the discovery_allowance_unavailable enum value from the / response property for the response status

    • info

      added the required property / to the response with the status

  • e17aaa23de12Revision changes
    • warning

      added the new discovery_allowance_run_unaffordable enum value to the / response property for the response status