Anki-Connect

https://git.sr.ht/~foosoft/anki-connect
Admin
Anki-Connect enables external applications to communicate with Anki over a simple HTTP API,...
Tokens:4,986,724
Snippets:61,219
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### guiDeckOverview

Source: https://git.sr.ht/~foosoft/anki-connect/tree/056e722187551ba91fc7e06b654e75284004ecca/item/README.md

Opens the Deck Overview dialog. This action is asynchronous and returns immediately.

```APIDOC
## guiDeckOverview

### Description
Opens the Deck Overview dialog for a specified deck.

### Method
POST

### Endpoint
/

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform, which is "guiDeckOverview".
- **version** (integer) - Required - The API version, which is 6.
- **params** (object) - Required - Parameters for the action.
  - **name** (string) - Required - The name of the deck to open the overview for.

### Request Example
```json
{
    "action": "guiDeckOverview",
    "version": 6,
    "params": {
        "name": "Default"
    }
}
```

### Response
#### Success Response (200)
- **result** (boolean) - Indicates if the operation was successful.
- **error** (null) - Will be null if the operation was successful.

#### Response Example
```json
{
    "result": true,
    "error": null
}
```
```

--------------------------------

### Get Deck Names with Python

Source: https://git.sr.ht/~foosoft/anki-connect/commit/4010293efae8c7a9cabb8a71d7cdb298e0291ece.patch

Use Python's requests library to send a POST request to the Anki-Connect API to retrieve deck names. This example assumes the 'requests' library is installed.

```python
import requests

response = requests.post('http://localhost:8765', json={'action': 'deckNames', 'version': 6})
print(response.json()['result'])

```

--------------------------------

### Example: Get Deck Names (PowerShell)

Source: https://git.sr.ht/~foosoft/anki-connect/tree/00dffe579d9f6baa1ac73b047d92a1c648428d8d/item/README.md?view-source=

This example shows how to get deck names using PowerShell.

```APIDOC
## Get Deck Names (PowerShell)

### Description
Retrieves a list of all available deck names in Anki using PowerShell.

### Method
POST

### Endpoint
`http://localhost:8765`

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform, e.g., "deckNames".
- **version** (integer) - Required - The API version, e.g., 6.

### Request Example
```powershell
(Invoke-RestMethod -Uri http://localhost:8765 -Method Post -Body '{"action": "deckNames", "version": 6}').result
```

### Response
#### Success Response (200)
- **result** (array of strings) - A list of deck names.

### Response Example
```json
["Default", "Filtered Deck 1"]
```
```

--------------------------------

### Open Deck Overview with guiDeckOverview

Source: https://git.sr.ht/~foosoft/anki-connect/blob/01e506588cb31749f051791eea27ad09954fdaf7/README.md

Opens the Deck Overview dialog for a specified deck. Requires the deck name as a parameter. Returns true if successful.

```json
{
    "action": "guiDeckOverview",
    "version": 6,
	"params": {
		"name": "Default"
	}
}
```

--------------------------------

### Example: Get Deck Names (Powershell)

Source: https://git.sr.ht/~foosoft/anki-connect/tree/47da1c5039f42ad004acc57f528d6f873caffdc9/item/README.md?view-source=

This example shows how to get deck names using Powershell's Invoke-RestMethod.

```APIDOC
## Get Deck Names (Powershell)

### Description
Retrieves a list of all available deck names in Anki using Powershell.

### Method
POST

### Endpoint
`http://localhost:8765`

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform, set to "deckNames".
- **version** (integer) - Required - The API version, set to 6 for this example.

### Request Example
```powershell
(Invoke-RestMethod -Uri http://localhost:8765 -Method Post -Body '{"action": "deckNames", "version": 6}').result
```

### Response
#### Success Response (200)
- **result** (array of strings) - A list of deck names.

#### Response Example
```powershell
Default
Filtered Deck 1
```
```

--------------------------------

### Sample Request and Response for guiDeckReview

Source: https://git.sr.ht/~foosoft/anki-connect/commit/0b9fae13fdb5f8a8bde61f509934efefd28b41fb.patch

This snippet shows a sample request to start a review for a deck and its corresponding null response, indicating the action was initiated.

```json
{
    "action": "guiDeckReview",
	"params": {
		"name": "Default"
	}
}
```

```json
null
```

--------------------------------

### Powershell Example: Get Deck Names

Source: https://git.sr.ht/~foosoft/anki-connect/tree/9f7dccaca071eedb51068bdf6ae5a11ffa60bac7/item/README.md

This example shows how to use PowerShell to request and display the result of getting all deck names from Anki-Connect.

```APIDOC
## Powershell Example: Get Deck Names

This example demonstrates how to use PowerShell to fetch and display the result of the `deckNames` action.

### Method
POST

### Endpoint
`http://localhost:8765`

### Request Body
```json
{
  "action": "deckNames",
  "version": 6
}
```

### Request Example (Powershell)
```powershell
(Invoke-RestMethod -Uri http://localhost:8765 -Method Post -Body '{"action": "deckNames", "version": 6}').result
```

### Response Example (Result Field)
```
Default
Filtered Deck 1
```
```

--------------------------------

### Start Deck Review

Source: https://git.sr.ht/~foosoft/anki-connect/tree/01ba3bec539ad8bfdee8f425812a2d5e2b2fa441/item/README.md

Use `guiDeckReview` to initiate a review session for a specified deck. Returns `true` if successful.

```json
{
    "action": "guiDeckReview",
    "version": 5,
    "params": {
        "name": "Default"
    }
}
```

--------------------------------

### Curl Example: Get Deck Names

Source: https://git.sr.ht/~foosoft/anki-connect/blob/035ebeb927964d31bc3cb57b834f76662474b528/README.md

Example of how to invoke the 'deckNames' action using curl.

```APIDOC
## Curl Example

```bash
curl localhost:8765 -X POST -d "{\"action\": \"deckNames\", \"version\": 6}"
```
```

--------------------------------

### guiDeckOverview - Open Deck Overview

Source: https://git.sr.ht/~foosoft/anki-connect/blob/013050cb9a0bbe7d2ecb62a1f7b7f9ba51eba52e/README.md

Opens the Deck Overview screen for a specified deck. Returns true if successful, false otherwise.

```json
{
    "action": "guiDeckOverview",
	"params": {
		"name": "Default"
	}
}
```

--------------------------------

### Get Deck Names (Powershell Example)

Source: https://git.sr.ht/~foosoft/anki-connect/tree/b5f6e86df6ffb89cd790fd79ed6db09004b073c9/item/README.md

Example of how to retrieve a list of all deck names using Powershell.

```APIDOC
## GET /deckNames (Powershell)

### Description
Retrieves a list of all available deck names in Anki using Powershell.

### Method
POST

### Endpoint
`http://localhost:8765`

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform, should be `"deckNames"`.
- **version** (integer) - Required - The API version, should be `6` for this action.

### Request Example
```powershell
(Invoke-RestMethod -Uri http://localhost:8765 -Method Post -Body '{"action": "deckNames", "version": 6}').result
```

### Response
#### Success Response (200)
- **result** (array of strings) - A list of deck names.

#### Response Example (output of the command)
```
Default
Filtered Deck 1
```
```

--------------------------------

### Start Deck Review with guiDeckReview

Source: https://git.sr.ht/~foosoft/anki-connect/blob/01ba3bec539ad8bfdee8f425812a2d5e2b2fa441/README.md

Starts a review session for a specified deck. Returns true if successful, false otherwise.

```json
{
    "action": "guiDeckReview",
    "version": 5,
	"params": {
		"name": "Default"
	}
}
```

--------------------------------

### Example Curl Request

Source: https://git.sr.ht/~foosoft/anki-connect/tree/41ce15611407e536c12b7c17a7f7af7ee0bcb487/item/README.md?view-source=

A simple example of how to call the Anki-Connect API using curl to get deck names.

```APIDOC
## Example: Get Deck Names using Curl

### Method
POST

### Endpoint
`http://localhost:8765`

### Request Body

```json
{
  "action": "deckNames",
  "version": 6
}
```

### Curl Command

```bash
curl localhost:8765 -X POST -d '{"action": "deckNames", "version": 6}'
```
```

--------------------------------

### guiDeckOverview

Source: https://git.sr.ht/~foosoft/anki-connect/tree/07ddcead5e6fce0d3fa3bb88ede4e26540135f63/item/README.md

Displays an overview of the specified deck. This action is asynchronous and returns immediately.

```APIDOC
## guiDeckOverview

### Description
Displays an overview of the specified deck.

### Method
POST

### Endpoint
/

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform, which is "guiDeckOverview".
- **version** (integer) - Required - The version of the API.
- **params** (object) - Required - Parameters for the action.
  - **name** (string) - Required - The name of the deck to get an overview for.

### Request Example
```json
{
    "action": "guiDeckOverview",
    "version": 6,
    "params": {
        "name": "Default"
    }
}
```

### Response
#### Success Response (200)
- **result** (boolean) - Indicates if the action was successful.
- **error** (null) - Always null for this action.

#### Response Example
```json
{
    "result": true,
    "error": null
}
```
```

--------------------------------

### Example: Get Deck Names (Powershell)

Source: https://git.sr.ht/~foosoft/anki-connect/tree/14a8a84150647935ac3cf41e3f6fdd1c35454930/item/README.md?view-source=

This example demonstrates how to retrieve a list of all deck names using Powershell.

```APIDOC
## Get Deck Names (Powershell)

### Description
Retrieves a list of all available deck names in Anki using Powershell.

### Method
POST

### Endpoint
`http://localhost:8765`

### Request Body
```json
{
  "action": "deckNames",
  "version": 6
}
```

### Request Example (Powershell)
```powershell
(Invoke-RestMethod -Uri http://localhost:8765 -Method Post -Body '{"action": "deckNames", "version": 6}').result
```

### Response Example (Success)
```json
["Default", "Filtered Deck 1"]
```
```

--------------------------------

### guiDeckOverview - Open Deck Overview Dialog

Source: https://git.sr.ht/~foosoft/anki-connect/refs/23.2.5.0

Opens the Deck Overview dialog for a specified deck. Returns true if successful, false otherwise. Requires the deck name as input.

```json
{
    "action": "guiDeckOverview",
    "version": 6,
    "params": {
        "deck": "Default"
    }
}
```

```json
{
    "result": true,
    "error": null
}
```

--------------------------------

### Curl Example: Get Deck Names

Source: https://git.sr.ht/~foosoft/anki-connect/tree/06c40ed85d8eaf8132edafca11307cb9147f6ef8/item/README.md

Example of how to use curl to request a list of deck names from AnkiConnect.

```APIDOC
## Curl Example

### Description
This example demonstrates how to fetch a list of all deck names in Anki using curl.

### Command
```bash
curl localhost:8765 -X POST -d "{\"action\": \"deckNames\", \"version\": 6}"
```
```

--------------------------------

### Open Deck Overview with guiDeckOverview

Source: https://git.sr.ht/~foosoft/anki-connect/blob/01ba3bec539ad8bfdee8f425812a2d5e2b2fa441/README.md

Opens the Deck Overview dialog for a specified deck. Returns true if successful, false otherwise.

```json
{
    "action": "guiDeckOverview",
    "version": 5,
	"params": {
		"name": "Default"
	}
}
```

--------------------------------

### Get Deck Names (Powershell Example)

Source: https://git.sr.ht/~foosoft/anki-connect/blob/d27f54a4fe6de1b1ea86244c9d0cb36dce88a8b2/README.md

Example of how to retrieve a list of all deck names from Anki using Powershell.

```APIDOC
## GET Deck Names (Powershell)

### Description
Retrieves a list of all available deck names in Anki using Powershell.

### Method
POST

### Endpoint
`http://localhost:8765`

### Parameters
#### Request Body
- **action** (string) - Required - `"deckNames"`
- **version** (integer) - Required - `6`

### Request Example
```powershell
(Invoke-RestMethod -Uri http://localhost:8765 -Method Post -Body '{"action": "deckNames", "version": 6}').result
```

### Response
#### Success Response (200)
- **result** (array of strings) - A list of deck names.

### Response Example
```
Default
Filtered Deck 1
```
```

--------------------------------

### Open Deck Overview with guiDeckOverview

Source: https://git.sr.ht/~foosoft/anki-connect/blob/05b4e9ab8ddb184a4e5542d00ce6df1e9f6dfc4c/README.md

Opens the Deck Overview dialog for a specified deck. Returns true if successful.

```json
{
    "action": "guiDeckOverview",
    "version": 5,
	"params": {
		"name": "Default"
	}
}
```

```json
{
    "result": true,
    "error": null
}
```

--------------------------------

### Start Deck Review with guiDeckReview

Source: https://git.sr.ht/~foosoft/anki-connect/blob/01e506588cb31749f051791eea27ad09954fdaf7/README.md

Initiates a review session for a specified deck. Requires the deck name as a parameter. Returns true if successful.

```json
{
    "action": "guiDeckReview",
    "version": 6,
	"params": {
		"name": "Default"
	}
}
```

--------------------------------

### Example: Get Deck Names using Curl

Source: https://git.sr.ht/~foosoft/anki-connect/tree/532a3c816e08e91c4367e2799ce3779403d70274/item/README.md

This example demonstrates how to retrieve a list of all deck names using curl.

```APIDOC
## Get Deck Names (Curl Example)

### Description
This example shows how to call the `deckNames` action using `curl` to get a list of all available deck names in Anki.

### Method
POST

### Endpoint
`http://localhost:8765`

### Request Body
```json
{
  "action": "deckNames",
  "version": 6
}
```

### Curl Command
```bash
curl localhost:8765 -X POST -d '{"action": "deckNames", "version": 6}'
```

### Response Example (Success)
```json
{
  "result": [
    "Default",
    "Filtered Deck 1"
  ],
  "error": null
}
```
```

--------------------------------

### Example: Get Deck Names using PowerShell

Source: https://git.sr.ht/~foosoft/anki-connect/tree/48650d940f4b58f0af233f82a5f0e7095e705411/item/README.md

This example shows how to fetch deck names from Anki using PowerShell.

```APIDOC
## Get Deck Names (PowerShell)

### Description
Retrieves a list of all available deck names in Anki using PowerShell.

### Method
POST

### Endpoint
`http://localhost:8765`

### Request Body
```json
{
  "action": "deckNames",
  "version": 6
}
```

### Request Example
```powershell
(Invoke-RestMethod -Uri http://localhost:8765 -Method Post -Body '{"action": "deckNames", "version": 6}').result
```

### Response Example (Success)
This command directly outputs the result field, which would be an array of deck names.
```

--------------------------------

### Start Review with guiDeckReview

Source: https://git.sr.ht/~foosoft/anki-connect/blob/05b4e9ab8ddb184a4e5542d00ce6df1e9f6dfc4c/README.md

Initiates a review session for a specified deck. Returns true if successful.

```json
{
    "action": "guiDeckReview",
    "version": 5,
	"params": {
		"name": "Default"
	}
}
```

```json
{
    "result": true,
    "error": null
}
```

--------------------------------

### Start Deck Review with guiDeckReview

Source: https://git.sr.ht/~foosoft/anki-connect/tree/d08d2510e71e29d223d837120c33dc502e15af39/item/README.md?view-source=

Initiates a review session for a specified deck. Returns true if successful.

```json
{
    "action": "guiDeckReview",
    "version": 6,
	"params": {
		"name": "Default"
	}
}
```

```json
{
    "result": true,

```

--------------------------------

### Example Request: Get Deck Names

Source: https://git.sr.ht/~foosoft/anki-connect/tree/3d7e00a86ca3abc3ca41e5cd7aa9a44a2d744b95/item/README.md?view-rendered=

This example demonstrates how to use curl to request the list of deck names from Anki-Connect.

```APIDOC
## Example Request: Get Deck Names

### Method
POST

### Endpoint
`localhost:8765`

### Request Body
```json
{
  "action": "deckNames",
  "version": 6
}
```

### Request Example (curl)
```bash
curl localhost:8765 -X POST -d '{"action": "deckNames", "version": 6}'
```

### Response Example (Success)
```json
{
  "result": ["Default", "Filtered Deck 1"],
  "error": null
}
```
```

--------------------------------

### Example: Get Deck Names using PowerShell

Source: https://git.sr.ht/~foosoft/anki-connect/tree/2019ba75ed4f9299f4b4a76740e04268385165a9/item/README.md?view-rendered=

This example shows how to fetch deck names from Anki-Connect using PowerShell.

```APIDOC
## Get Deck Names (PowerShell)

### Description
Retrieves a list of all available deck names in Anki using PowerShell.

### Method
POST

### Endpoint
`http://localhost:8765`

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform, `deckNames`.
- **version** (integer) - Required - The API version, typically `6`.

### Request Example
```powershell
(Invoke-RestMethod -Uri http://localhost:8765 -Method Post -Body '{"action": "deckNames", "version": 6}').result
```

### Response
#### Success Response (200)
- **result** (array of strings) - A list of deck names.

#### Response Example (Output of the command)
```
Default
Filtered Deck 1
```
```

--------------------------------

### guiDeckOverview

Source: https://git.sr.ht/~foosoft/anki-connect/tree/b19528e4437115b4bcc83733f9dd00404c576632/item/README.md?view-source=

Opens the Deck Overview dialog for a specified deck. Returns `true` if successful.

```APIDOC
## guiDeckOverview

### Description
Opens the *Deck Overview* dialog for the deck with the given name. Returns `true` if succeeded or `false` otherwise.

### Method
POST

### Endpoint
/guiDeckOverview

### Parameters
#### Request Body
- **name** (string) - Required - The name of the deck to open.

### Request Example
```json
{
    "action": "guiDeckOverview",
    "version": 6,
    "params": {
        "name": "Default"
    }
}
```

### Response
#### Success Response (200)
- **result** (boolean) - `true` if the dialog was opened successfully, `false` otherwise.
- **error** (null) - Always null on success.

#### Response Example
```json
{
    "result": true,
    "error": null
}
```
```

--------------------------------

### guiDeckOverview

Source: https://git.sr.ht/~foosoft/anki-connect/tree/83cc55769bd905c3c74e22b70a1c746ee8a93608/item/README.md?view-rendered=

Displays a graphical overview of the specified deck. This action is asynchronous and returns immediately.

```APIDOC
## guiDeckOverview

### Description
Displays a graphical overview of the specified deck.

### Method
POST

### Endpoint
/

### Request Body
- **action** (string) - Required - The action to perform, must be "guiDeckOverview".
- **version** (integer) - Required - The version of the API, must be 6.
- **params** (object) - Required - Parameters for the action.
  - **name** (string) - Required - The name of the deck to display an overview for.

### Request Example
```json
{
    "action": "guiDeckOverview",
    "version": 6,
    "params": {
        "name": "Default"
    }
}
```

### Response
#### Success Response (200)
- **result** (boolean) - Indicates if the operation was successful.
- **error** (null) - Should be null on success.

#### Response Example
```json
{
    "result": true,
    "error": null
}
```
```

--------------------------------

### Example: Get Deck Names using Powershell

Source: https://git.sr.ht/~foosoft/anki-connect/tree/ad4a4a4661ec4f6539621f554f9eac6a213e6051/item/README.md?view-source=

This example demonstrates how to retrieve a list of all deck names in Anki using Powershell.

```APIDOC
## Get Deck Names (Powershell)

### Description
Retrieves a list of all available deck names in Anki using Powershell.

### Method
POST

### Endpoint
`http://localhost:8765`

### Parameters
#### Request Body
- **action** (string) - Required - `deckNames`
- **version** (integer) - Required - `6`
- **params** (object) - Optional - `{}`

### Request Example (Powershell)
```powershell
(Invoke-RestMethod -Uri http://localhost:8765 -Method Post -Body '{"action": "deckNames", "version": 6}').result
```

### Response Example (Success)
```json
["Default", "Filtered Deck 1"]
```
```
Tokens:
Raw