Skip to main content
POST
/
v1
/
interactives
/
flashcards
/
create
Create Flashcard Set
curl --request POST \
  --url https://api.opennote.com/v1/interactives/flashcards/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "set_description": "<string>",
  "count": 10,
  "set_name": ""
}
'
{
  "success": true,
  "message": "<string>",
  "set_name": "<string>",
  "flashcards": [
    {
      "front": "<string>",
      "back": "<string>"
    }
  ],
  "timestamp": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request model for creating a flashcard set.

​
set_description
string
required

The description of the flashcard set, i.e. what you want to include in the set.

​
count
integer | null
default:10

The number of flashcards to generate

Required range: 1 <= x <= 30
​
set_name
string | null
default:""

The name of the flashcard set, if you want to provide one. If you do not, one will be generated for you at additional cost.

Response

Successful Response

Response model for flashcard set creation.

​
success
boolean
required
​
message
string | null
​
set_name
string | null
​
flashcards
Flashcard · object[] | null
​
timestamp
string