Create a stable Markdown note with optional resource and revisit time.

Create a stable Markdown note with optional resource and revisit time.

post/v1/notes

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/notes
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable opaque identity for one logical POST. Reuse only with the same method, path, actor, and body for transport retries. A completed receipt replays its original result, including a refusal; changed input with the same key is rejected. After a refused action and access recovery, use a new key for the new attempt. Follow retryable and recovery guidance if the operation is still running or its outcome is unknown.

Request body

body_markdownstring required

Complete Markdown body. Keep observed facts separate from assumptions; for unfinished work, preserve the baseline and enough context to check the outcome on revisit. Use exact record ids when referring to evidence.

context_topicsContextTopic[]

Tags this active note as durable workspace context for the listed standard topics, so future agents receive it directly from open. Use for durable user context, meaning something the user said or a household fact that open lists in context_needed which you inferred from the records, stated as your inference with its evidence. Omit it for ordinary working or re-check notes.

Response

Created note envelope.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

No recorded changes to this operation across all 1 revision of this API.