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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

requestId*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

discussionPlanId*|

Defaultnull

proposal*|

rationale*

anchor*|||

Default

{  "kind": "document"}

predecessorId?string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/documents/string/suggestions" \  -H "Content-Type: application/json" \  -d '{    "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",    "discussionPlanId": null,    "proposal": {      "mode": "native",      "operation": "insert",      "baseRevision": "string",      "sourceRevision": null,      "destinationRevision": "string",      "start": 0,      "end": 0,      "original": "string",      "proposed": "string"    },    "rationale": {      "markdown": "string",      "mentions": []    },    "anchor": {      "kind": "document"    }  }'

{  "eventId": "string",  "suggestionId": "string",  "threadId": "string",  "version": 0,  "state": "string",  "acceptedRevision": "string",  "commitId": "string"}

View as Markdown Open in Claude Open in ChatGPT

Propose an exact native edit or an external change

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

404application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`