Upload Banner

curl --request POST \
  --url https://relay.snipp.gg/users/{id}/banner \
  --header 'Content-Type: multipart/form-data' \
  --header 'relay-key: <api-key>' \
  --form file=@example-file

import requests

url = "https://relay.snipp.gg/users/{id}/banner"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"relay-key": "<api-key>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {'relay-key': '<api-key>'}};

options.body = form;

fetch('https://relay.snipp.gg/users/{id}/banner', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://relay.snipp.gg/users/{id}/banner",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "relay-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://relay.snipp.gg/users/{id}/banner"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("relay-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://relay.snipp.gg/users/{id}/banner")
  .header("relay-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://relay.snipp.gg/users/{id}/banner")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["relay-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "user": {
    "id": "123456789012345678",
    "username": "playerone",
    "nickname": "Player One",
    "avatar": "https://i.snipp.gg/avatars/123456789012345678/7e1f0a2b3c4d5e6f708192a3b4c5d6e7.png",
    "banner": "https://i.snipp.gg/banners/123456789012345678/2b3c4d5e6f708192a3b4c5d6e7f80910.png",
    "bio": "Building things at Snipp",
    "socials": {
      "github": "https://github.com/playerone"
    },
    "plan": "plus",
    "verified": false,
    "staff": false,
    "partner": false,
    "translator": false,
    "bug_hunter_tier": 0,
    "suspended": false,
    "created_at": "2026-01-04T09:30:00.000Z",
    "custom_embed": null,
    "follower_count": 128,
    "following_count": 47,
    "following": false,
    "blocking": false,
    "api_key": "aB3xK9mP2qR7sT1vW4yZ6cD8fG0hJ5kL",
    "key_has_uploads_access": true,
    "relay_key": "Zy7wV4uT1sR8qP5nM2kJ9hG6fD3bC0aX",
    "upload_count": 42,
    "limits": {
      "max_file_size": 21474836480,
      "usage": {
        "used": 1073741824,
        "limit": 21474836480,
        "used_percent": 5,
        "resets_at": "2026-10-04T16:20:00.000Z"
      },
      "priority_minutes": {
        "used": 12,
        "limit": 100,
        "used_percent": 12,
        "resets_at": "2026-10-19T16:20:00.000Z"
      }
    },
    "theme": "pastel_blue",
    "subscription": {
      "status": "active",
      "started_at": "2026-01-04T09:30:00.000Z",
      "expires_at": "2026-11-04T09:30:00.000Z",
      "cancel_at_period_end": false,
      "gifted": false
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

POST

users

{id}

banner

Upload Banner

curl --request POST \
  --url https://relay.snipp.gg/users/{id}/banner \
  --header 'Content-Type: multipart/form-data' \
  --header 'relay-key: <api-key>' \
  --form file=@example-file

import requests

url = "https://relay.snipp.gg/users/{id}/banner"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"relay-key": "<api-key>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {'relay-key': '<api-key>'}};

options.body = form;

fetch('https://relay.snipp.gg/users/{id}/banner', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://relay.snipp.gg/users/{id}/banner",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "relay-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://relay.snipp.gg/users/{id}/banner"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("relay-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://relay.snipp.gg/users/{id}/banner")
  .header("relay-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://relay.snipp.gg/users/{id}/banner")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["relay-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "user": {
    "id": "123456789012345678",
    "username": "playerone",
    "nickname": "Player One",
    "avatar": "https://i.snipp.gg/avatars/123456789012345678/7e1f0a2b3c4d5e6f708192a3b4c5d6e7.png",
    "banner": "https://i.snipp.gg/banners/123456789012345678/2b3c4d5e6f708192a3b4c5d6e7f80910.png",
    "bio": "Building things at Snipp",
    "socials": {
      "github": "https://github.com/playerone"
    },
    "plan": "plus",
    "verified": false,
    "staff": false,
    "partner": false,
    "translator": false,
    "bug_hunter_tier": 0,
    "suspended": false,
    "created_at": "2026-01-04T09:30:00.000Z",
    "custom_embed": null,
    "follower_count": 128,
    "following_count": 47,
    "following": false,
    "blocking": false,
    "api_key": "aB3xK9mP2qR7sT1vW4yZ6cD8fG0hJ5kL",
    "key_has_uploads_access": true,
    "relay_key": "Zy7wV4uT1sR8qP5nM2kJ9hG6fD3bC0aX",
    "upload_count": 42,
    "limits": {
      "max_file_size": 21474836480,
      "usage": {
        "used": 1073741824,
        "limit": 21474836480,
        "used_percent": 5,
        "resets_at": "2026-10-04T16:20:00.000Z"
      },
      "priority_minutes": {
        "used": 12,
        "limit": 100,
        "used_percent": 12,
        "resets_at": "2026-10-19T16:20:00.000Z"
      }
    },
    "theme": "pastel_blue",
    "subscription": {
      "status": "active",
      "started_at": "2026-01-04T09:30:00.000Z",
      "expires_at": "2026-11-04T09:30:00.000Z",
      "cancel_at_period_end": false,
      "gifted": false
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "username": "<string>",
    "quota": 123,
    "used": 123,
    "resets_at": "2023-11-07T05:31:56Z",
    "failed": [
      {
        "index": 123,
        "error": "<unknown>"
      }
    ]
  }
}

Upload a new banner. id must be @me or your own ID.

Behavior

Send one image as multipart/form-data in the file field. More than one file returns 400.
PNG, JPG, WebP or GIF, up to 30 MB. The type is detected from the file’s bytes.
The image keeps its aspect ratio; it is not cropped. GIFs stay animated.
Metadata is stripped.
The new banner replaces the old one, which is deleted.
A suspended account cannot upload a banner.
The response is your full account, with the new banner URL.
Shares a rate limit bucket with Remove Banner: 10 requests per minute.

Examples

curl -X POST "https://relay.snipp.gg/users/@me/banner" \
  -H "relay-key: YOUR_RELAY_KEY" \
  -F "file=@banner.png"

Responses

{
  "user": {
    "id": "123456789012345678",
    "username": "playerone",
    "nickname": "Player One",
    "avatar": "https://i.snipp.gg/avatars/123456789012345678/7e1f0a2b3c4d5e6f708192a3b4c5d6e7.png",
    "banner": "https://i.snipp.gg/banners/123456789012345678/2b3c4d5e6f708192a3b4c5d6e7f80910.png",
    "bio": "Building things at Snipp",
    "socials": {
      "github": "https://github.com/playerone"
    },
    "plan": "plus",
    "verified": false,
    "staff": false,
    "partner": false,
    "translator": false,
    "bug_hunter_tier": 0,
    "suspended": false,
    "created_at": "2026-01-04T09:30:00.000Z",
    "custom_embed": null,
    "follower_count": 128,
    "following_count": 47,
    "following": false,
    "blocking": false,
    "api_key": "aB3xK9mP2qR7sT1vW4yZ6cD8fG0hJ5kL",
    "key_has_uploads_access": true,
    "relay_key": "Zy7wV4uT1sR8qP5nM2kJ9hG6fD3bC0aX",
    "upload_count": 42,
    "limits": {
      "max_file_size": 21474836480,
      "usage": {
        "used": 1073741824,
        "limit": 21474836480,
        "used_percent": 5,
        "resets_at": "2026-10-04T16:20:00.000Z"
      },
      "priority_minutes": {
        "used": 12,
        "limit": 100,
        "used_percent": 12,
        "resets_at": "2026-10-19T16:20:00.000Z"
      }
    },
    "theme": "pastel_blue",
    "subscription": {
      "status": "active",
      "started_at": "2026-01-04T09:30:00.000Z",
      "expires_at": "2026-11-04T09:30:00.000Z",
      "cancel_at_period_end": false,
      "gifted": false
    }
  }
}

Errors

Status	Type	When
`400`	`invalid_request`	No file, or more than one
`400`	`unsupported_type`	Not a PNG, JPG, WebP or GIF
`401`	`unauthorized`	Missing or invalid key
`403`	`forbidden`	`id` is not you
`403`	`suspended`	Your account is suspended
`413`	`file_too_large`	Over 30 MB
`429`	`rate_limited`	More than 10 requests per minute

Authorizations

relay-key

string

header

required

Your relay key from snipp.gg/settings/relay

Path Parameters

string

required

User ID, or @me for your own account.

Body

multipart/form-data

file

required

The image.

Response

Success

user

object

required

Returned for @me or your own ID.

Show child attributes

Overview

Uploads

Posts

Likes and Comments

Users

Social

Notifications

Account

Meta

Upload Banner

Behavior

Examples

Responses

Errors

Authorizations

Path Parameters

Body

Response

​Behavior

​Examples

​Responses

​Errors

Authorizations

Path Parameters

Body

Response

Behavior

Examples

Responses

Errors