Generate a study set

Makes a study set of flashcards from a note. Poll GET /jobs/{jobId} until it ends; a finished study_set_generation job's result.setId is the new set. While a set is being made from the note, starting another returns that job instead. Counts as an AI use.

Required scopes: generation:start

Authorization

AuthorizationBearer <token>

In: header

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.

requestId*string

A uuid you mint for this start. It becomes the job id. Sending it again with the same body returns the same job and is not counted twice; a different body under a used requestId is 409 idempotency_conflict.

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

noteId*string

The note to make cards from.

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

modelTier?string

swift, scholar or sage; the server's study-set tier when omitted. sage needs a paid plan; a free user gets 400 with details.reason premium-only.

Value in

"swift"
"scholar"
"sage"

Response Body

`application/json`

curl -X POST "https://example.com/sets/generate" \  -H "Content-Type: application/json" \  -d '{    "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",    "noteId": "11bee8fe-2793-4911-9b27-a6f8473a2ccf"  }'

{  "data": {    "jobId": "7d6c5b4a-3f2e-4d1c-8b0a-9f8e7d6c5b4a"  }}

Generate a study set

Authorization

Header Parameters

Request Body

Response Body

202application/json

400application/json

401application/json

402application/json

403application/json

404application/json

405application/json

409application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`