Save fact
save_factAdd a fact to the brand's fact library, or with fact_id edit, confirm or reject one. Set from_user only when the user told you the fact in this conversation; it is then confirmed as theirs. A fact you found yourself, on their site, the web or a draft, is proposed with its source_url and waits for the user to confirm it. The same fact is stored once. Free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | number: a figure with its period. process: what happens, step by step. example: a named customer or case. claim: anything else the brand states. | |
| text | No | The fact as one self-contained sentence a page could quote. | |
| brand | Yes | Brand or study: its ID from list_brands, or its exact name. A partial name is refused. | |
| status | No | With fact_id: confirm a proposed fact once the user agrees, or reject it. | |
| fact_id | No | Edit this fact, from search_facts. Leave out to add one. | |
| segment | No | The segment ID or name it applies to; leave out for the whole brand. With fact_id, none makes it brand-wide. | |
| from_user | No | True only when the user told you this fact in this conversation. | |
| source_url | No | Where you found it. A new fact needs it unless from_user is true. | |
| stale_after | No | YYYY-MM-DD after which to re-check it, for figures and dated claims. With fact_id, none clears it. | |
| source_excerpt | No | The words on the source the fact rests on. | |
| idempotency_key | Yes | A unique key for this intended action. Reuse it with identical arguments when retrying: the write is not made again, and the reply is the first call's resource as saved (replayed: true) with current status; read tools show the resource's current state. Use a new key for another action. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| generated_at | Yes | RFC 3339 time the response was made. | |
| schema_version | Yes |