Quickstart
Get from a blank account to a published paper and a working Dev API call in about 15 minutes.
Prerequisites
- A Whitepapper account at whitepapper.antk.in
- Basic familiarity with Markdown
- A way to make HTTP requests (
curl, Postman, browser, or your own code)
Create a project
- Open Dashboard.
- Click New Project.
- Enter a project name.
- Set visibility to Public if you want public access.
- Click Create.
Project URL pattern:
https://whitepapper.antk.in/{username}/p/{project-slug}
Create a paper
- Open your project.
- Click New Paper.
- Add a title and body.
- Save your draft.
Publish the paper
- Open the paper in the editor.
- Set status to Public and save.
- The paper becomes publicly accessible if parent visibility allows it.
Paper URL pattern:
https://whitepapper.antk.in/{username}/{paper-slug}
Generate an API key
- Open the project.
- Go to the API tab.
- Click Generate API Key.
- Copy the key immediately.
Each project has one key. The key is scoped to that project.
Make your first API call
Base URL:
https://whitepapper.antk.in/api
Request:
GET /dev/project
x-api-key: <your-api-key>
curl https://whitepapper.antk.in/api/dev/project \
-H "x-api-key: YOUR_API_KEY"
Common errors
| What you see | What it means | Fix |
|---|---|---|
401 | API key missing or invalid | Send the correct x-api-key header |
403 | Key inactive or wrong project scope | Re-enable key or use the right project's key |
404 | Collection/paper not found | Verify the id or slug |
429 | Monthly quota exceeded | Wait for monthly reset |