http/enrich

Built-in enrich adapter for person records: its manifest, needs, provides, config keys, cost, and an example step

What you'll learn

You're about to put http/enrich in a step and want its keys, fields, credentials, and cost before plan tells you.

  • what the adapter needs and provides
  • every with: key it accepts
  • what it costs and which credential it demands

A built-in enrich adapter for person records: it needs the step's uses: fields and declares no fields of its own. It publishes no per-record estimate, so plan prints ?, and it demands no credential.

Manifest

KeyValue
idhttp/enrich
version1
roleenrich
entity typeperson
credentialsnone
cost estimate per recordnot published

Needs

The fields the step's uses: line names, and nothing else.

Provides

None declared. What it writes depends on its with: config, and plan reports the fields as the step resolves them.

Config keys

The keys with: accepts. Plan rejects any other key.

KeyTypeRequiredWhat it sets
authobject
auth.envstringyes
auth.namestring
auth.prefixstring
auth.typeone of header, query, beareryes
entity_typestring
extractobjectInline JSON mode: field → dotted response path
fieldstringThe declared content field (markdown mode) — canonical or namespaced
freshness_daysintegeryesREQUIRED, no default: web content rots. Doubles as the step's cache window.
headersobject
keep_payloadsbooleanper-step override of payload retention
markdownbooleanFetch a page and store it as markdown under field:
max_bytesintegerResponse size cap (default 262144). An oversized response stores no field — the record advances counted empty, never truncated silently — and is still retained as a payload for the retention window.
methodone of GET, POSTDefault GET
queryobject
urlstringyesRequest URL, templated from {{record.<field>}} placeholders — which are also the step's derived needs

Example

A minimal step:

  - id: enrich
    use: http/enrich