# Questions and answers
Source: https://docs.paperzilla.ai/answers/index

Common questions about Paperzilla

<AiAgents />


# How do I get less email?
Source: https://docs.paperzilla.ai/answers/less-email

Control email notifications from Paperzilla

<AiAgents />


# Introduction
Source: https://docs.paperzilla.ai/api-reference/introduction

Paperzilla API reference

<AiAgents />


# CLI
Source: https://docs.paperzilla.ai/guides/cli

Use the Paperzilla CLI to manage papers from your terminal

<AiAgents />

The Paperzilla CLI (`pz`) lets you browse your curated research feed, manage projects, and stay on top of new papers from the terminal. It works for both humans and AI agents — use `--json` to get structured output.

## Install

<Tabs>
  <Tab title="macOS">
    ```bash theme={null}
    brew install paperzilla-ai/tap/pz
    ```
  </Tab>

  <Tab title="Windows">
    Via [Scoop](https://scoop.sh):

    ```bash theme={null}
    scoop bucket add paperzilla-ai https://github.com/paperzilla-ai/scoop-bucket
    scoop install pz
    ```
  </Tab>

  <Tab title="Linux">
    Download from [GitHub Releases](https://github.com/paperzilla-ai/pz/releases):

    ```bash theme={null}
    curl -sL https://github.com/paperzilla-ai/pz/releases/latest/download/pz_linux_amd64.tar.gz | tar xz
    sudo mv pz /usr/local/bin/
    ```
  </Tab>

  <Tab title="From source">
    Requires Go 1.23+:

    ```bash theme={null}
    git clone https://github.com/paperzilla-ai/pz.git
    cd pz
    go build -o pz .
    mv pz /usr/local/bin/
    ```
  </Tab>
</Tabs>

## Log in

Authenticate with your Paperzilla account. You receive a one-time code via email.

<Info>Don't have an account yet? Follow the [quickstart](/quickstart) to sign up first.</Info>

```bash theme={null}
pz login
```

```
Email: you@example.com
Sending magic link...
Check your email, enter the code: 123456
Logged in!
```

Your session persists across commands and refreshes automatically. If it expires, the login flow starts automatically.

## Commands

### pz project list

List all your projects.

```bash theme={null}
pz project list
```

```
ID                                    NAME                       MODE        VISIBILITY  CREATED
a1b2c3d4-e5f6-7890-abcd-ef1234567890  Machine Learning Papers    auto        private     2025-06-15 10:30
b2c3d4e5-f6a7-8901-bcde-f12345678901  Genomics Research          auto        private     2025-07-20 14:15
```

### pz project \<id>

Show details for a specific project.

```bash theme={null}
pz project a1b2c3d4-e5f6-7890-abcd-ef1234567890
```

```
Name:             Machine Learning Papers
ID:               a1b2c3d4-e5f6-7890-abcd-ef1234567890
Mode:             auto
Visibility:       private
Matching State:   active
Email Frequency:  daily
Email Time:       09:00
Max Candidates:   100
Max Papers/Digest:20
Created:          2025-06-15 10:30
Activated:        2025-06-16 00:00
Last Digest:      2025-08-01 09:00

Interest:
  Recent advances in transformer architectures and efficiency
```

### pz feed \<project-id>

Browse the curated paper feed for a project.

```bash theme={null}
pz feed a1b2c3d4-e5f6-7890-abcd-ef1234567890
```

```
Machine Learning Papers — 12 papers (total: 142)

★ Must Read  A Novel Approach to Transformer Efficiency
  Smith et al. · arxiv · 2025-08-01 · relevance: 92%

○ Related  On the Convergence Properties of Diffusion Models
  Chen et al. · arxiv · 2025-07-30 · relevance: 74%
```

Each paper shows a relevance class (`★ Must Read` or `○ Related`), title, first author, source, date, and relevance score.

#### Flags

| Flag          | Short | Description                                            |
| ------------- | ----- | ------------------------------------------------------ |
| `--json`      | `-j`  | Output as JSON                                         |
| `--must-read` | `-m`  | Only show must-read papers                             |
| `--since`     | `-s`  | Only papers after this date (ISO 8601 or `YYYY-MM-DD`) |
| `--limit`     | `-n`  | Limit number of results                                |
| `--atom`      |       | Print Atom feed URL for feed readers                   |

#### Examples

```bash theme={null}
# Only must-read papers from the last week
pz feed <project-id> --must-read --since 2025-07-25 --limit 5

# Export as JSON for scripting
pz feed <project-id> --json

# Pipe to jq
pz feed <project-id> --json | jq '.[].paper.title'

# Get Atom feed URL for your feed reader
pz feed <project-id> --atom
```

### Atom feeds

The `--atom` flag prints a URL you can paste into any feed reader (Vienna RSS, NetNewsWire, Feedly, etc.):

```bash theme={null}
pz feed <project-id> --atom
```

```
https://paperzilla.ai/api/feed/atom/a1b2c3d4-...?token=pzft_...
```

The URL contains a personal feed token so the reader can poll without logging in. The token is per-user, and the same URL is returned on repeated calls. See the [feeds guide](/guides/feeds) for more on RSS/Atom.

## JSON output

With `--json`, the feed returns structured data suitable for scripting and AI agents:

```json theme={null}
{
  "items": [
    {
      "id": "uuid",
      "short_id": "abc123",
      "paper_title": "A Novel Approach to...",
      "relevance_score": 0.92,
      "relevance_class": 2,
      "personalized_note": "Relevant because...",
      "ready_at": "2025-08-01T09:00:00Z",
      "paper": {
        "title": "A Novel Approach to...",
        "authors": [{"name": "Jane Smith"}],
        "published_date": "2025-07-20",
        "pdf_url": "https://arxiv.org/pdf/2507.12345",
        "url": "https://arxiv.org/abs/2507.12345",
        "source_id": 1
      }
    }
  ],
  "total": 142,
  "limit": 20,
  "offset": 0
}
```

**Relevance classes:** `2` = Must Read, `1` = Related

**Source IDs:** `1` = arXiv, `2` = bioRxiv, `3` = medRxiv, `4` = chinaXiv

## Configuration

| Variable     | Description  | Default                 |
| ------------ | ------------ | ----------------------- |
| `PZ_API_URL` | API base URL | `https://paperzilla.ai` |


# RSS and Atom feeds
Source: https://docs.paperzilla.ai/guides/feeds

Subscribe to Paperzilla feeds for updates on your projects

<AiAgents />


# Projects
Source: https://docs.paperzilla.ai/guides/projects

Set up and manage your projects in the Paperzilla portal

<AiAgents />


# Introduction
Source: https://docs.paperzilla.ai/index

Welcome to the new home for your documentation

<AiAgents />

## Setting up

Get your documentation site up and running in minutes.

<Card title="Start here" icon="rocket" href="/quickstart">
  Follow our three step quickstart guide.
</Card>

## Make it yours

Design a docs site that looks great and empowers your users.

<Columns>
  <Card title="Edit locally" icon="pen-to-square" href="/development">
    Edit your docs locally and preview them in real time.
  </Card>

  <Card title="Customize your site" icon="palette" href="/essentials/settings">
    Customize the design and colors of your site to match your brand.
  </Card>

  <Card title="Set up navigation" icon="map" href="/essentials/navigation">
    Organize your docs to help users find what they need and succeed with your product.
  </Card>

  <Card title="API documentation" icon="terminal" href="/api-reference/introduction">
    Auto-generate API documentation from OpenAPI specifications.
  </Card>
</Columns>

## Create beautiful pages

Everything you need to create world-class documentation.

<Columns>
  <Card title="Write with MDX" icon="pen-fancy" href="/essentials/markdown">
    Use MDX to style your docs pages.
  </Card>

  <Card title="Code samples" icon="code" href="/essentials/code">
    Add sample code to demonstrate how to use your product.
  </Card>

  <Card title="Images" icon="image" href="/essentials/images">
    Display images and other media.
  </Card>

  <Card title="Reusable snippets" icon="recycle" href="/essentials/reusable-snippets">
    Write once and reuse across your docs.
  </Card>
</Columns>

## Need inspiration?

<Card title="See complete examples" icon="stars" href="https://mintlify.com/customers">
  Browse our showcase of exceptional documentation sites.
</Card>


# Quickstart
Source: https://docs.paperzilla.ai/quickstart

Start building awesome documentation in minutes

<AiAgents />

## Get started in three steps

Get your documentation site running locally and make your first customization.

### Step 1: Set up your local environment

<AccordionGroup>
  <Accordion icon="copy" title="Clone your docs locally">
    During the onboarding process, you created a GitHub repository with your docs content if you didn't already have one. You can find a link to this repository in your [dashboard](https://dashboard.mintlify.com).

    To clone the repository locally so that you can make and preview changes to your docs, follow the [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) guide in the GitHub docs.
  </Accordion>

  <Accordion icon="rectangle-terminal" title="Start the preview server">
    1. Install the Mintlify CLI: `npm i -g mint`
    2. Navigate to your docs directory and run: `mint dev`
    3. Open `http://localhost:3000` to see your docs live!

    <Tip>Your preview updates automatically as you edit files.</Tip>
  </Accordion>
</AccordionGroup>

### Step 2: Deploy your changes

<AccordionGroup>
  <Accordion icon="github" title="Install our GitHub app">
    Install the Mintlify GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app).

    Our GitHub app automatically deploys your changes to your docs site, so you don't need to manage deployments yourself.
  </Accordion>

  <Accordion icon="palette" title="Update your site name and colors">
    For a first change, let's update the name and colors of your docs site.

    1. Open `docs.json` in your editor.
    2. Change the `"name"` field to your project name.
    3. Update the `"colors"` to match your brand.
    4. Save and see your changes instantly at `http://localhost:3000`.

    <Tip>Try changing the primary color to see an immediate difference!</Tip>
  </Accordion>
</AccordionGroup>

### Step 3: Go live

<Accordion icon="rocket" title="Publish your docs">
  1. Commit and push your changes.
  2. Your docs will update and be live in moments!
</Accordion>

## Next steps

Now that you have your docs running, explore these key features:

<CardGroup>
  <Card title="Write Content" icon="pen-to-square" href="/essentials/markdown">
    Learn MDX syntax and start writing your documentation.
  </Card>

  <Card title="Customize style" icon="palette" href="/essentials/settings">
    Make your docs match your brand perfectly.
  </Card>

  <Card title="Add code examples" icon="square-code" href="/essentials/code">
    Include syntax-highlighted code blocks.
  </Card>

  <Card title="API documentation" icon="code" href="/api-reference/introduction">
    Auto-generate API docs from OpenAPI specs.
  </Card>
</CardGroup>

<Note>
  **Need help?** See our [full documentation](https://mintlify.com/docs) or join our [community](https://mintlify.com/community).
</Note>