Skip to main content
POST
/
import-flashcards
Import Flashcard
curl --request POST \
  --url http://dolphinflashcards.com/api/import-flashcards \
  --header 'Content-Type: multipart/form-data' \
  --form jwtToken=eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6ImEzMmZkZDRiMTQ2Njc3NzE5YWIyMzcyODYxYmRlZDg5In0.eyJpc3MiOiJodHRwOi8vZG9scGhpbmZsYXNoY2FyZHMuY29tIiwiYXVkIjoiYXBpIiwic3ViIjoidU5RR2lIencxdk9EaExybTVDRWtaQ1ZoTU93MSIsImFjY2Vzc190b2tlbiI6IjRiZTA2NDNmLTFkOTgtNTczYi05N2NkLWNhOThhNjUzNDdkZCIsImFjY2Vzc190b2tlbl9yYXciOiJ0ZXN0IiwiaWF0IjoxNzI2Nzc0MTYzfQ.F-fxFitPQF-gGHyhGPGxE_zj_b8XJybqe4J_iYG66BC4Dqm4LTb8RpcDLyYUhRCcpphihpWGbdp \
  --form flashcardName=firstCard \
  --form 'flashcardDescription=my first flashcard' \
  --form folder=top-level-parent-name/parent-name-2/parent-name-3 \
  --form 'delimiter=,' \
  --form firstRowOfData=2 \
  --form file=@example-file
[
  {
    "200": 123,
    "success": true
  }
]

Body

multipart/form-data
​
file
file
required

CSV file having headings term and definition.

​
jwtToken
string
required

The unique ID of the user editing or creating flashcards.

Example:

"eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6ImEzMmZkZDRiMTQ2Njc3NzE5YWIyMzcyODYxYmRlZDg5In0.eyJpc3MiOiJodHRwOi8vZG9scGhpbmZsYXNoY2FyZHMuY29tIiwiYXVkIjoiYXBpIiwic3ViIjoidU5RR2lIencxdk9EaExybTVDRWtaQ1ZoTU93MSIsImFjY2Vzc190b2tlbiI6IjRiZTA2NDNmLTFkOTgtNTczYi05N2NkLWNhOThhNjUzNDdkZCIsImFjY2Vzc190b2tlbl9yYXciOiJ0ZXN0IiwiaWF0IjoxNzI2Nzc0MTYzfQ.F-fxFitPQF-gGHyhGPGxE_zj_b8XJybqe4J_iYG66BC4Dqm4LTb8RpcDLyYUhRCcpphihpWGbdp"

​
flashcardName
string
required

The name of the flashcard set.

Example:

"firstCard"

​
flashcardDescription
string
required

The description of the flashcard set

Example:

"my first flashcard"

​
folder
string
required

The name of the folder containing the flashcard sets. Set to "" to set as a top level flashcard, otherwise set it to the parent folder name. If there are multiple parent folders, add the folder name seperated by /

Example:

"top-level-parent-name/parent-name-2/parent-name-3"

​
delimiter
string
required

The delimiter used in the CSV file (e.g., comma, semicolon).

Example:

","

​
firstRowOfData
string
required

Defines the first row where actual data is stored in the CSV. Defaults to row 2 if not provided.

Example:

"2"

Response

OK. Returned when the request is successfully executed.

​
200
integer

HTTP status code indicating a successful operation.

​
success
boolean

Indicates that a new flashcard was created successfully.

​