API Overview

Learn how to integrate with TopSnapp using our REST API

The TopSnapp API allows you to programmatically create, read, update, and delete snaps and cards. This is perfect for building integrations with AI agents like Claude Desktop, ChatGPT, or custom automation tools.

Base URL

All API requests should be made to:

https://www.topsnapp.com/api

Authentication

The TopSnapp API supports two authentication methods:

Session Cookies - For browser-based requests from the web application
API Keys - For programmatic access from external tools and integrations

For most integrations, you'll want to use API keys. See Authentication for detailed setup instructions.

API Format

The TopSnapp API uses oRPC, a type-safe RPC framework. All endpoints follow REST conventions:

GET - Retrieve resources
POST - Create new resources
PATCH - Update existing resources
DELETE - Remove resources

Response Format

All successful responses return JSON with a predictable structure:

{
  "snap": {
    "id": "abc123",
    "title": "My Snap",
    // ... other fields
  }
}

Error responses include a code, status, and message:

{
  "defined": false,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "Authentication required. Provide session or API key."
}

Rate Limits

API keys are currently not rate limited, but we recommend:

Batching operations when possible
Avoiding excessive polling (use webhooks when available)
Implementing exponential backoff for retries

Quick Start

Generate an API key in your account settings
Make your first request:

curl https://www.topsnapp.com/api/snaps \
  -H "Authorization: Bearer topsnapp_sk_your_key_here"

Explore the Endpoints Reference to see all available operations

Need Help?

Check the Endpoints Reference for detailed API documentation
See Authentication for API key setup
Review code examples in the endpoint documentation