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.

Fetch a post by its share code.

​
Behavior

  • Albums (posts with more than one file) include urls and isAlbum: true.
  • The author object describes the post’s uploader. author is null if the user has been deleted.
  • Use fileName from the files array when calling /deleteUpload to address a specific file. On albums, /deleteUpload removes just that file; on single-file posts it deletes the post.
  • Hits to this endpoint count a view toward the post. Views are deduplicated per IP and post: up to 3 counted views per IP per post per hour. Views are only counted on public, non-moderated posts.
  • Private posts are only visible to the owner. Requests for another user’s private post return 404.
  • URLs for private posts are returned as signed URLs with a 24-hour expiry. After that, request the endpoint again for a fresh signed URL.
  • Moderated posts may still be returned, but their file URL may be unavailable.

​
Examples

Fetch a post by code: 
curl -X GET "https://relay.snipp.gg/posts/AbCd1234" \
  -H "relay-key: YOUR_RELAY_KEY"

​
Responses

Single-file post: 
{
  "post": {
    "code": "AbCd1234",
    "url": "https://i.snipp.gg/123456789012345678/a1b2c3d4e5f6789012345678abcdef01.png",
    "files": [
      {
        "index": 0,
        "fileName": "a1b2c3d4e5f6789012345678abcdef01.png",
        "url": "https://i.snipp.gg/123456789012345678/a1b2c3d4e5f6789012345678abcdef01.png"
      }
    ],
    "title": "Nice shot",
    "description": null,
    "postPrivacy": "public",
    "created": "2026-05-03T12:00:00Z",
    "views": 128,
    "likeCount": 42,
    "liked": false,
    "commentCount": 3,
    "author": {
      "id": "123456789012345678",
      "username": "playerone",
      "nickname": "Player One",
      "avatar": "https://cdn.snipp.gg/avatars/123456789012345678/avatar.png",
      "verified": false,
      "plus": true
    },
    "file": {
      "size": 2487312,
      "size_formatted": "2.37 MB",
      "mime_type": "image/png",
      "dimensions": { "width": 1920, "height": 1080 }
    }
  }
}
Album post (includes urls and isAlbum): 
{
  "post": {
    "code": "AbCd1234",
    "url": "https://i.snipp.gg/123456789012345678/a1b2c3d4e5f6789012345678abcdef01.png",
    "urls": [
      "https://i.snipp.gg/123456789012345678/a1b2c3d4e5f6789012345678abcdef01.png",
      "https://i.snipp.gg/123456789012345678/b2c3d4e5f6789012345678abcdef0102.png"
    ],
    "isAlbum": true,
    "files": [
      {
        "index": 0,
        "fileName": "a1b2c3d4e5f6789012345678abcdef01.png",
        "url": "https://i.snipp.gg/123456789012345678/a1b2c3d4e5f6789012345678abcdef01.png"
      },
      {
        "index": 1,
        "fileName": "b2c3d4e5f6789012345678abcdef0102.png",
        "url": "https://i.snipp.gg/123456789012345678/b2c3d4e5f6789012345678abcdef0102.png"
      }
    ],
    "title": "Match highlights",
    "description": null,
    "postPrivacy": "public",
    "created": "2026-05-03T12:00:00Z",
    "views": 128,
    "likeCount": 42,
    "liked": false,
    "commentCount": 3,
    "author": {
      "id": "123456789012345678",
      "username": "playerone",
      "nickname": "Player One",
      "avatar": "https://cdn.snipp.gg/avatars/123456789012345678/avatar.png",
      "verified": false,
      "plus": true
    },
    "file": {
      "size": 2487312,
      "size_formatted": "2.37 MB",
      "mime_type": "image/png",
      "dimensions": { "width": 1920, "height": 1080 }
    }
  }
}