context_materials.create
What it does
Record a source observation, external/local reference or attributed note. Original document identity and grants do not change. No external source is fetched.
Before you send it
An authorized OAuth connection may call it, including a headless client. Effective membership, application grant and token permissions still apply. Describe context_materials.create through GET /v1/catalog/commands/{name} before acting.
This command does not accept source_document_id in its envelope. Any input evidence requirements remain as documented below.
Inputs
Put these fields inside the envelope’s input object. The outer envelope names the command, a stable idempotency_key and effective_at; request and recovery rules explain those separately. Use exact minor-unit integer strings for monetary fields. Take existing IDs from prior reads or command results; choose a new identity only where the command asks for one.
Required means required within its containing object; an optional parent can be omitted.
| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
material | schema-defined | Yes | Choose a matching alternative in the exact schema below. |
After acceptance
When the command emits events, its documented effects and receipt are recorded in the command transaction. The response returns commandId, replayed, the command-specific result below and emitted events with their IDs and CIDs. A command is not automatically a cash movement or revenue recognition: use the behavior above to determine what this command records.
Inspect result and the affected records or reports before continuing. Save returned identifiers for later calls. Fetch GET /v1/commands/{id} with commandId to recover the accepted receipt; retry the same intent with the same idempotency key if the response was lost. Some commands can succeed with events: [] and return a transient result and commandId without persisting a receipt. A lookup of that ID can return null; retain the returned result and verify the affected record. Retrying can re-evaluate the current state rather than replay a stored result. A domain no_change is a separate success outcome with no persisted receipt.
Result fields
Required means required within its containing object; an optional parent can be omitted.
| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
materialId | string | Yes | Minimum length: 1. Maximum length: 512. |
cid | string | Yes | Minimum length: 1. Maximum length: 512. |
observationId | string | Yes | Minimum length: 1. Maximum length: 512. |
All commands · Operation and errors · Reusable schemas
Keep credentials out of prompts; rehearse writes only in a disposable sandbox.
Exact request schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"const": "context_materials.create"
},
"input": {
"type": "object",
"properties": {
"material": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"const": "retained"
},
"documentId": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"mediaType": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"origin": {
"type": "object",
"properties": {
"locator": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"const": "https"
},
"url": {
"type": "string",
"minLength": 1,
"maxLength": 4096
}
},
"required": [
"kind",
"url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "local"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"workspace": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"repository": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"anchor": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"kind",
"path"
],
"additionalProperties": false
}
]
},
"externalId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"observedAt": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"sourceCreatedAt": {
"type": "string",
"minLength": 1,
"maxLength": 40
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"kind",
"documentId",
"title"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "reference"
},
"locator": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"const": "https"
},
"url": {
"type": "string",
"minLength": 1,
"maxLength": 4096
}
},
"required": [
"kind",
"url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "local"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"workspace": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"repository": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"anchor": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"kind",
"path"
],
"additionalProperties": false
}
]
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": {
"type": "string",
"minLength": 0,
"maxLength": 262144
}
},
"required": [
"kind",
"locator",
"title"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "note"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 262144
},
"citations": {
"type": "array",
"maxItems": 20,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 8192
}
}
},
"required": [
"kind",
"title",
"text"
],
"additionalProperties": false
}
]
}
},
"required": [
"material"
],
"additionalProperties": false
},
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "A key you choose, stable for this one command: retrying with it returns the original receipt instead of running again; reusing it for a different command is refused."
},
"effective_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When the change takes effect in the books, in UTC with Z: the business date it happened, not when you record it."
}
},
"required": [
"name",
"input",
"idempotency_key",
"effective_at"
],
"additionalProperties": false
}Accepted command receipt
{
"type": "object",
"required": [
"commandId",
"replayed",
"result",
"events"
],
"properties": {
"commandId": {
"type": "string"
},
"replayed": {
"type": "boolean"
},
"imported": {
"const": true,
"description": "The command's events are history from before the business joined Economico, recorded as an import: free of monthly events."
},
"result": {
"type": "object",
"properties": {
"materialId": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"cid": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"observationId": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"materialId",
"cid",
"observationId"
],
"additionalProperties": false
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"cid": {
"type": "string"
}
}
}
}
}
}Example request
{
"name": "context_materials.create",
"input": {
"material": {
"kind": "note",
"title": "Renewal observation",
"text": "Customer asked about an annual agreement."
}
},
"effective_at": "2026-09-01T00:00:00Z",
"idempotency_key": "context_materials.create-example-0"
}