Document collaboration

Read a suggestion, current source and review capabilities

GET
/v1/documents/{documentId}/suggestions/{suggestionId}

Authorization

bearerAuth
AuthorizationBearer <token>

A personal API key (psk_…) or an OAuth access token (plan_at_…). Scopes: read, write.

In: header

Path Parameters

documentId*string

The documentId.

suggestionId*string

The suggestionId.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents/string/suggestions/string"
{  "document": {    "id": "string",    "kind": "string",    "target": {      "kind": "plan-item",      "itemId": "f11b669d-7201-4c21-88af-d85092f0c005"    },    "title": "string",    "canonicalUrl": "string",    "revision": "string",    "path": "string",    "sourceDocumentId": "string",    "sourceRevision": "string",    "applyMode": "native",    "capabilities": {      "canComment": true,      "canSuggest": true,      "canMaintain": true,      "canUseAgent": true,      "needsDiscussionPlan": true    },    "discussionPlanId": "string",    "ownerUserIds": [      "string"    ],    "ownerNames": [      "string"    ]  },  "suggestion": {    "id": "string",    "threadId": "string",    "documentId": "string",    "state": "PENDING",    "version": 0,    "proposal": {      "mode": "native",      "operation": "insert",      "baseRevision": "string",      "sourceRevision": null,      "destinationRevision": "string",      "start": 0,      "end": 0,      "original": "string",      "proposed": "string"    },    "authorUserId": "string",    "predecessorId": "string",    "decidedAt": "string",    "decidedBy": "string",    "acceptedRevision": "string",    "freshness": "current",    "capabilities": {      "canRevise": true,      "canRefresh": true,      "canAccept": true,      "canReject": true,      "canWithdraw": true,      "canMarkAppliedExternally": true    }  },  "sourceText": "string"}