Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.snipp.gg/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Started in Three Steps

Make your first API call and upload a file to Snipp.

​
Step 1: Get Your API Key

  1. Sign in to your account.
  2. Open Settings and navigate to the API section.
  3. Copy your API key. Include it in the api-key header with every request.
Never share your API key or commit it to version control. Store it in an environment variable in production.

​
Step 2: Verify Your Setup

Test your API key by fetching your own profile: 
curl -X GET "https://api.snipp.gg/users/@me" \
  -H "api-key: YOUR_API_KEY"
A successful response returns your user object: 
{
  "user": {
    "id": "123456789012345678",
    "username": "yourname",
    "plus": false,
    "verified": false,
    "badges": { ... },
    "uploads": 0
  }
}

​
Step 3: Upload a File

Upload an image or video to your account: 
curl -X POST "https://api.snipp.gg/upload" \
  -H "api-key: YOUR_API_KEY" \
  -H "post-privacy: unlisted" \
  -F "file=@/path/to/image.png"
The response includes a direct URL to your file and a post object with share metadata: 
{
  "message": "Upload successful!",
  "url": "https://i.snipp.gg/123456789012345678/abc123.png",
  "post": {
    "code": "AbCd1234",
    "url": "https://snipp.gg/p/AbCd1234",
    "postPrivacy": "unlisted"
  }
}

​
Albums

Upload multiple files in one request to create an album. Add additional -F "file=@..." fields: 
curl -X POST "https://api.snipp.gg/upload" \
  -H "api-key: YOUR_API_KEY" \
  -H "post-title: My album" \
  -F "file=@photo1.png" \
  -F "file=@photo2.png"
Albums are the default when sending two or more files. To create separate posts instead, add -H "post-type: individual".

​
Privacy Options

Control who can see your uploads by setting the post-privacy header:
ValueVisibility
privateOnly you can view it. Response URLs are signed and expire after 24 hours. Re-fetch from GET /posts/{code} or GET /uploads for a fresh link.
unlistedAnyone with the share link can view it (default).
publicVisible to everyone and eligible for the Discover feed.

​
Next Steps

Authentication

Learn how the API key header works and security best practices.

API Reference

Explore all available endpoints and response schemas.

File Types

See supported formats and size limits per plan.

Rate Limits

Understand request limits and how to handle throttling.