Quickstart

3 min read

Get from a blank account to a published paper and a working Dev API call in about 15 minutes.

Prerequisites

  • A Whitepapper account. Sign up at whitepapper.antk.in if you haven't.

  • Basic familiarity with Markdown.

  • A way to make HTTP requests: a browser, curl, Postman, or your own code works fine.

Create a project

  1. Go to your Dashboard.

  2. Click New Project.

  3. Give it a name. The slug is auto-filled from the name and you can edit it if you want.

  4. Set visibility to Public if you want the project and its content to be accessible to anyone with the link. Leave it Private if you're still setting things up.

  5. Click Create.

Your account can hold up to 50 projects.

Create a paper

  1. Open the project you just created.

  2. Click New Paper.

  3. Give the paper a title.

  4. Write some content in Markdown in the editor.

  5. The paper starts as a draft and won't be publicly visible yet.

Your account can hold up to 500 papers total across all projects, collections, and standalone papers.

Publish the paper

  1. With the paper open in the editor, click Publish in the top bar.

  2. The paper status changes from draft to published.

  3. A public URL is now live for this paper.

If your project is set to Private, publishing a paper won't make it publicly accessible. The project needs to be Public for the public URL to work.

The public URL for a paper follows this pattern:

https://whitepapper.antk.in/{username}/{project-slug}/{paper-slug}

You can copy it directly from the paper editor or from the project overview.

Generate an API key

  1. Open your project.

  2. Go to the API tab.

  3. Click Generate API Key.

  4. Copy the key immediately. It won't be shown again after you leave the page.

Each project gets one API key. The key is scoped to that project and can only access content inside that project.

Make your first API call

The Dev API base URL is:

https://whitepapper.antk.in/api

Pass your API key in the x-api-key header on every request.

Fetch your project:

GET /dev/project
x-api-key: <your-api-key>

curl https://whitepapper.antk.in/api/dev/project \
  -H "x-api-key: YOUR_API_KEY"

Expected response:

{
  "project": {
    "projectId": "...",
    "name": "My Project",
    "slug": "my-project",
    "description": "...",
    "isPublic": true
  },
  "collections": []
}

Fetch the paper you just published:

GET /dev/paper?slug=<paper-slug>
x-api-key: <your-api-key>

curl "https://whitepapper.antk.in/api/dev/paper?slug=my-first-paper" \
  -H "x-api-key: YOUR_API_KEY"

Common errors

#| ||

What you see

|

What it means

|

Fix

|| |#

||

401

|

API key is missing or wrong

|

Double-check you're sending x-api-key in the header with the correct key

|| ||

403

|

Key is inactive, or you're trying to access content outside this project

|

Re-enable the key from the API tab, or check you're using the right project's key

|| ||

404

|

Paper or collection not found

|

Check the slug is correct and the paper exists in this project

|| ||

429

|

Monthly usage limit hit (10,000 requests/month)

|

Wait for the monthly reset or review your usage

||

Whitepapper

Whitepapper is an API first CMS engine for devs who publish content.

Antk i n