capsule

Convert chosen capsules into entries of an existing log Type, one entry each. dry_run previews; a write needs the preview_token and is all-or-nothing.

Changed on
post/api/preview/capsules/batch/convert-to-entries

Request

  • Base URL
    https://symbol.chat (the document declares no server; this is the origin it was published from)
  • URL
    https://symbol.chat/api/preview/capsules/batch/convert-to-entries
  • Auth
    • HTTP bearer
    • or API key in cookie __Secure-next-auth.session-token
    • or OAuth 2
      Authorization code: https://mcp.symbol.chat/authorize
      Token URL: https://mcp.symbol.chat/token

Request body

capsuleIdsstring[] required

The capsules to convert, each into one entry.

date_sourcestring required

Which date each entry is filed under: created_at, updated_at, or field:<name> for a date/datetime field the capsules carry. A capsule whose field is empty is filed by its creation date.

dry_runboolean required

true writes nothing and answers the preview. false converts, and needs the preview_token a dry run returned.

field_mapobject

Override the default mapping. Keys are source field names plus @title, @body and @tags; each maps to a field of the log's entry schema, or null to leave it out (it is then listed under unplaced).

preview_tokenstring

The preview_token from a dry run of the same request. Required when dry_run is false; it proves the caller saw what will happen.

targetTypeIdstring required

The log Type the entries go into.

target_log_capsule_idstring

The log the entries go into, required for an owner-bound or manual-rollover log Type: a log capsule of that Type, or an owner capsule whose log is created on first use. Omit for a dated log, which files each entry by date.

Response

Successful response

date_fallbacksinteger required

Capsules whose chosen date field is empty, filed by their creation date.

dry_runboolean required
preview_tokenstring required

Pass back with dry_run: false to convert exactly what this preview shows.

Changes