API Reference

Build with theViewert API

Integrate Viewert into your applications. Access vellums, user profiles, and more through our RESTful API.

API Coming Soon

Join the waitlist to get early access

RESTful Design

Clean, predictable endpoints following REST conventions

Secure Authentication

OAuth 2.0 and API key authentication options

JSON Responses

Consistent JSON format with detailed error messages

Rate Limiting

Fair usage limits with clear headers and documentation

Quick Start

Base URL

https://api.viewert.com

Authentication

Authorization: Bearer YOUR_API_KEY

Example Request

$ curl -X GET "https://api.viewert.com/vellums" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Example Response

{
  "data": [
    {
      "id": "01ABC123...",
      "title": "My First Vellum",
      "content": "...",
      "author": {
        "username": "johndoe",
        "display_name": "John Doe"
      },
      "created_at": "2026-01-15T10:30:00Z",
      "is_public": true
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "per_page": 20
  }
}

Endpoints

Coming Soon

GET/api/vellums

List all public vellums

GET/api/vellum/:id

Get a specific vellum by ID

POST/api/vellum-new

Create a new vellum

POST/api/vellum/:id

Update an existing vellum

DELETE/api/vellum/:id

Delete a vellum

GET/api/cirrus/:username

Get user profile

GET/api/cirrus/:username/vellums

List vellums by user

GET/api/search

Search vellums

SDKs & Libraries

🟨

JavaScript / TypeScript

Coming Soon

🐍

Python

Coming Soon

🔵

Go

Coming Soon

Get notified when the API launches

Be the first to build with the Viewert API. Join the waitlist and we'll let you know when it's ready.