Skip to content
Notebind Docs

Quick Start

Get up and running with Notebind in 5 minutes.

Prerequisites

Section titled “Prerequisites”

Using the API

Section titled “Using the API”

  1. Create an API key

    Go to Settings and create a new API key. Copy the key — it’s only shown once.

    nb_sk_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

  2. Create a document

    Terminal window
    curl -X POST https://notebind.com/api/documents \
      -H "Authorization: Bearer nb_sk_YOUR_KEY" \
      -H "Content-Type: application/json" \
      -d '{"title": "My First Document", "content": "# Hello World\n\nThis is my first document on Notebind."}'

    Response:

    {
      "data": {
        "id": "6240800a-1234-5678-abcd-ef0123456789",
        "owner_id": "your-user-id",
        "title": "My First Document",
        "content": "# Hello World\n\nThis is my first document on Notebind.",
        "created_at": "2026-03-13T12:00:00.000Z",
        "updated_at": "2026-03-13T12:00:00.000Z"
      },
      "error": null
    }

  3. Create a share link

    Share the document with reviewers:

    Terminal window
    curl -X POST https://notebind.com/api/documents/DOC_ID/share \
      -H "Authorization: Bearer nb_sk_YOUR_KEY" \
      -H "Content-Type: application/json" \
      -d '{"permission": "comment"}'

    Response:

    {
      "data": {
        "id": "link-uuid",
        "token": "a21e739e4fcf3cc2844e4b23a3b14b14",
        "permission": "comment",
        "expires_at": null,
        "created_at": "2026-03-13T12:01:00.000Z"
      },
      "error": null
    }

    Send reviewers the link: https://notebind.com/share/a21e739e4fcf3cc2844e4b23a3b14b14

  4. Pull feedback

    After reviewers leave comments:

    Terminal window
    curl https://notebind.com/api/documents/DOC_ID/comments \
      -H "Authorization: Bearer nb_sk_YOUR_KEY"
    {
      "data": [
        {
          "id": "comment-uuid",
          "body": "This intro could be more specific about the target audience.",
          "anchor_text": "Hello World",
          "anchor_start": 2,
          "anchor_end": 13,
          "resolved": false,
          "author": { "display_name": "Jane", "avatar_url": null }
        }
      ],
      "error": null
    }

Using the CLI

Section titled “Using the CLI”

  1. Install the CLI

    Terminal window
    cargo install notebind

  2. Authenticate

    Terminal window
    notebind auth --token nb_sk_YOUR_KEY

  3. Initialize a project

    Terminal window
    cd your-project
    notebind init

  4. Push a document

    Terminal window
    notebind push article.md

  5. Pull feedback

    Terminal window
    notebind pull

Next steps

Section titled “Next steps”