Quickstart

Get Started in Three Steps

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

Step 1: Get Your API Key

Sign in to your account.
Open Settings, go to Apps and create an app.
Copy the app’s 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"

const res = await fetch("https://api.snipp.gg/users/@me", {
  headers: { "api-key": "YOUR_API_KEY" },
});
const data = await res.json();
console.log(data.user.username);

import requests

res = requests.get(
    "https://api.snipp.gg/users/@me",
    headers={"api-key": "YOUR_API_KEY"},
)
print(res.json()["user"]["username"])

A successful response returns your account. It is trimmed here; see Get User for every field.

{
  "user": {
    "id": "123456789012345678",
    "username": "yourname",
    "plan": "free",
    "verified": false,
    "upload_count": 0,
    "limits": { ... }
  }
}

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"

const formData = new FormData();
formData.append("file", fileInput.files[0]);

const res = await fetch("https://api.snipp.gg/upload", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "post-privacy": "unlisted",
  },
  body: formData,
});
const data = await res.json();
console.log(data.url);

import requests

with open("image.png", "rb") as f:
    res = requests.post(
        "https://api.snipp.gg/upload",
        headers={
            "api-key": "YOUR_API_KEY",
            "post-privacy": "unlisted",
        },
        files={"file": f},
    )
print(res.json()["url"])

These examples use api.snipp.gg, which is the right host for production uploads too. It connects straight to the nearest upload server with no per-request size cap. Pin a regional endpoint such as eu-west-1.api.snipp.gg only when you want to control which region stores your files. See Regional endpoints.

The response includes the direct URL of your file and the post it created. url is the file itself; post.url is the share page. The post is trimmed here; see Upload Files for the full shape.

{
  "url": "https://i.snipp.gg/123456789012345678/a1b2c3d4e5f6789012345678abcdef01.png",
  "post": {
    "code": "AbCd1234",
    "url": "https://snipp.gg/p/AbCd1234",
    "privacy": "unlisted",
    "file_count": 1,
    "files": [ ... ]
  }
}

If something goes wrong, the response has an error object with a type and a message. See Errors.

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" \
  -F "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:

Value	Visibility
`private`	Only you, and anyone you have given access to, can view it (default). Response URLs are signed and expire after 24 hours. Re-fetch from `GET /posts/{code}` or `GET /posts` for a fresh link.
`unlisted`	Anyone with the share link can view it.
`public`	Visible 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.

Getting Started

Concepts

Get Started in Three Steps

Step 1: Get Your API Key

Step 2: Verify Your Setup

Step 3: Upload a File

Albums

Privacy Options

Next Steps

Authentication

API Reference

File Types

Rate Limits

​Get Started in Three Steps

​Step 1: Get Your API Key

​Step 2: Verify Your Setup

​Step 3: Upload a File

​Albums

​Privacy Options

​Next Steps

Authentication

API Reference

File Types

Rate Limits

Get Started in Three Steps

Step 1: Get Your API Key

Step 2: Verify Your Setup

Step 3: Upload a File

Albums

Privacy Options

Next Steps