Save Compose document snapshot

Outcome

Save a manual snapshot of the current accessible document’s text and provenance. This creates a new version without editing the current document.

Before you start

• Verify the authenticated identity, environment and pinned organization before preparing an action.
• The published application permission is workspace:write. Discover and select a granted Compose workspace separately from action input. A supplied identifier does not grant access.
• A read_write workspace grant is required, including model suggestion previews that do not persist document text.
• Authorize the documented effects or private-data export before CLI --confirm or MCP confirm:true. HTTP method alone does not establish a read-only operation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_compose.documents.versions.create --detail --json
topolo resources topolo-compose --json
topolo workspaces list topolo-compose --json

• Select the granted workspace id as COMPOSE_WORKSPACE_ID. Use document and version ids returned by accessible reads; fixture ids confer no live access.

Request

POST /api/documents/{documentId}/versions

Save action input as payload.json. Inspect the plan for the exact path, query and body. Set COMPOSE_WORKSPACE_ID from granted resource discovery.

Inspect and test this action in the signed action console, then perform the verification below.

Input fields

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "documentId"
  ],
  "additionalProperties": false
}

Effects

• Creates a saved version with reason manual.
• Does not change document text or capture the full review/approval metadata.
• Retain the returned version id before a later update or AI revision.

Interpret the response

Use response path $.version.id for compose_document_version. An empty list does not discover a target.

Expect HTTP 201 with version.id and the target documentId. Read documents.versions.list and compare the snapshot text with documents.get at the time it was saved.

The success schema below was checked against captured handler responses. Optional structured generation metadata and integration-dependent values can vary. Error examples retain their actual refusal shapes.

Success schema:

{
  "type": "object",
  "required": [
    "version"
  ],
  "properties": {
    "version": {
      "type": "object",
      "required": [
        "id",
        "documentId",
        "title",
        "type",
        "style",
        "audience",
        "markdown",
        "sourceMaterial",
        "generationContract",
        "provider",
        "model",
        "reason",
        "createdByUserId",
        "createdByEmail",
        "createdAt",
        "wordCount"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "documentId": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "style": {
          "type": "null"
        },
        "audience": {
          "type": "string",
          "maxLength": 0
        },
        "markdown": {
          "type": "string"
        },
        "sourceMaterial": {
          "type": "null"
        },
        "generationContract": {
          "type": "null"
        },
        "provider": {
          "type": "null"
        },
        "model": {
          "type": "null"
        },
        "reason": {
          "type": "string"
        },
        "createdByUserId": {
          "type": "string"
        },
        "createdByEmail": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "wordCount": {
          "type": "number"
        }
      }
    }
  }
}

Worked examples

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. Refused examples demonstrate boundaries and must not be executed as successful workflows.

Successful request

Actual Compose Worker response. Auth, Nexus, notifications, metering and platform workspace transport are simulated. D1 is an in-memory adapter or local SQLite as stated by the test. This does not prove a live model completion or notification delivery. No request credentials are captured. Captured scenario: document versions > list, create, and restore versions.

Input · payload.json:

{
  "documentId": "97885e26-f7b9-41b9-8970-905f765115bb"
}

CLI:

topolo actions validate app_topolo_compose.documents.versions.create --data @payload.json --json
topolo actions plan app_topolo_compose.documents.versions.create --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_compose.documents.versions.create --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_compose.documents.versions.create",
    "input": {
      "documentId": "97885e26-f7b9-41b9-8970-905f765115bb"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "version": {
    "id": "c0d381b1-c1b7-44ed-b8dc-0c036c7d40a4",
    "documentId": "97885e26-f7b9-41b9-8970-905f765115bb",
    "title": "V2",
    "type": "general",
    "style": null,
    "audience": "",
    "markdown": "# V2 longer body here",
    "sourceMaterial": null,
    "generationContract": null,
    "provider": null,
    "model": null,
    "reason": "manual",
    "createdByUserId": "user_test_1",
    "createdByEmail": "writer@stg.topolo.us",
    "createdAt": "2026-10-04T02:26:27.275Z",
    "wordCount": 5
  }
}

HTTP 201. Expect HTTP 201 with version.id and the target documentId. Read documents.versions.list and compare the snapshot text with documents.get at the time it was saved.

Refused request · HTTP 403

Actual Compose Worker response. Auth, Nexus, notifications, metering and platform workspace transport are simulated. D1 is an in-memory adapter or local SQLite as stated by the test. This does not prove a live model completion or notification delivery. No request credentials are captured. Captured scenario: each grant level against each route > 'POST' '/api/documents/{documentId}/versions' with a 'read' grant.

Input · payload.json:

{
  "documentId": "documentId_missing"
}

CLI:

topolo actions validate app_topolo_compose.documents.versions.create --data @payload.json --json
topolo actions plan app_topolo_compose.documents.versions.create --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": "This workspace requires read_write access",
  "code": "workspace_access_insufficient"
}

HTTP 403. The handler refused this request. Resolve its exact cause before retrying; input validation can reject an invalid fixture before it reaches the handler.

Refused request · HTTP 404

Actual Compose Worker response. Auth, Nexus, notifications, metering and platform workspace transport are simulated. D1 is an in-memory adapter or local SQLite as stated by the test. This does not prove a live model completion or notification delivery. No request credentials are captured. Captured scenario: each grant level against each route > 'POST' '/api/documents/{documentId}/versions' with a 'read_write' grant.

Input · payload.json:

{
  "documentId": "documentId_missing"
}

CLI:

topolo actions validate app_topolo_compose.documents.versions.create --data @payload.json --json
topolo actions plan app_topolo_compose.documents.versions.create --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "error": "not_found"
}

HTTP 404. The handler refused this request. Resolve its exact cause before retrying; input validation can reject an invalid fixture before it reaches the handler.

Verify the result

• Expect HTTP 201 with version.id and the target documentId.
• Read documents.versions.list and compare the snapshot text with documents.get at the time it was saved.

Errors and recovery

• This workspace requires read_write access (HTTP 403): Verify the authenticated organization, application permission and granted workspace. For reviewer_required, use the legitimately assigned reviewer; requesting review grants no access.
• not_found (HTTP 404): Discover the accessible document and version in the selected workspace. A missing or inaccessible id is not permission to create a replacement.

Auth, action-input validation and platform resource resolution can refuse a request before its handler. Retain the exact error, request id and context; requesting another context is not a legitimate way to bypass a refusal.

Recovery boundary

No version-delete action is published. The new snapshot remains history; it can be used to restore text through documents.versions.restore.

Related actions

• 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.
• 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.
• 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.

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. Capture digests and test scenarios are retained in the source fixture records.