API Documentation

Nonograph provides a simple HTTP API for programmatically publishing articles.

Publishing a Post#

Endpoint: POST /api/post/create
Content-Type: application/x-www-form-urlencoded

Parameters#

Field	Type	Required	Max Length	Description
`title`	string	Yes	128 chars	Article title
`content`	string	Yes	32,000 chars	Article content in markdown
`alias`	string	No	32 chars	Alias name (optional)

Example Request#

BASH
123456789101112131415161718192021
curl -X POST http://localhost:8000/api/post/create \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "title=My API Article" \
  -d "alias=API User" \
  -d "content=This article was created via the API!

## Features

- **Bold text** and *italic text*
- [Links](https://example.com) open in new tabs
- Code blocks with syntax highlighting

\`\`\`python
def hello_world():
    print('Hello from the API!')
\`\`\`

| Feature | Status |
|---------|--------|
| API | ✓ Working |
| Markdown | ✓ Supported |"

Successful Response#

Status: 302 Found
Location: /{post-id}

The API redirects to the published article URL. Extract the post ID from the Location header.

Error Responses#

Status: 302 Found (redirect to home with error parameter)

Error Parameter	Description
`?error=title_required`	Title is empty
`?error=content_required`	Content is empty
`?error=title_too_long`	Title exceeds 128 characters
`?error=content_too_long`	Content exceeds 32,000 characters
`?error=alias_too_long`	Alias exceeds 32 characters
`?error=no_available_slots`	No available post ID slots (rare)

Post URLs#

Published posts are accessible at: /{post-id}

Post IDs are generated from the title and date: title-slug-mm-dd-yyyy

Raw Markdown Access#

Access the original markdown by appending .md: /{post-id}.md

Supported Content#

All standard Nonograph markdown features are supported:

Text formatting: bold, italic, underline, strikethrough, superscript
Links: [text](url) and [bare-url]
Code blocks: Fenced blocks with 180+ language support
Tables: GitHub-style markdown tables
Media: Auto-embedded images and videos from URLs
Secret text: #hidden text# - click to reveal
Stickers: :pack.action: inline emotes - see Sticker API below

Rate Limiting#

No rate limiting is currently implemented. Please use responsibly.

Examples#

Python#

PYTHON
1234567891011121314151617181920212223
import requests

data = {
    'title': 'API Test Article',
    'alias': 'Python Script',
    'content': '''# Hello from Python!

This article was created programmatically.

## Code Example

\`\`\`python
import requests
print("API publishing works!")
\`\`\`

[Visit the docs](https://example.com)'''
}

response = requests.post('http://localhost:8000/api/post/create', data=data)
if response.status_code == 200:
    post_url = response.url
    print(f"Published: {post_url}")

JavaScript (Node.js)#

JAVASCRIPT
12345678910111213141516171819202122
const axios = require('axios');

const data = new URLSearchParams({
    title: 'API Test Article',
    alias: 'Node.js Script',
    content: `# Hello from JavaScript!

This article was created with Node.js.

## Features
- API integration
- Markdown support
- [External links](https://nodejs.org)`
});

axios.post('http://localhost:8000/api/post/create', data)
    .then(response => {
        console.log('Published:', response.request.res.responseUrl);
    })
    .catch(error => {
        console.error('Error:', error.response?.status);
    });

Shell Script#

BASH
123456789101112131415161718192021222324252627
#!/bin/bash

TITLE="Daily Report $(date +%Y-%m-%d)"
ALIAS="Automation"
CONTENT="# Daily System Report

Generated at: $(date)

## Status
- System: ✓ Online
- Services: ✓ Running

## Metrics
| Metric | Value |
|--------|-------|
| CPU | 15% |
| Memory | 2.1GB |

[Dashboard](https://monitoring.example.com)"

curl -X POST http://localhost:8000/api/post/create \
  --data-urlencode "title=$TITLE" \
  --data-urlencode "alias=$ALIAS" \
  --data-urlencode "content=$CONTENT" \
  --location \
  --silent \
  --write-out "Published: %{url_effective}\n"

Sticker API#

Nonograph includes a built-in sticker system for expressive inline content.

Using Stickers in Content#

Include stickers in your content using the format :pack.action:

MARKDOWN
123
Hello :marsey.hi: world! This is exciting :marsey.happy:

:marsey.nope:

Inline vs Standalone Behavior:

Inline stickers (mixed with text) appear at normal text height
Standalone stickers (alone on their line) appear 2x larger for emphasis

Sticker API Endpoints#

Get All Stickers#

Endpoint: GET /api/stickers
Response: Plain text format with sticker details

BASH
1
curl http://localhost:8000/api/stickers

Response Format:


1234567891011
name:marsey.hi
pack:marsey
action:hi
url:/stickers/marsey/hi.webp
base64:data:image/webp;base64,UklGRr...

name:marsey.happy  
pack:marsey
action:happy
url:/stickers/marsey/happy.webp
base64:data:image/webp;base64,GkXfo...

Search Stickers#

Endpoint: GET /api/stickers/search?q={query}
Parameters:

q - Search query (searches names and tags)

BASH
1
curl "http://localhost:8000/api/stickers/search?q=happy"

Get Specific Sticker#

Endpoint: GET /api/stickers/{name}
Parameters:

name - Full sticker name (e.g., marsey.hi)

BASH
1
curl http://localhost:8000/api/stickers/marsey.hi

Sticker Files#

Endpoint: GET /stickers/{pack}/{file}
Direct access to sticker image files.

BASH
1
curl http://localhost:8000/stickers/marsey/hi.webp

Example with Stickers#

PYTHON
12345678910111213141516
content = '''# My Sticker Post

Hello everyone :marsey.hi:! Today was great :marsey.happy:

## Standalone Sticker
:marsey.nope:

## Mixed Content
This is :fire: awesome! Check it out :100:'''

data = {
    'title': 'Sticker Demo',
    'content': content
}

response = requests.post('http://localhost:8000/api/post/create', data=data)

Notes#

Posts are stored as markdown files and cached in memory
No authentication required - posts are public once published
Content is sanitized for security but preserves intended formatting
Images and videos must be hosted externally - only URLs are stored
Post IDs are generated deterministically from title and date
Stickers are served as static files and cached for performance