addedInput schema / properties / api_key / description
Added value: +"API key for this call. Omit to fall back to the Authorization: Bearer / X-API-Key request header (streamable-HTTP only), then the VHGENGINE_API_KEY env var (the stdio default). No key resolvable -> unauthorized."
addedInput schema / properties / hook_id / description
Added value: +"Which bought hook this result belongs to: the hook_id from a generate/batch/remix response or list_hooks. Must be a hook you own."
addedInput schema / properties / idempotency_key / description
Added value: +"Caller-chosen replay key (any string, unique per intended effect). A repeat call with the SAME key returns the stored result and is NEVER charged twice; the same key with different arguments is an idempotency_conflict. Omit and every call is a fresh, separately charged operation."
addedInput schema / properties / likes / description
Added value: +"Likes at report time, >=0. Omit if you cannot read it."
addedInput schema / properties / likes / minimum
Added value: +0
addedInput schema / properties / platform / description
Added value: +"Where the hook was actually posted. Required."
addedInput schema / properties / posted_at / description
Added value: +"When it went live, ISO-8601 UTC ('YYYY-MM-DDTHH:MM:SSZ'). May be in the past; more than 48h in the FUTURE is invalid_request."
addedInput schema / properties / retention_pct / description
Added value: +"Average view-through as a PERCENT, 0-100 (not a 0-1 fraction). Omit if the platform does not expose it."
addedInput schema / properties / retention_pct / maximum
Added value: +100
addedInput schema / properties / retention_pct / minimum
Added value: +0
addedInput schema / properties / url / description
Added value: +"Public http(s) URL of the post, for your own audit trail. Must carry a host; omit entirely rather than passing a placeholder."
addedInput schema / properties / views / description
Added value: +"Views the post had accrued at report time, >=0. Required: it is the only field the corpus calibrates against. Report again later (up to 20 reports per hook) to record how it matured."
addedOutput schema / description
Added value: +"Acknowledgement that your telemetry landed, plus any reward. Free to call."
addedOutput schema / properties
Added value: +{
+ "aggregate": {
+ "description": "Rolled-up totals for this hook across every report you have made.",
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "credits_remaining": {
+ "description": "Your balance after the reward. Present only when one was granted.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "outcome": {
+ "description": "The stored row, as recorded.",
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "replayed": {
+ "description": "true when an idempotency_key replayed a stored report.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "reward_credits": {
+ "description": "Credits granted for this report. Only a hook's FIRST report earns one, so later reports return 0.",
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+}
removedOutput schema / title
Removed value: -"report_outcomeDictOutput"