Topolo Docs Topolo Platform
Open workspace

Compose

Worked requests, responses, verification and recovery for all 22 Compose actions.

Compose action reference

Discover the exact action and granted target, validate input and inspect the plan before executing. Private exports and documented effects require confirmation.

  • Export Compose organization data: Export Compose-owned documents, versions, comments, review requests, export attempts and workspace mirrors across the authenticated organization. This private-data export requires privacy:read and explicit authorization.
  • Erase Compose organization data: Permanently erase Compose-owned data for the authenticated organization with literal confirmation ERASE. Documents in review or pending review requests block erasure; other platform services retain their own records.
  • Get Compose workspace metrics: Read the canonical Compose widget response for the workspace resolved through platform grants, including active document, review, approval and saved-version counts.
  • Get Compose formats and identity: Read authenticated identity and the supported document types, styles, export formats, edit modes and approval statuses. Bootstrap does not return a granted workspace identifier.
  • Archive empty Compose workspace: Ask the platform to archive an authorized empty Compose workspace, then remove its local mirror. Any document, including archived documents, blocks this operation.
  • List Compose documents: List up to 200 documents created by the authenticated user in the selected authorized workspace, optionally including archived records. The read can initialize the local workspace mirror.
  • Create Compose document: Create a new workspace document from supplied text and metadata without calling a model. Compose saves its initial created version and returns the document identifier.
  • Get Compose document: Read one document in the authorized organization and workspace, including current markdown, provenance, approval metadata and archival state. This read can initialize the local workspace mirror.
  • Update Compose document: Update one document from supplied fields. Omitted values retain existing state; the operation creates no version snapshot, and approval fields do not complete the review workflow.
  • Delete Compose document permanently: Permanently delete a document and its saved versions in the selected workspace. The successful raw response is HTTP 204 with an empty body and no identifier.
  • Archive Compose document: Hide a document from the active list by setting archivedAt, while retaining its content and saved versions. Archived documents still count toward the workspace archival emptiness check.
  • Restore archived Compose document: Clear a document’s archivedAt so it can appear in the active document list. This restores archival visibility, not an older version of its text.
  • Add Compose document comment: Persist a comment and unique mentions on an accessible document, then attempt platform notifications. A successful response proves saved comment metadata, not delivery.
  • Request Compose document review: Create a pending review assigned to one user and update document approval metadata to in_review. Notification emission is attempted after persistence and does not prove delivery.
  • Complete assigned Compose review: Record one pending review decision as approved or rejected. The authenticated user must be the assigned reviewer; a completed review cannot be decided again.
  • Record Compose export attempt: Record the outcome of a client document export attempt, deduplicate its identifier and attempt usage metering for a new ready result. This action returns no file bytes or download URL.
  • List saved Compose document versions: Read the 25 newest saved snapshots of an accessible document. This read can initialize the local workspace mirror and exposes no continuation cursor.
  • Save Compose document snapshot: Save a manual snapshot of the current accessible document’s text and provenance. This creates a new version without editing the current document.
  • Restore saved Compose document text: Replace current text and provenance with an accessible saved version, first saving pre_restore text and then a restore snapshot. Approval metadata resets to draft.
  • Generate and save Compose document: Generate through Nexus text from a prompt and audience, then create a new Compose document and generated snapshot. Every successful call creates a new document.
  • Revise and save Compose document: Request a Nexus revision of supplied text. If documentId resolves in the selected workspace, update that document and snapshot the revised result; otherwise create a new document from the snapshot.
  • Preview Compose revision suggestion: Preview through Nexus suggested revised text without saving a document or version. The operation still requests an AI completion and requires an authorized write-capable workspace context.

Evidence

Responses were captured from the actual Compose Worker using synthetic users, organizations, content and identifiers. Tests simulate Auth, Nexus, Notify, metering and platform workspace transport and use an in-memory D1 adapter or local SQLite. They prove local handler behavior, not live model correctness, provider cost, notification delivery, real workspace grants or cross-store atomicity. HTTP 204 responses are exactly empty strings in the SDK transport. Replace fixture identifiers through credential-scoped discovery.