Recall

https://docs.recall.it/
Admin
Recall is a personal AI encyclopedia that helps you capture, organize, summarize, and retain...
Tokens:15,854
Snippets:284
Trust Score:4.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Error Response Examples

Source: https://docs.recall.it/public-api

Standard JSON error responses for unauthorized access, validation failures, and missing resources.

```json
{
  "detail": {
    "message": "Invalid API key"
  }
}
```

```json
{
  "detail": {
    "message": "date_from must be before or equal to date_to"
  }
}
```

```json
{
  "detail": {
    "message": "The requested resource was not found.",
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}
```

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

### Get Card

Source: https://docs.recall.it/public-api

Returns a single card along with its content chunks.

```APIDOC
## GET /api/v1/cards/{card_id}

### Description
Returns a single card along with its content chunks.

### Method
GET

### Endpoint
/api/v1/cards/{card_id}

### Path Parameters
- **card_id** (string) - Required - The card ID. 1-128 characters.

### Query Parameters
- **focus_query** (string) - Optional - A query to focus which chunks are returned. 1-1000 characters.
- **max_chunks** (integer) - Optional - Maximum number of content chunks to return. Range: 1-50. Default: 20.

### Response
#### Success Response (200)
- **card_id** (string) - The unique identifier for the card.
- **title** (string) - The title of the card.
- **chunks** (array) - A list of content chunks associated with the card.
  - **chunk_id** (string) - The unique identifier for the chunk.
  - **content** (string) - The text content of the chunk.
  - **source** (string) - Optional - The source of the chunk (e.g., page number).
  - **timestamps** (array) - Optional - List of timestamps associated with the chunk.
- **created_at** (string) - The timestamp when the card was created.
- **image** (string) - Optional - URL of an associated image.
- **source_url** (string) - Optional - URL of the source content.

#### Response Example
```json
{
  "card_id": "card_abc123",
  "title": "My Card Title",
  "chunks": [
    {
      "chunk_id": "chunk_001",
      "content": "The actual text content of this chunk...",
      "source": "page 3",
      "timestamps": ["01:23", "04:56"]
    }
  ],
  "created_at": "Jan 15, 2025",
  "image": "https://example.com/image.png",
  "source_url": "https://example.com/article"
}
```
```

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

### Get Card Endpoint

Source: https://docs.recall.it/public-api

Retrieves a single card by ID, with optional focus query to filter content chunks.

```http
GET /api/v1/cards/{card_id}
```

```json
{
  "card_id": "card_abc123",
  "title": "My Card Title",
  "chunks": [
    {
      "chunk_id": "chunk_001",
      "content": "The actual text content of this chunk...",
      "source": "page 3",
      "timestamps": ["01:23", "04:56"]
    }
  ],
  "created_at": "Jan 15, 2025",
  "image": "https://example.com/image.png",
  "source_url": "https://example.com/article"
}
```

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

### Insert a new block using '/' command

Source: https://docs.recall.it/deep-dives/note-taking-in-recall

Type '/' in your Recall notebook to open a menu of available content blocks for quick insertion.

```text
/ 
```

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

### MCP Tool: explore_kb

Source: https://docs.recall.it/public-api

Explore knowledge base structure and statistics.

```APIDOC
## MCP Tool: explore_kb

### Description
Explore knowledge base structure and statistics.

### Parameters
#### Request Body
- **action** (string) - Required - "get_stats": total cards, date range, top tags, connections. "list_tags": all tags with usage counts. "list_sources": common domains/sources.
```

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

### MCP Tool: search

Source: https://docs.recall.it/public-api

Search your saved content by semantic and keyword matching.

```APIDOC
## MCP Tool: search

### Description
Search your saved content by semantic + keyword matching.

### Parameters
#### Request Body
- **queries** (list[str]) - Required - Search queries.
- **mode** (string) - Optional (default: "focused") - "focused": top 5–10 cards with many chunks. "exhaustive": all matching cards (10–25) with 3 preview chunks each.
- **card_id** (string) - Optional - Search within a specific document only.
- **date_from** (string) - Optional - Filter from date (ISO format).
- **date_to** (string) - Optional - Filter to date (ISO format).
- **tag_ids** (list[str]) - Optional - Tag IDs, OR logic.
- **source_url_contains** (string) - Optional - Website domain filter.
```

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

### Add a new block above the current one

Source: https://docs.recall.it/deep-dives/note-taking-in-recall

Hold the Option key and press '+' to insert a new block above the current one.

```text
Option + +
```

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

### Add a new block below the current one

Source: https://docs.recall.it/deep-dives/note-taking-in-recall

Press the '+' sign to create a new block directly beneath the current one in your Recall notebook.

```text
+ 
```

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

### MCP Tool: get_document_content

Source: https://docs.recall.it/public-api

Retrieve key content from a document as deduplicated chunks.

```APIDOC
## MCP Tool: get_document_content

### Description
Retrieve key content from a document as deduplicated chunks. Use after discovering a card via search or filter_by_metadata to read its complete content.

### Parameters
#### Request Body
- **card_id** (string) - Required - Card ID from search/filter results.
- **focus_query** (string) - Optional - Extract only sections matching this query.
- **max_chunks** (integer) - Optional (default: 20) - Maximum chunks to return.
```

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

### Search Endpoint

Source: https://docs.recall.it/public-api

Performs a semantic search across cards to return relevant content chunks.

```http
GET /api/v1/search
```

```json
{
  "documents": [
    {
      "card_id": "card_abc123",
      "title": "My Card Title",
      "created_at": "Jan 15, 2025",
      "image": "https://example.com/image.png",
      "source_url": "https://example.com/article",
      "chunks": [
        {
          "chunk_id": "chunk_001",
          "content": "Relevant text passage...",
          "source": "page 3",
          "timestamps": ["01:23"]
        }
      ]
    }
  ],
  "total_cards": 1,
  "total_chunks": 1
}
```

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

### Error Handling

Source: https://docs.recall.it/public-api

Information on how to handle common error responses from the Recall It API.

```APIDOC
## 500 Internal Server Error

### Description
Returned when something unexpected goes wrong on our end.

### Response Example
```json
{
  "detail": {
    "message": "An internal error occurred. Contact support with this request ID.",
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}
```

### Getting Help
If you receive a `404` or `500` error, note the `request_id` from the response. Our support team can use it to look up exactly what happened.
```

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

### Transform a block type

Source: https://docs.recall.it/deep-dives/note-taking-in-recall

Click the '⋮⋮' symbol on a block and select 'Turn into' to convert it to a different block type, such as changing a paragraph to a heading.

```text
⋮⋮
```

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

### List Cards

Source: https://docs.recall.it/public-api

Returns cards matching your filters. When no filters are provided, all cards are returned.

```APIDOC
## GET /api/v1/cards

### Description
Returns cards matching your filters. When no filters are provided, all cards are returned.

### Method
GET

### Endpoint
/api/v1/cards

### Query Parameters
- **tags** (string[]) - Optional - Filter by tag IDs (UUIDs). Max 50 items.
- **date_from** (string) - Optional - Start of date range (ISO 8601, e.g. `2025-01-15T00:00:00Z`).
- **date_to** (string) - Optional - End of date range (ISO 8601, e.g. `2025-01-20T00:00:00Z`).
- **source_url_contains** (string) - Optional - Filter cards whose source URL contains this substring. 1-500 characters.

### Response
#### Success Response (200)
- **results** (array) - A list of card objects.
  - **id** (string) - The unique identifier for the card.
  - **title** (string) - The title of the card.
  - **created_at** (string) - The timestamp when the card was created.
  - **image** (string) - Optional - URL of an associated image.
  - **source_url** (string) - Optional - URL of the source content.
- **total_count** (integer) - The total number of cards returned.

#### Response Example
```json
{
  "results": [
    {
      "id": "card_abc123",
      "title": "My Card Title",
      "created_at": "Jan 15, 2025",
      "image": "https://example.com/image.png",
      "source_url": "https://example.com/article"
    }
  ],
  "total_count": 1
}
```
```

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

### Code block syntax highlighting

Source: https://docs.recall.it/deep-dives/note-taking-in-recall

Recall supports syntax highlighting for various languages including Bash, CSS, HTML, JavaScript, JSON, Markdown, Python, Shell, and TypeScript within code blocks.

```plaintext
Bash
CSS
HTML
JavaScript
JSON
Markdown
Python
Shell
TypeScript
```

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

### Search Cards

Source: https://docs.recall.it/public-api

Performs a semantic search across your cards and returns the most relevant content chunks.

```APIDOC
## GET /api/v1/search

### Description
Performs a semantic search across your cards and returns the most relevant content chunks.

### Method
GET

### Endpoint
/api/v1/search

### Query Parameters
- **q** (string) - Required - Your search query. 1-1000 characters.
- **mode** (string) - Optional - Search mode: `"focused"` (faster, fewer results) or `"exhaustive"` (broader coverage). Default: `"focused"`.
- **card_id** (string) - Optional - Limit search to a specific card. 1-128 characters.
- **tags** (string[]) - Optional - Filter by tag IDs (UUIDs). Max 50 items.
- **date_from** (string) - Optional - Start of date range (ISO 8601, e.g. `2025-01-15T00:00:00Z`).
- **date_to** (string) - Optional - End of date range (ISO 8601, e.g. `2025-01-20T00:00:00Z`).
- **source_url_contains** (string) - Optional - Filter by source URL substring. 1-500 characters.

### Response
#### Success Response (200)
- **documents** (array) - A list of documents matching the search query.
  - **card_id** (string) - The unique identifier for the card.
  - **title** (string) - The title of the card.
  - **created_at** (string) - The timestamp when the card was created.
  - **image** (string) - Optional - URL of an associated image.
  - **source_url** (string) - Optional - URL of the source content.
  - **chunks** (array) - A list of content chunks relevant to the search query.
    - **chunk_id** (string) - The unique identifier for the chunk.
    - **content** (string) - The text content of the chunk.
    - **source** (string) - Optional - The source of the chunk.
    - **timestamps** (array) - Optional - List of timestamps associated with the chunk.
- **total_cards** (integer) - The total number of cards found.
- **total_chunks** (integer) - The total number of chunks found.

#### Response Example
```json
{
  "documents": [
    {
      "card_id": "card_abc123",
      "title": "My Card Title",
      "created_at": "Jan 15, 2025",
      "image": "https://example.com/image.png",
      "source_url": "https://example.com/article",
      "chunks": [
        {
          "chunk_id": "chunk_001",
          "content": "Relevant text passage...",
          "source": "page 3",
          "timestamps": ["01:23"]
        }
      ]
    }
  ],
  "total_cards": 1,
  "total_chunks": 1
}
```
```

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

### Authenticate Public API Requests

Source: https://docs.recall.it/public-api

Include the API key in the Authorization header for all HTTP requests to the Recall API.

```http
Authorization: Bearer sk_a1b2c3d4e5f6g7h8i9j0k1l2
```

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

### MCP Tool: filter_by_metadata

Source: https://docs.recall.it/public-api

Filter documents by metadata (date, tags, source URL) without semantic search.

```APIDOC
## MCP Tool: filter_by_metadata

### Description
Filter documents by metadata (date, tags, source URL). No semantic search. Returns previews with id, title, and created_at.

### Parameters
#### Request Body
- **date_from** (string) - Optional - Filter from date (ISO format).
- **date_to** (string) - Optional - Filter to date (ISO format).
- **tag_ids** (list[str]) - Optional - Tag IDs, OR logic.
- **source_url_contains** (string) - Optional - Website domain filter.
```

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

### List Cards Endpoint

Source: https://docs.recall.it/public-api

Retrieves a list of cards, optionally filtered by tags, date range, or source URL.

```http
GET /api/v1/cards
```

```json
{
  "results": [
    {
      "id": "card_abc123",
      "title": "My Card Title",
      "created_at": "Jan 15, 2025",
      "image": "https://example.com/image.png",
      "source_url": "https://example.com/article"
    }
  ],
  "total_count": 1
}
```

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

### Error Responses

Source: https://docs.recall.it/public-api

Details on possible error responses from the API.

```APIDOC
### Error Responses

#### 401 Unauthorized
Returned when your API key is missing, invalid, or expired.
```json
{
  "detail": {
    "message": "Invalid API key"
  }
}
```

#### 422 Validation Error
Returned when a parameter doesn’t meet the validation rules.
```json
{
  "detail": {
    "message": "date_from must be before or equal to date_to"
  }
}
```

#### 404 Not Found
Returned when the requested resource doesn’t exist.
```json
{
  "detail": {
    "message": "The requested resource was not found.",
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}
```
```

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

### Inline LaTeX equation

Source: https://docs.recall.it/deep-dives/note-taking-in-recall

Insert mathematical or technical equations inline within a paragraph using LaTeX formatting.

```latex
E=mc²
```
Tokens:
Raw