Skip to content
REST API

Apply a generation

POST
/generations/{generationId}/apply

Writes a generation into its note. A generation made for an empty note is written in while the note is still empty and unchanged, as the app does; otherwise mode decides. Applying again changes nothing and returns alreadyApplied true. Needs generation:start or copilot:use, and notes:update.

Required scopes: notes:update; generation:start or copilot:use

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

generationId*string

Generation id, scoped to the key's user.

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

Header Parameters

Idempotency-Key?string

A client-generated key (1 to 255 visible ASCII characters) that makes this POST safe to retry. A retry with the same key and body replays the original response; the same key with a different body returns 409 idempotency_conflict. Stored for 24 hours.

Match^[\x21-\x7E]{1,255}$
Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/generations/497f6eca-6276-4993-bfeb-53cbbbba6f08/apply" \  -H "Content-Type: application/json" \  -d '{    "mode": "insert-end"  }'
{  "data": {    "applied": true,    "alreadyApplied": false,    "noteId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e"  }}

List a note's files GET

Previous Page

Discard a generation POST

Next Page