Replace research snippet
Replaces a research snippet for an entity. Omitted optional body fields are cleared. The visible default (recognized types shown, unrecognized types hidden unless visible=true is sent), validation, and the NOT_VISIBLE warning (returned only when the saved row is hidden) all match create.
Authentication
User bearer token: Supabase or Clerk session JWT, Clerk OAuth access token, or Clerk personal API key
Admin API key for system-to-system write operations
Path parameters
Query parameters
Provider name for provider-native IDs or slugs.
Provider-native source ID.
Provider-native source slug.
Actor type; inferred as agent when agentChassis and agentModel are supplied, or as employee from an authenticated user JWT session.
Agent chassis token for agent-authored writes.
Agent model id for agent-authored writes.
Request
Snippet body text. Recognized types enforce the length and paragraph rules returned by the types endpoint. Write ’$’ literally in currency amounts — escaped forms such as ‘$95 million’ are rejected as shell artifacts; in a shell, pass the text via ANSI-C $’…’ quoting or —from-file.
Research snippet type token. Use one listed by GET /v1/entities/research/snippets/types for validation and default visibility; an unrecognized token is saved hidden (visible=false) unless visible=true is sent.
Override suspected shell-strip rejection for intentional prose that looks like a money phrase without a currency marker, or that intentionally contains an escape sequence before ’$’. Prefer fixing shell quotes or using —from-file; set true only after confirming the value is intentional.
Create defaults to true and appends a NEW current row, demoting the prior current row of this type to inactive history. Set false to write a non-current historical row.
Primary row among current snippets of this type. Defaults to true when the row is current; promoting demotes the prior primary.
Whether the snippet appears in default reads. Omit to use the type default (recognized types visible, unrecognized types hidden); set explicitly to override.
Response
Current row. The live snippet for its type; demoted historical rows read only with includePrivate.
Whether the snippet appears in default reads. Admin/private reads (includePrivate) also return hidden rows.
Derived character/word counts and governed-contract compliance for this snippet row; null when not evaluated.