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
| Key | Value |
|---|---|
| id | http/enrich |
| version | 1 |
| role | enrich |
| entity type | person |
| credentials | none |
| cost estimate per record | not 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.
| Key | Type | Required | What it sets |
|---|---|---|---|
auth | object | ||
auth.env | string | yes | |
auth.name | string | ||
auth.prefix | string | ||
auth.type | one of header, query, bearer | yes | |
entity_type | string | ||
extract | object | Inline JSON mode: field → dotted response path | |
field | string | The declared content field (markdown mode) — canonical or namespaced | |
freshness_days | integer | yes | REQUIRED, no default: web content rots. Doubles as the step's cache window. |
headers | object | ||
keep_payloads | boolean | per-step override of payload retention | |
markdown | boolean | Fetch a page and store it as markdown under field: | |
max_bytes | integer | Response 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. | |
method | one of GET, POST | Default GET | |
query | object | ||
url | string | yes | Request URL, templated from {{record.<field>}} placeholders — which are also the step's derived needs |
Example
A minimal step:
- id: enrich
use: http/enrich