Anki-Connect enables external applications such as Yomichan to communicate with Anki over a simple HTTP API. Its capabilities include executing queries against the user's card deck, automatically creating new cards, and more. Anki-Connect is compatible with the latest stable (2.1.x) releases of Anki; older versions (2.0.x and below) are no longer supported.
The installation process is similar to other Anki plugins and can be accomplished in three steps:
- Open the
Install Add-on
dialog by selectingTools
|Add-ons
|Get Add-ons...
in Anki. - Input 2055492159 into the text box labeled
Code
and press theOK
button to proceed. - Restart Anki when prompted to do so in order to complete the installation of Anki-Connect.
Anki must be kept running in the background in order for other applications to be able to use Anki-Connect. You can
verify that Anki-Connect is running at any time by accessing localhost:8765
in your browser. If the server is running,
you will see the message Anki-Connect
displayed in your browser window.
Windows users may see a firewall nag dialog box appear on Anki startup. This occurs because Anki-Connect runs a local HTTP server in order to enable other applications to connect to it. The host application, Anki, must be unblocked for this plugin to function correctly.
Starting with Mac OS X Mavericks, a feature named App Nap has been introduced to the operating system. This feature causes certain applications which are open (but not visible) to be placed in a suspended state. As this behavior causes Anki-Connect to stop working while you have another window in the foreground, App Nap should be disabled for Anki:
- Start the Terminal application.
- Execute the following commands in the terminal window:
defaults write net.ankiweb.dtop NSAppSleepDisabled -bool true defaults write net.ichi2.anki NSAppSleepDisabled -bool true defaults write org.qt-project.Qt.QtWebEngineCore NSAppSleepDisabled -bool true
- Restart Anki.
Anki-Connect exposes internal Anki features to external applications via an easy to use API. After being installed, this plugin will start an HTTP server on port 8765 whenever Anki is launched. Other applications (including browser extensions) can then communicate with it via HTTP requests.
By default, Anki-Connect will only bind the HTTP server to the 127.0.0.1
IP address, so that you will only be able to
access it from the same host on which it is running. If you need to access it over a network, you can set the
environment variable ANKICONNECT_BIND_ADDRESS
to change the binding address. For example, you can set it to 0.0.0.0
in order to bind it to all network interfaces on your host.
Every request consists of a JSON-encoded object containing an action
, a version
, contextual params
, and a key
value used for authentication (which is optional and can be omitted by default). Anki-Connect will respond with an
object containing two fields: result
and error
. The result
field contains the return value of the executed API,
and the error
field is a description of any exception thrown during API execution (the value null
is used if
execution completed successfully).
Sample successful response:
{"result": ["Default", "Filtered Deck 1"], "error": null}
Samples of failed responses:
{"result": null, "error": "unsupported action"}
{"result": null, "error": "guiBrowse() got an unexpected keyword argument 'foobar'"}
For compatibility with clients designed to work with older versions of Anki-Connect, failing to provide a version
field in the request will make the version default to 4. Furthermore, when the provided version is level 4 or below, the
API response will only contain the value of the result
; no error
field is available for error handling.
You can use whatever language or tool you like to issue request to Anki-Connect, but a couple of simple examples are included below as reference.
curl localhost:8765 -X POST -d '{"action": "deckNames", "version": 6}'
(Invoke-RestMethod -Uri http://localhost:8765 -Method Post -Body '{"action": "deckNames", "version": 6}').result
import json
import urllib.request
def request(action, **params):
return {'action': action, 'params': params, 'version': 6}
def invoke(action, **params):
requestJson = json.dumps(request(action, **params)).encode('utf-8')
response = json.load(urllib.request.urlopen(urllib.request.Request('http://localhost:8765', requestJson)))
if len(response) != 2:
raise Exception('response has an unexpected number of fields')
if 'error' not in response:
raise Exception('response is missing required error field')
if 'result' not in response:
raise Exception('response is missing required result field')
if response['error'] is not None:
raise Exception(response['error'])
return response['result']
invoke('createDeck', deck='test1')
result = invoke('deckNames')
print('got list of decks: {}'.format(result))
function invoke(action, version, params={}) {
return new Promise((resolve, reject) => {
const xhr = new XMLHttpRequest();
xhr.addEventListener('error', () => reject('failed to issue request'));
xhr.addEventListener('load', () => {
try {
const response = JSON.parse(xhr.responseText);
if (Object.getOwnPropertyNames(response).length != 2) {
throw 'response has an unexpected number of fields';
}
if (!response.hasOwnProperty('error')) {
throw 'response is missing required error field';
}
if (!response.hasOwnProperty('result')) {
throw 'response is missing required result field';
}
if (response.error) {
throw response.error;
}
resolve(response.result);
} catch (e) {
reject(e);
}
});
xhr.open('POST', 'http://127.0.0.1:8765');
xhr.send(JSON.stringify({action, version, params}));
});
}
await invoke('createDeck', 6, {deck: 'test1'});
const result = await invoke('deckNames', 6);
console.log(`got list of decks: ${result}`);
The primary goal for Anki-Connect was to support real-time flash card creation from the Yomichan browser extension. The current API provides all the required actions to make this happen. I recognise that the role of Anki-Connect has evolved from this original vision, and I am happy to review new feature requests.
With that said, this project operates on a self-serve model. If you would like a new feature, create a PR. I'll review it and if it looks good, it will be merged in. Requests to add new features without accompanying pull requests will not be serviced. Make sure that your pull request meets the following criteria:
- Attempt to match style of the surrounding code.
- Have accompanying documentation with examples.
- Have accompanying tests that verify operation.
- Implement features useful in other applications.
Documentation for currently supported actions is split up by category and is referenced below. Note that deprecated APIs will continue to function despite not being listed on this page as long as your request is labeled with a version number corresponding to when the API was available for use.
- Card Actions
- Deck Actions
- Graphical Actions
- Media Actions
- Miscellaneous Actions
- Model Actions
- Note Actions
- Statistic Actions
-
getEaseFactors
Returns an array with the ease factor for each of the given cards (in the same order).
Sample request:
{ "action": "getEaseFactors", "version": 6, "params": { "cards": [1483959291685, 1483959293217] } }
Sample result:
{ "result": [4100, 3900], "error": null }
-
setEaseFactors
Sets ease factor of cards by card ID; returns
true
if successful (all cards existed) orfalse
otherwise.Sample request:
{ "action": "setEaseFactors", "version": 6, "params": { "cards": [1483959291685, 1483959293217], "easeFactors": [4100, 3900] } }
Sample result:
{ "result": [true, true], "error": null }
-
setSpecificValueOfCard
Sets specific value of a single card. Given the risk of wreaking havor in the database when changing some of the values of a card, some of the keys require the argument "warning_check" set to True. This can be used to set a card's flag, change it's ease factor, change the review order in a filtered deck and change the column "data" (not currently used by anki apparantly), and many other values. A list of values and explanation of their respective utility can be found at AnkiDroid's wiki.
Sample request:
{ "action": "setSpecificValueOfCard", "version": 6, "params": { "card": 1483959291685, "keys": ["flags", "odue"], "newValues": ["1", "-100"] } }
Sample result:
{ "result": [true, true], "error": null }
-
suspend
Suspend cards by card ID; returns
true
if successful (at least one card wasn't already suspended) orfalse
otherwise.Sample request:
{ "action": "suspend", "version": 6, "params": { "cards": [1483959291685, 1483959293217] } }
Sample result:
{ "result": true, "error": null }
-
unsuspend
Unsuspend cards by card ID; returns
true
if successful (at least one card was previously suspended) orfalse
otherwise.Sample request:
{ "action": "unsuspend", "version": 6, "params": { "cards": [1483959291685, 1483959293217] } }
Sample result:
{ "result": true, "error": null }
-
suspended
Check if card is suspended by its ID. Returns
true
if suspended,false
otherwise.Sample request:
{ "action": "suspended", "version": 6, "params": { "card": 1483959293217 } }
Sample result:
{ "result": true, "error": null }
-
areSuspended
Returns an array indicating whether each of the given cards is suspended (in the same order). If card doesn't exist returns
null
.Sample request:
{ "action": "areSuspended", "version": 6, "params": { "cards": [1483959291685, 1483959293217, 1234567891234] } }
Sample result:
{ "result": [false, true, null], "error": null }
-
areDue
Returns an array indicating whether each of the given cards is due (in the same order). Note: cards in the learning queue with a large interval (over 20 minutes) are treated as not due until the time of their interval has passed, to match the way Anki treats them when reviewing.
Sample request:
{ "action": "areDue", "version": 6, "params": { "cards": [1483959291685, 1483959293217] } }
Sample result:
{ "result": [false, true], "error": null }
-
getIntervals
Returns an array of the most recent intervals for each given card ID, or a 2-dimensional array of all the intervals for each given card ID when
complete
istrue
. Negative intervals are in seconds and positive intervals in days.Sample request 1:
{ "action": "getIntervals", "version": 6, "params": { "cards": [1502298033753, 1502298036657] } }
Sample result 1:
{ "result": [-14400, 3], "error": null }
Sample request 2:
{ "action": "getIntervals", "version": 6, "params": { "cards": [1502298033753, 1502298036657], "complete": true } }
Sample result 2:
{ "result": [ [-120, -180, -240, -300, -360, -14400], [-120, -180, -240, -300, -360, -14400, 1, 3] ], "error": null }
-
findCards
Returns an array of card IDs for a given query. Functionally identical to
guiBrowse
but doesn't use the GUI for better performance.Sample request:
{ "action": "findCards", "version": 6, "params": { "query": "deck:current" } }
Sample result:
{ "result": [1494723142483, 1494703460437, 1494703479525], "error": null }
-
cardsToNotes
Returns an unordered array of note IDs for the given card IDs. For cards with the same note, the ID is only given once in the array.
Sample request:
{ "action": "cardsToNotes", "version": 6, "params": { "cards": [1502098034045, 1502098034048, 1502298033753] } }
Sample result:
{ "result": [1502098029797, 1502298025183], "error": null }
-
cardsModTime
Returns a list of objects containings for each card ID the modification time. This function is about 15 times faster than executing
cardsInfo
.Sample request:
{ "action": "cardsModTime", "version": 6, "params": { "cards": [1498938915662, 1502098034048] } }
Sample result:
{ "result": [ { "cardId": 1498938915662, "mod": 1629454092 } ], "error": null }
-
cardsInfo
Returns a list of objects containing for each card ID the card fields, front and back sides including CSS, note type, the note that the card belongs to, and deck name, last modification timestamp as well as ease and interval.
Sample request:
{ "action": "cardsInfo", "version": 6, "params": { "cards": [1498938915662, 1502098034048] } }
Sample result:
{ "result": [ { "answer": "back content", "question": "front content", "deckName": "Default", "modelName": "Basic", "fieldOrder": 1, "fields": { "Front": {"value": "front content", "order": 0}, "Back": {"value": "back content", "order": 1} }, "css":"p {font-family:Arial;}", "cardId": 1498938915662, "interval": 16, "note":1502298033753, "ord": 1, "type": 0, "queue": 0, "due": 1, "reps": 1, "lapses": 0, "left": 6, "mod": 1629454092 }, { "answer": "back content", "question": "front content", "deckName": "Default", "modelName": "Basic", "fieldOrder": 0, "fields": { "Front": {"value": "front content", "order": 0}, "Back": {"value": "back content", "order": 1} }, "css":"p {font-family:Arial;}", "cardId": 1502098034048, "interval": 23, "note":1502298033753, "ord": 1, "type": 0, "queue": 0, "due": 1, "reps": 1, "lapses": 0, "left": 6 } ], "error": null }
-
forgetCards
Forget cards, making the cards new again.
Sample request:
{ "action": "forgetCards", "version": 6, "params": { "cards": [1498938915662, 1502098034048] } }
Sample result:
{ "result": null, "error": null }
-
relearnCards
Make cards be "relearning".
Sample request:
{ "action": "relearnCards", "version": 6, "params": { "cards": [1498938915662, 1502098034048] } }
Sample result:
{ "result": null, "error": null }
-
deckNames
Gets the complete list of deck names for the current user.
Sample request:
{ "action": "deckNames", "version": 6 }
Sample result:
{ "result": ["Default"], "error": null }
-
deckNamesAndIds
Gets the complete list of deck names and their respective IDs for the current user.
Sample request:
{ "action": "deckNamesAndIds", "version": 6 }
Sample result:
{ "result": {"Default": 1}, "error": null }
-
getDecks
Accepts an array of card IDs and returns an object with each deck name as a key, and its value an array of the given cards which belong to it.
Sample request:
{ "action": "getDecks", "version": 6, "params": { "cards": [1502298036657, 1502298033753, 1502032366472] } }
Sample result:
{ "result": { "Default": [1502032366472], "Japanese::JLPT N3": [1502298036657, 1502298033753] }, "error": null }
-
createDeck
Create a new empty deck. Will not overwrite a deck that exists with the same name.
Sample request:
{ "action": "createDeck", "version": 6, "params": { "deck": "Japanese::Tokyo" } }
Sample result:
{ "result": 1519323742721, "error": null }
-
changeDeck
Moves cards with the given IDs to a different deck, creating the deck if it doesn't exist yet.
Sample request:
{ "action": "changeDeck", "version": 6, "params": { "cards": [1502098034045, 1502098034048, 1502298033753], "deck": "Japanese::JLPT N3" } }
Sample result:
{ "result": null, "error": null }
-
deleteDecks
Deletes decks with the given names. The argument
cardsToo
must be specified and set totrue
.Sample request:
{ "action": "deleteDecks", "version": 6, "params": { "decks": ["Japanese::JLPT N5", "Easy Spanish"], "cardsToo": true } }
Sample result:
{ "result": null, "error": null }
-
getDeckConfig
Gets the configuration group object for the given deck.
Sample request:
{ "action": "getDeckConfig", "version": 6, "params": { "deck": "Default" } }
Sample result:
{ "result": { "lapse": { "leechFails": 8, "delays": [10], "minInt": 1, "leechAction": 0, "mult": 0 }, "dyn": false, "autoplay": true, "mod": 1502970872, "id": 1, "maxTaken": 60, "new": { "bury": true, "order": 1, "initialFactor": 2500, "perDay": 20, "delays": [1, 10], "separate": true, "ints": [1, 4, 7] }, "name": "Default", "rev": { "bury": true, "ivlFct": 1, "ease4": 1.3, "maxIvl": 36500, "perDay": 100, "minSpace": 1, "fuzz": 0.05 }, "timer": 0, "replayq": true, "usn": -1 }, "error": null }
-
saveDeckConfig
Saves the given configuration group, returning
true
on success orfalse
if the ID of the configuration group is invalid (such as when it does not exist).Sample request:
{ "action": "saveDeckConfig", "version": 6, "params": { "config": { "lapse": { "leechFails": 8, "delays": [10], "minInt": 1, "leechAction": 0, "mult": 0 }, "dyn": false, "autoplay": true, "mod": 1502970872, "id": 1, "maxTaken": 60, "new": { "bury": true, "order": 1, "initialFactor": 2500, "perDay": 20, "delays": [1, 10], "separate": true, "ints": [1, 4, 7] }, "name": "Default", "rev": { "bury": true, "ivlFct": 1, "ease4": 1.3, "maxIvl": 36500, "perDay": 100, "minSpace": 1, "fuzz": 0.05 }, "timer": 0, "replayq": true, "usn": -1 } } }
Sample result:
{ "result": true, "error": null }
-
setDeckConfigId
Changes the configuration group for the given decks to the one with the given ID. Returns
true
on success orfalse
if the given configuration group or any of the given decks do not exist.Sample request:
{ "action": "setDeckConfigId", "version": 6, "params": { "decks": ["Default"], "configId": 1 } }
Sample result:
{ "result": true, "error": null }
-
cloneDeckConfigId
Creates a new configuration group with the given name, cloning from the group with the given ID, or from the default group if this is unspecified. Returns the ID of the new configuration group, or
false
if the specified group to clone from does not exist.Sample request:
{ "action": "cloneDeckConfigId", "version": 6, "params": { "name": "Copy of Default", "cloneFrom": 1 } }
Sample result:
{ "result": 1502972374573, "error": null }
-
removeDeckConfigId
Removes the configuration group with the given ID, returning
true
if successful, orfalse
if attempting to remove either the default configuration group (ID = 1) or a configuration group that does not exist.Sample request:
{ "action": "removeDeckConfigId", "version": 6, "params": { "configId": 1502972374573 } }
Sample result:
{ "result": true, "error": null }
-
getDeckStats
Gets statistics such as total cards and cards due for the given decks.
Sample request:
{ "action": "getDeckStats", "version": 6, "params": { "decks": ["Japanese::JLPT N5", "Easy Spanish"] } }
Sample result:
{ "result": { "1651445861967": { "deck_id": 1651445861967, "name": "Japanese::JLPT N5", "new_count": 20, "learn_count": 0, "review_count": 0, "total_in_deck": 1506 }, "1651445861960": { "deck_id": 1651445861960, "name": "Easy Spanish", "new_count": 26, "learn_count": 10, "review_count": 5, "total_in_deck": 852 } }, "error": null }
-
guiBrowse
Invokes the Card Browser dialog and searches for a given query. Returns an array of identifiers of the cards that were found. Query syntax is documented here.
Sample request:
{ "action": "guiBrowse", "version": 6, "params": { "query": "deck:current" } }
Sample result:
{ "result": [1494723142483, 1494703460437, 1494703479525], "error": null }
-
guiSelectedNotes
Finds the open instance of the Card Browser dialog and returns an array of identifiers of the notes that are selected. Returns an empty list if the browser is not open.
Sample request:
{ "action": "guiSelectedNotes", "version": 6 }
Sample result:
{ "result": [1494723142483, 1494703460437, 1494703479525], "error": null }
-
guiAddCards
Invokes the Add Cards dialog, presets the note using the given deck and model, with the provided field values and tags. Invoking it multiple times closes the old window and reopen the window with the new provided values.
Audio, video, and picture files can be embedded into the fields via the
audio
,video
, andpicture
keys, respectively. Refer to the documentation ofaddNote
andstoreMediaFile
for an explanation of these fields.The result is the ID of the note which would be added, if the user chose to confirm the Add Cards dialogue.
Sample request:
{ "action": "guiAddCards", "version": 6, "params": { "note": { "deckName": "Default", "modelName": "Cloze", "fields": { "Text": "The capital of Romania is {{c1::Bucharest}}", "Extra": "Romania is a country in Europe" }, "tags": [ "countries" ], "picture": [{ "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/1/13/EU-Romania.svg/285px-EU-Romania.svg.png", "filename": "romania.png", "fields": [ "Extra" ] }] } } }
Sample result:
{ "result": 1496198395707, "error": null }
-
guiEditNote
Opens the Edit dialog with a note corresponding to given note ID. The dialog is similar to the Edit Current dialog, but:
- has a Preview button to preview the cards for the note
- has a Browse button to open the browser with these cards
- has Previous/Back buttons to navigate the history of the dialog
- has no bar with the Close button
Sample request:
{ "action": "guiEditNote", "version": 6, "params": { "note": 1649198355435 } }
Sample result:
{ "result": null, "error": null }
-
guiCurrentCard
Returns information about the current card or
null
if not in review mode.Sample request:
{ "action": "guiCurrentCard", "version": 6 }
Sample result:
{ "result": { "answer": "back content", "question": "front content", "deckName": "Default", "modelName": "Basic", "fieldOrder": 0, "fields": { "Front": {"value": "front content", "order": 0}, "Back": {"value": "back content", "order": 1} }, "template": "Forward", "cardId": 1498938915662, "buttons": [1, 2, 3], "nextReviews": ["<1m", "<10m", "4d"] }, "error": null }
-
guiStartCardTimer
Starts or resets the
timerStarted
value for the current card. This is useful for deferring the start time to when it is displayed via the API, allowing the recorded time taken to answer the card to be more accurate when callingguiAnswerCard
.Sample request:
{ "action": "guiStartCardTimer", "version": 6 }
Sample result:
{ "result": true, "error": null }
-
guiShowQuestion
Shows question text for the current card; returns
true
if in review mode orfalse
otherwise.Sample request:
{ "action": "guiShowQuestion", "version": 6 }
Sample result:
{ "result": true, "error": null }
-
guiShowAnswer
Shows answer text for the current card; returns
true
if in review mode orfalse
otherwise.Sample request:
{ "action": "guiShowAnswer", "version": 6 }
Sample result:
{ "result": true, "error": null }
-
guiAnswerCard
Answers the current card; returns
true
if succeeded orfalse
otherwise. Note that the answer for the current card must be displayed before before any answer can be accepted by Anki.Sample request:
{ "action": "guiAnswerCard", "version": 6, "params": { "ease": 1 } }
Sample result:
{ "result": true, "error": null }
-
guiDeckOverview
Opens the Deck Overview dialog for the deck with the given name; returns
true
if succeeded orfalse
otherwise.Sample request:
{ "action": "guiDeckOverview", "version": 6, "params": { "name": "Default" } }
Sample result:
{ "result": true, "error": null }
-
guiDeckBrowser
Opens the Deck Browser dialog.
Sample request:
{ "action": "guiDeckBrowser", "version": 6 }
Sample result:
{ "result": null, "error": null }
-
guiDeckReview
Starts review for the deck with the given name; returns
true
if succeeded orfalse
otherwise.Sample request:
{ "action": "guiDeckReview", "version": 6, "params": { "name": "Default" } }
Sample result:
{ "result": true, "error": null }
-
guiExitAnki
Schedules a request to gracefully close Anki. This operation is asynchronous, so it will return immediately and won't wait until the Anki process actually terminates.
Sample request:
{ "action": "guiExitAnki", "version": 6 }
Sample result:
{ "result": null, "error": null }
-
guiCheckDatabase
Requests a database check, but returns immediately without waiting for the check to complete. Therefore, the action will always return
true
even if errors are detected during the database check.Sample request:
{ "action": "guiCheckDatabase", "version": 6 }
Sample result:
{ "result": true, "error": null }
-
storeMediaFile
Stores a file with the specified base64-encoded contents inside the media folder. Alternatively you can specify a absolute file path, or a url from where the file shell be downloaded. If more than one of
data
,path
andurl
are provided, thedata
field will be used first, thenpath
, and finallyurl
. To prevent Anki from removing files not used by any cards (e.g. for configuration files), prefix the filename with an underscore. These files are still synchronized to AnkiWeb. Any existing file with the same name is deleted by default. SetdeleteExisting
to false to prevent that by letting Anki give the new file a non-conflicting name.Sample request:
{ "action": "storeMediaFile", "version": 6, "params": { "filename": "_hello.txt", "data": "SGVsbG8sIHdvcmxkIQ==" } }
Sample result:
{ "result": "_hello.txt", "error": null }
Content of
_hello.txt
:Hello world!
Sample request:
{ "action": "storeMediaFile", "version": 6, "params": { "filename": "_hello.txt", "path": "/path/to/file" } }
Sample result:
{ "result": "_hello.txt", "error": null }
Sample request:
{ "action": "storeMediaFile", "version": 6, "params": { "filename": "_hello.txt", "url": "https://url.to.file" } }
Sample result:
{ "result": "_hello.txt", "error": null }
-
retrieveMediaFile
Retrieves the base64-encoded contents of the specified file, returning
false
if the file does not exist.Sample request:
{ "action": "retrieveMediaFile", "version": 6, "params": { "filename": "_hello.txt" } }
Sample result:
{ "result": "SGVsbG8sIHdvcmxkIQ==", "error": null }
-
getMediaFilesNames
Gets the names of media files matched the pattern. Returning all names by default.
Sample request:
{ "action": "getMediaFilesNames", "version": 6, "params": { "pattern": "_hell*.txt" } }
Sample result:
{ "result": ["_hello.txt"], "error": null }
-
deleteMediaFile
Deletes the specified file inside the media folder.
Sample request:
{ "action": "deleteMediaFile", "version": 6, "params": { "filename": "_hello.txt" } }
Sample result:
{ "result": null, "error": null }
-
requestPermission
Requests permission to use the API exposed by this plugin. This method does not require the API key, and is the only one that accepts requests from any origin; the other methods only accept requests from trusted origins, which are listed under
webCorsOriginList
in the add-on config.localhost
is trusted by default.Calling this method from an untrusted origin will display a popup in Anki asking the user whether they want to allow your origin to use the API; calls from trusted origins will return the result without displaying the popup. When denying permission, the user may also choose to ignore further permission requests from that origin. These origins end up in the
ignoreOriginList
, editable via the add-on config.The result always contains the
permission
field, which in turn contains either the stringgranted
ordenied
, corresponding to whether your origin is trusted. If your origin is trusted, the fieldsrequireApiKey
(true
if required) andversion
will also be returned.This should be the first call you make to make sure that your application and Anki-Connect are able to communicate properly with each other. New versions of Anki-Connect are backwards compatible; as long as you are using actions which are available in the reported Anki-Connect version or earlier, everything should work fine.
Sample request:
{ "action": "requestPermission", "version": 6 }
Samples results:
{ "result": { "permission": "granted", "requireApiKey": false, "version": 6 }, "error": null }
{ "result": { "permission": "denied" }, "error": null }
-
version
Gets the version of the API exposed by this plugin. Currently versions
1
through6
are defined.Sample request:
{ "action": "version", "version": 6 }
Sample result:
{ "result": 6, "error": null }
-
apiReflect
Gets information about the AnkiConnect APIs available. The request supports the following params:
scopes
- An array of scopes to get reflection information about. The only currently supported value is"actions"
.actions
- Eithernull
or an array of API method names to check for. If the value isnull
, the result will list all of the available API actions. If the value is an array of strings, the result will only contain actions which were in this array.
The result will contain a list of which scopes were used and a value for each scope. For example, the
"actions"
scope will contain a"actions"
property which contains a list of supported action names.Sample request:
{ "action": "apiReflect", "params": { "scopes": ["actions", "invalidType"], "actions": ["apiReflect", "invalidMethod"] }, "version": 6 }
Sample result:
{ "result": { "scopes": ["actions"], "actions": ["apiReflect"] }, "error": null }
-
sync
Synchronizes the local Anki collections with AnkiWeb.
Sample request:
{ "action": "sync", "version": 6 }
Sample result:
{ "result": null, "error": null }
-
getProfiles
Retrieve the list of profiles.
Sample request:
{ "action": "getProfiles", "version": 6 }
Sample result:
{ "result": ["User 1"], "error": null }
-
loadProfile
Selects the profile specified in request.
Sample request:
{ "action": "loadProfile", "params": { "name": "user1" }, "version": 6 }
Sample result:
{ "result": true, "error": null }
-
multi
Performs multiple actions in one request, returning an array with the response of each action (in the given order).
Sample request:
{ "action": "multi", "version": 6, "params": { "actions": [ { "action": "deckNames" }, { "action": "deckNames", "version": 6 }, { "action": "invalidAction", "params": {"useless": "param"} }, { "action": "invalidAction", "params": {"useless": "param"}, "version": 6 } ] } }
Sample result:
{ "result": [ ["Default"], {"result": ["Default"], "error": null}, {"result": null, "error": "unsupported action"}, {"result": null, "error": "unsupported action"} ], "error": null }
-
exportPackage
Exports a given deck in
.apkg
format. Returnstrue
if successful orfalse
otherwise. The optional propertyincludeSched
(default isfalse
) can be specified to include the cards' scheduling data.Sample request:
{ "action": "exportPackage", "version": 6, "params": { "deck": "Default", "path": "/data/Deck.apkg", "includeSched": true } }
Sample result:
{ "result": true, "error": null }
-
importPackage
Imports a file in
.apkg
format into the collection. Returnstrue
if successful orfalse
otherwise. Note that the file path is relative to Anki's collection.media folder, not to the client.Sample request:
{ "action": "importPackage", "version": 6, "params": { "path": "/data/Deck.apkg" } }
Sample result:
{ "result": true, "error": null }
-
reloadCollection
Tells anki to reload all data from the database.
Sample request:
{ "action": "reloadCollection", "version": 6 }
Sample result:
{ "result": null, "error": null }
-
modelNames
Gets the complete list of model names for the current user.
Sample request:
{ "action": "modelNames", "version": 6 }
Sample result:
{ "result": ["Basic", "Basic (and reversed card)"], "error": null }
-
modelNamesAndIds
Gets the complete list of model names and their corresponding IDs for the current user.
Sample request:
{ "action": "modelNamesAndIds", "version": 6 }
Sample result:
{ "result": { "Basic": 1483883011648, "Basic (and reversed card)": 1483883011644, "Basic (optional reversed card)": 1483883011631, "Cloze": 1483883011630 }, "error": null }
-
modelFieldNames
Gets the complete list of field names for the provided model name.
Sample request:
{ "action": "modelFieldNames", "version": 6, "params": { "modelName": "Basic" } }
Sample result:
{ "result": ["Front", "Back"], "error": null }
-
modelFieldDescriptions
Gets the complete list of field descriptions (the text seen in the gui editor when a field is empty) for the provided model name.
Sample request:
{ "action": "modelFieldDescriptions", "version": 6, "params": { "modelName": "Basic" } }
Sample result:
{ "result": ["", ""], "error": null }
-
modelFieldsOnTemplates
Returns an object indicating the fields on the question and answer side of each card template for the given model name. The question side is given first in each array.
Sample request:
{ "action": "modelFieldsOnTemplates", "version": 6, "params": { "modelName": "Basic (and reversed card)" } }
Sample result:
{ "result": { "Card 1": [["Front"], ["Back"]], "Card 2": [["Back"], ["Front"]] }, "error": null }
-
createModel
Creates a new model to be used in Anki. User must provide the
modelName
,inOrderFields
andcardTemplates
to be used in the model. There are optional fieldscss
andisCloze
. If not specified,css
will use the default Anki css andisCloze
will be equal toFalse
. IfisCloze
isTrue
then model will be created as Cloze.Optionally the
Name
field can be provided for each entry ofcardTemplates
. By default the card names will beCard 1
,Card 2
, and so on.Sample request
{ "action": "createModel", "version": 6, "params": { "modelName": "newModelName", "inOrderFields": ["Field1", "Field2", "Field3"], "css": "Optional CSS with default to builtin css", "isCloze": false, "cardTemplates": [ { "Name": "My Card 1", "Front": "Front html {{Field1}}", "Back": "Back html {{Field2}}" } ] } }
Sample result
{ "result":{ "sortf":0, "did":1, "latexPre":"\\documentclass[12pt]{article}\n\\special{papersize=3in,5in}\n\\usepackage[utf8]{inputenc}\n\\usepackage{amssymb,amsmath}\n\\pagestyle{empty}\n\\setlength{\\parindent}{0in}\n\\begin{document}\n", "latexPost":"\\end{document}", "mod":1551462107, "usn":-1, "vers":[ ], "type":0, "css":".card {\n font-family: arial;\n font-size: 20px;\n text-align: center;\n color: black;\n background-color: white;\n}\n", "name":"TestApiModel", "flds":[ { "name":"Field1", "ord":0, "sticky":false, "rtl":false, "font":"Arial", "size":20, "media":[ ] }, { "name":"Field2", "ord":1, "sticky":false, "rtl":false, "font":"Arial", "size":20, "media":[ ] } ], "tmpls":[ { "name":"My Card 1", "ord":0, "qfmt":"", "afmt":"This is the back of the card {{Field2}}", "did":null, "bqfmt":"", "bafmt":"" } ], "tags":[ ], "id":"1551462107104", "req":[ [ 0, "none", [ ] ] ] }, "error":null }
-
modelTemplates
Returns an object indicating the template content for each card connected to the provided model by name.
Sample request:
{ "action": "modelTemplates", "version": 6, "params": { "modelName": "Basic (and reversed card)" } }
Sample result
{ "result": { "Card 1": { "Front": "{{Front}}", "Back": "{{FrontSide}}\n\n<hr id=answer>\n\n{{Back}}" }, "Card 2": { "Front": "{{Back}}", "Back": "{{FrontSide}}\n\n<hr id=answer>\n\n{{Front}}" } }, "error": null }
-
modelStyling
Gets the CSS styling for the provided model by name.
Sample request:
{ "action": "modelStyling", "version": 6, "params": { "modelName": "Basic (and reversed card)" } }
Sample result
{ "result": { "css": ".card {\n font-family: arial;\n font-size: 20px;\n text-align: center;\n color: black;\n background-color: white;\n}\n" }, "error": null }
-
updateModelTemplates
Modify the templates of an existing model by name. Only specifies cards and specified sides will be modified. If an existing card or side is not included in the request, it will be left unchanged.
Sample request:
{ "action": "updateModelTemplates", "version": 6, "params": { "model": { "name": "Custom", "templates": { "Card 1": { "Front": "{{Question}}?", "Back": "{{Answer}}!" } } } } }
Sample result:
{ "result": null, "error": null }
-
updateModelStyling
Modify the CSS styling of an existing model by name.
Sample request:
{ "action": "updateModelStyling", "version": 6, "params": { "model": { "name": "Custom", "css": "p { color: blue; }" } } }
Sample result:
{ "result": null, "error": null }
-
findAndReplaceInModels
Find and replace string in existing model by model name. Customise to replace in front, back or css by setting to true/false.
Sample request:
{ "action": "findAndReplaceInModels", "version": 6, "params": { "model": { "modelName": "", "findText": "text_to_replace", "replaceText": "replace_with_text", "front": true, "back": true, "css": true } } }
Sample result:
{ "result": 1, "error": null }
-
modelFieldRename
Rename the field name of a given model.
Sample Request:
{ "action": "modelFieldRename", "version": 6, "params": { "modelName": "Basic", "oldFieldName": "Front", "newFieldName": "FrontRenamed" } }
Sample result:
{ "result": null, "error": null }
-
modelFieldReposition
Reposition the field within the field list of a given model.
The value of
index
starts at 0. For example, an index of0
puts the field in the first position, and an index of2
puts the field in the third position.Sample Request:
{ "action": "modelFieldReposition", "version": 6, "params": { "modelName": "Basic", "fieldName": "Back", "index": 0 } }
Sample result:
{ "result": null, "error": null }
-
modelFieldAdd
Creates a new field within a given model.
Optionally, the
index
value can be provided, which works exactly the same as the index inmodelFieldReposition
. By default, the field is added to the end of the field list.Sample Request:
{ "action": "modelFieldAdd", "version": 6, "params": { "modelName": "Basic", "fieldName": "NewField", "index": 0 } }
Sample result:
{ "result": null, "error": null }
-
modelFieldRemove
Deletes a field within a given model.
Sample Request:
{ "action": "modelFieldRemove", "version": 6, "params": { "modelName": "Basic", "fieldName": "Front" } }
Sample result:
{ "result": null, "error": null }
-
addNote
Creates a note using the given deck and model, with the provided field values and tags. Returns the identifier of the created note created on success, and
null
on failure.Anki-Connect can download audio, video, and picture files and embed them in newly created notes. The corresponding
audio
,video
, andpicture
note members are optional and can be omitted. If you choose to include any of them, they should contain a single object or an array of objects with the mandatoryfilename
field and one ofdata
,path
orurl
. Refer to the documentation ofstoreMediaFile
for an explanation of these fields. TheskipHash
field can be optionally provided to skip the inclusion of files with an MD5 hash that matches the provided value. This is useful for avoiding the saving of error pages and stub files. Thefields
member is a list of fields that should play audio or video, or show a picture when the card is displayed in Anki. TheallowDuplicate
member insideoptions
group can be set to true to enable adding duplicate cards. Normally duplicate cards can not be added and trigger exception.The
duplicateScope
member insideoptions
can be used to specify the scope for which duplicates are checked. A value of"deck"
will only check for duplicates in the target deck; any other value will check the entire collection.The
duplicateScopeOptions
object can be used to specify some additional settings:duplicateScopeOptions.deckName
will specify which deck to use for checking duplicates in. If undefined ornull
, the target deck will be used.duplicateScopeOptions.checkChildren
will change whether or not duplicate cards are checked in child decks. The default value isfalse
.duplicateScopeOptions.checkAllModels
specifies whether duplicate checks are performed across all note types. The default value isfalse
.
Sample request:
{ "action": "addNote", "version": 6, "params": { "note": { "deckName": "Default", "modelName": "Basic", "fields": { "Front": "front content", "Back": "back content" }, "options": { "allowDuplicate": false, "duplicateScope": "deck", "duplicateScopeOptions": { "deckName": "Default", "checkChildren": false, "checkAllModels": false } }, "tags": [ "yomichan" ], "audio": [{ "url": "https://assets.languagepod101.com/dictionary/japanese/audiomp3.php?kanji=猫&kana=ねこ", "filename": "yomichan_ねこ_猫.mp3", "skipHash": "7e2c2f954ef6051373ba916f000168dc", "fields": [ "Front" ] }], "video": [{ "url": "https://cdn.videvo.net/videvo_files/video/free/2015-06/small_watermarked/Contador_Glam_preview.mp4", "filename": "countdown.mp4", "skipHash": "4117e8aab0d37534d9c8eac362388bbe", "fields": [ "Back" ] }], "picture": [{ "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/c/c7/A_black_cat_named_Tilly.jpg/220px-A_black_cat_named_Tilly.jpg", "filename": "black_cat.jpg", "skipHash": "8d6e4646dfae812bf39651b59d7429ce", "fields": [ "Back" ] }] } } }
Sample result:
{ "result": 1496198395707, "error": null }
-
addNotes
Creates multiple notes using the given deck and model, with the provided field values and tags. Returns an array of identifiers of the created notes (notes that could not be created will have a
null
identifier). Please see the documentation foraddNote
for an explanation of objects in thenotes
array.Sample request:
{ "action": "addNotes", "version": 6, "params": { "notes": [ { "deckName": "Default", "modelName": "Basic", "fields": { "Front": "front content", "Back": "back content" }, "tags": [ "yomichan" ], "audio": [{ "url": "https://assets.languagepod101.com/dictionary/japanese/audiomp3.php?kanji=猫&kana=ねこ", "filename": "yomichan_ねこ_猫.mp3", "skipHash": "7e2c2f954ef6051373ba916f000168dc", "fields": [ "Front" ] }], "video": [{ "url": "https://cdn.videvo.net/videvo_files/video/free/2015-06/small_watermarked/Contador_Glam_preview.mp4", "filename": "countdown.mp4", "skipHash": "4117e8aab0d37534d9c8eac362388bbe", "fields": [ "Back" ] }], "picture": [{ "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/c/c7/A_black_cat_named_Tilly.jpg/220px-A_black_cat_named_Tilly.jpg", "filename": "black_cat.jpg", "skipHash": "8d6e4646dfae812bf39651b59d7429ce", "fields": [ "Back" ] }] } ] } }
Sample result:
{ "result": [1496198395707, null], "error": null }
-
canAddNotes
Accepts an array of objects which define parameters for candidate notes (see
addNote
) and returns an array of booleans indicating whether or not the parameters at the corresponding index could be used to create a new note.Sample request:
{ "action": "canAddNotes", "version": 6, "params": { "notes": [ { "deckName": "Default", "modelName": "Basic", "fields": { "Front": "front content", "Back": "back content" }, "tags": [ "yomichan" ] } ] } }
Sample result:
{ "result": [true], "error": null }
-
updateNoteFields
Modify the fields of an exist note. You can also include audio, video, or picture files which will be added to the note with an optional
audio
,video
, orpicture
property. Please see the documentation foraddNote
for an explanation of objects in theaudio
,video
, orpicture
array.Warning You must not be viewing the note that you are updating on your Anki browser, otherwise the fields will not update. See this issue for further details.
Sample request:
{ "action": "updateNoteFields", "version": 6, "params": { "note": { "id": 1514547547030, "fields": { "Front": "new front content", "Back": "new back content" }, "audio": [{ "url": "https://assets.languagepod101.com/dictionary/japanese/audiomp3.php?kanji=猫&kana=ねこ", "filename": "yomichan_ねこ_猫.mp3", "skipHash": "7e2c2f954ef6051373ba916f000168dc", "fields": [ "Front" ] }] } } }
Sample result:
{ "result": null, "error": null }
-
addTags
Adds tags to notes by note ID.
Sample request:
{ "action": "addTags", "version": 6, "params": { "notes": [1483959289817, 1483959291695], "tags": "european-languages" } }
Sample result:
{ "result": null, "error": null }
-
removeTags
Remove tags from notes by note ID.
Sample request:
{ "action": "removeTags", "version": 6, "params": { "notes": [1483959289817, 1483959291695], "tags": "european-languages" } }
Sample result:
{ "result": null, "error": null }
-
getTags
Gets the complete list of tags for the current user.
Sample request:
{ "action": "getTags", "version": 6 }
Sample result:
{ "result": ["european-languages", "idioms"], "error": null }
-
clearUnusedTags
Clears all the unused tags in the notes for the current user.
Sample request:
{ "action": "clearUnusedTags", "version": 6 }
Sample result:
{ "result": null, "error": null }
-
replaceTags
Replace tags in notes by note ID.
Sample request:
{ "action": "replaceTags", "version": 6, "params": { "notes": [1483959289817, 1483959291695], "tag_to_replace": "european-languages", "replace_with_tag": "french-languages" } }
Sample result:
{ "result": null, "error": null }
-
replaceTagsInAllNotes
Replace tags in all the notes for the current user.
Sample request:
{ "action": "replaceTagsInAllNotes", "version": 6, "params": { "tag_to_replace": "european-languages", "replace_with_tag": "french-languages" } }
Sample result:
{ "result": null, "error": null }
-
findNotes
Returns an array of note IDs for a given query. Query syntax is documented here.
Sample request:
{ "action": "findNotes", "version": 6, "params": { "query": "deck:current" } }
Sample result:
{ "result": [1483959289817, 1483959291695], "error": null }
-
notesInfo
Returns a list of objects containing for each note ID the note fields, tags, note type and the cards belonging to the note.
Sample request:
{ "action": "notesInfo", "version": 6, "params": { "notes": [1502298033753] } }
Sample result:
{ "result": [ { "noteId":1502298033753, "modelName": "Basic", "tags":["tag","another_tag"], "fields": { "Front": {"value": "front content", "order": 0}, "Back": {"value": "back content", "order": 1} } } ], "error": null }
-
deleteNotes
Deletes notes with the given ids. If a note has several cards associated with it, all associated cards will be deleted.
Sample request:
{ "action": "deleteNotes", "version": 6, "params": { "notes": [1502298033753] } }
Sample result:
{ "result": null, "error": null }
-
removeEmptyNotes
Removes all the empty notes for the current user.
Sample request:
{ "action": "removeEmptyNotes", "version": 6 }
Sample result:
{ "result": null, "error": null }
-
getNumCardsReviewedToday
Gets the count of cards that have been reviewed in the current day (with day start time as configured by user in anki)
Sample request:
{ "action": "getNumCardsReviewedToday", "version": 6 }
Sample result:
{ "result": 0, "error": null }
-
getNumCardsReviewedByDay
Gets the number of cards reviewed as a list of pairs of
(dateString, number)
Sample request:
{ "action": "getNumCardsReviewedByDay", "version": 6 }
Sample result:
{ "result": [ ["2021-02-28", 124], ["2021-02-27", 261] ], "error": null }
-
getCollectionStatsHTML
Gets the collection statistics report
Sample request:
{ "action": "getCollectionStatsHTML", "version": 6, "params": { "wholeCollection": true } }
Sample result:
{ "error": null, "result": "<center> lots of HTML here </center>" }
-
cardReviews
Requests all card reviews for a specified deck after a certain time.
startID
is the latest unix time not included in the result. Returns a list of 9-tuples(reviewTime, cardID, usn, buttonPressed, newInterval, previousInterval, newFactor, reviewDuration, reviewType)
Sample request:
{ "action": "cardReviews", "version": 6, "params": { "deck": "default", "startID": 1594194095740 } }
Sample result:
{ "result": [ [1594194095746, 1485369733217, -1, 3, 4, -60, 2500, 6157, 0], [1594201393292, 1485369902086, -1, 1, -60, -60, 0, 4846, 0] ], "error": null }
-
getReviewsOfCards
Requests all card reviews for each card ID. Returns a dictionary mapping each card ID to a list of dictionaries of the format:
{ "id": reviewTime, "usn": usn, "ease": buttonPressed, "ivl": newInterval, "lastIvl": previousInterval, "factor": newFactor, "time": reviewDuration, "type": reviewType, }
The reason why these key values are used instead of the more descriptive counterparts is because these are the exact key values used in Anki's database.
Sample request:
{ "action": "getReviewsOfCards", "version": 6, "params": { "cards": [ "1653613948202" ] } }
Sample result:
{ "result": { "1653613948202": [ { "id": 1653772912146, "usn": 1750, "ease": 1, "ivl": -20, "lastIvl": -20, "factor": 0, "time": 38192, "type": 0 }, { "id": 1653772965429, "usn": 1750, "ease": 3, "ivl": -45, "lastIvl": -20, "factor": 0, "time": 15337, "type": 0 } ] }, "error": null }
-
getLatestReviewID
Returns the unix time of the latest review for the given deck. 0 if no review has ever been made for the deck.
Sample request:
{ "action": "getLatestReviewID", "version": 6, "params": { "deck": "default" } }
Sample result:
{ "result": 1594194095746, "error": null }
-
insertReviews
Inserts the given reviews into the database. Required format: list of 9-tuples
(reviewTime, cardID, usn, buttonPressed, newInterval, previousInterval, newFactor, reviewDuration, reviewType)
Sample request:
{ "action": "insertReviews", "version": 6, "params": { "reviews": [ [1594194095746, 1485369733217, -1, 3, 4, -60, 2500, 6157, 0], [1594201393292, 1485369902086, -1, 1, -60, -60, 0, 4846, 0] ] } }
Sample result:
{ "result": null, "error": null }