API Reference

The Snipara REST API allows you to manage your projects, documents, and billing programmatically. All endpoints require authentication.

Authentication

Snipara supports two authentication methods:

API Keys (Recommended)

Generate an API key from your project settings. Include it in the X-API-Key header:

curl -H "X-API-Key: rlm_xxx" https://api.snipara.com/...

Session Authentication

When making requests from the browser while logged in, session cookies are automatically included. This is used by the dashboard.

Base URL

https://www.snipara.com/api

API Endpoints

Projects API

List Projects

GET /api/projects

Returns a list of all projects you have access to.

Response

{

  "projects": [

    {

      "id": "proj_abc123",

      "name": "My Documentation",

      "documentCount": 42,

      "createdAt": "2024-01-15T10:30:00Z"

    }

  ]

}

Create Project

POST /api/projects

Request Body

{

  "name": "My New Project",

  "description": "Optional description"

}

Documents API

Upload Document

POST /api/projects/:projectId/documents

Request Body

{

  "path": "docs/getting-started.md",

  "content": "# Getting Started\n\nWelcome to..."

}

The path field is used as both the document identifier and display name. Uploading to an existing path will update that document.

List Documents

GET /api/projects/:projectId/documents

Delete Document

DELETE /api/projects/:projectId/documents/:documentId

Billing API

Get Usage

GET /api/billing/usage

Response

{

  "plan": "pro",

  "queriesUsed": 1250,

  "queriesLimit": 5000,

  "periodStart": "2024-01-01T00:00:00Z",

  "periodEnd": "2024-01-31T23:59:59Z"

}

Manage Subscription

POST /api/billing/portal

Returns a URL to the Stripe Customer Portal where users can manage their subscription, update payment methods, and view invoices.

Error Responses

All API errors follow a consistent format:

{

  "error": {

    "code": "UNAUTHORIZED",

    "message": "Invalid API key",

    "status": 401

  }

}

Common Error Codes

Rate Limits

API rate limits vary by plan:

Next Steps