/

Docs from a schema DocsSign in

Docs
History
Schema
Generate

Filter operations

attachment5

bridge2

capsule31

get/api/preview/capsulesList capsules visible to the caller
post/api/preview/capsulesCreate a capsule
post/api/preview/capsules/batch/archiveArchive or restore many capsules in a single call
post/api/preview/capsules/batch/archive-impactPreview what archiving capsules would pause (links, public pages, skills, embeds, and access for the people they are shared with) and, per capsule, whether you could archive it
post/api/preview/capsules/batch/convert-to-entriesConvert 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.
post/api/preview/capsules/batch/deleteDelete many capsules in a single call. A batch containing a capsule other capsules cite needs confirm_citations: true.
post/api/preview/capsules/batch/delete-impactPreview which capsules cite the capsules about to be deleted (count and a sample of five)
post/api/preview/capsules/batch/edit-fieldsSet or clear one field across many capsules, with a dry run that counts first
post/api/preview/capsules/batch/edit-tagsAdd, remove or replace tags across many capsules, with a dry run that counts first
post/api/preview/capsules/batch/moveMove many capsules to a different type in a single call
post/api/preview/capsules/batch/move-impactPreview the side effects (exposure, dropped collections, template changes, refusals) of moving capsules into a Type
post/api/preview/capsules/batch/move-to-workspaceMove or copy personal capsules into an organization workspace
post/api/preview/capsules/batch/recoverRecover many capsules from Recently deleted in a single call
get/api/preview/capsules/by-refResolve a capsule by its @type/ref or @type/alias
get/api/preview/capsules/contextGet Type context (guidance + recent capsules) for AI assistants
get/api/preview/capsules/deletedList the capsules in one workspace you deleted or may recover, deleted within the last 30 days, newest first
post/api/preview/capsules/read-costMeasure what reading capsules costs in characters, alone and read together; capsules you cannot read come back not available
get/api/preview/capsules/{id}Get a single capsule by id
put/api/preview/capsules/{id}Update a capsule
delete/api/preview/capsules/{id}Delete a capsule. It moves to Recently deleted and can be recovered for 30 days; ?permanent=true deletes it for good now (also for a capsule already in Recently deleted). A capsule that owns a log answers 409 `owned_log_present` naming the log and its entry count until `confirmOwnedLog=true` is sent; the log is then deleted with it, or detached and kept when you may not delete it. A log you may not read is never named: it is detached and kept, with no 409. A capsule other capsules cite needs ?confirm_citations=true; sending confirm_citations=true or confirm_citations=false opts in to that gate before its breaking-change effective date.
patch/api/preview/capsules/{id}/archiveArchive or restore a single capsule
get/api/preview/capsules/{id}/backlinksList capsules that reference the given capsule
post/api/preview/capsules/{id}/duplicateDuplicate a capsule
get/api/preview/capsules/{id}/graphWalk the references / backlinks graph rooted at this capsule
post/api/preview/capsules/{id}/guidance-checkCheck whether a read of this capsule may leave its Type's guidance out, and get fresh guidance checks
get/api/preview/capsules/{id}/instruction-exportRender a capsule as an instruction file, with referenced summaries and bodies in place
post/api/preview/capsules/{id}/recoverRecover a capsule from Recently deleted, with the owned log deleted with it. Links withdrawn at delete stay withdrawn.
get/api/preview/capsules/{id}/referencesList capsules that the given capsule references
delete/api/preview/capsules/{id}/skillStop packaging a capsule as a skill and withdraw the served skill
post/api/preview/capsules/{id}/skill/publishPublish a capsule as a skill (enabling it when needed), optionally under a chosen name
get/api/preview/capsules/{id}/versions/compareCompare two versions of a capsule: title, summary, body lines and field values. `to` defaults to the newest version you can see. Needs a plan with revision history.

collection9

discover3

follow3

history2

import3

log-entry3

mention1

messaging1

project9

search1

share20

snapshot1

sync2

tag2

type10

user-profile6

workspace1

capsule

Changes to Recover many capsules from Recently deleted in a single call

post/api/preview/capsules/batch/recover

Oct 19, 20265778844d1f9e Revision changes
- info
  endpoint added