Zum Hauptinhalt springen
curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects?name=myfile&prefix=images&expire=30' \
  --header 'Authorization: YOUR_API_KEY' \
  --form 'file=@./myphone.png'
import fs from 'node:fs';

const form = new FormData();
form.append('file', new Blob([fs.readFileSync('./myphone.png')]), 'myphone.png');

const params = new URLSearchParams({
  name: 'myfile',
  prefix: 'images',
  expire: '30',
});

const response = await fetch(`https://blob.squarecloud.app/v1/objects?${params}`, {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
  body: form,
});
import requests

with open('myphone.png', 'rb') as f:
    response = requests.post(
        'https://blob.squarecloud.app/v1/objects',
        headers={'Authorization': 'YOUR_API_KEY'},
        params={'name': 'myfile', 'prefix': 'images', 'expire': 30},
        files={'file': ('myphone.png', f, 'image/png')},
    )
{
    "status": "success",
    "response": {
        "id": "3155597145698959364/images/test_lxch4k7y-07ee.png",
        "name": "test",
        "prefix": "images",
        "size": 416230,
        "url": "https://public-blob.squarecloud.dev/3155597145698959364/images/test_lxch4k7y-07ee.png"
    }
}
Authorization
string
erforderlich
Der API-Schlüssel für Ihr Konto. Sie finden ihn in Ihren Kontoeinstellungen.
file
file
erforderlich
Verwende FormData. (multipart/form-data)
name
string
erforderlich
Eine Zeichenkette, die den Namen der Datei darstellt. (ohne Erweiterung)
Muss dem Muster a bis z, A bis Z, 0 bis 9 und _ entsprechen. (3 bis 32 Zeichen)
prefix
string
Eine Zeichenkette, die das Präfix der Datei darstellt.
Muss dem Muster a bis z, A bis Z, 0 bis 9 und _ entsprechen. (3 bis 32 Zeichen)
expire
number
Eine Zahl, die die Ablaufdauer der Datei angibt, im Bereich von 1 bis 365 Tagen.
security_hash
boolean
Auf true setzen, wenn ein Sicherheits-Hash erforderlich ist.
auto_download
boolean
Auf true setzen, wenn die Datei für automatischen Download vorgesehen werden soll.

Rate Limits & Nebenläufigkeit

Das Hochladen erfordert einen kostenpflichtigen Plan.
  • Hobby- und Standard-Pläne sind auf 1 Upload pro Sekunde beschränkt.
  • Pro- und Enterprise-Pläne unterliegen nicht dem Limit pro Sekunde — sie können stattdessen bis zu 4 Uploads gleichzeitig ausführen.
Über alle kostenpflichtigen Pläne hinweg darf ein Konto höchstens 4 Uploads gleichzeitig in Bearbeitung haben. Das Starten eines weiteren Uploads, während noch 4 laufen, liefert TOO_MANY_CONCURRENT_UPLOADS (429) zurück.
Aus Sicherheitsgründen werden .html- und .svg-Dateien immer als Download ausgeliefert (als application/octet-stream bereitgestellt), anstatt inline gerendert zu werden.

Response

status
string
Gibt an, ob der Aufruf erfolgreich war. “success” bei Erfolg, “error” andernfalls.
response
object
curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects?name=myfile&prefix=images&expire=30' \
  --header 'Authorization: YOUR_API_KEY' \
  --form 'file=@./myphone.png'
import fs from 'node:fs';

const form = new FormData();
form.append('file', new Blob([fs.readFileSync('./myphone.png')]), 'myphone.png');

const params = new URLSearchParams({
  name: 'myfile',
  prefix: 'images',
  expire: '30',
});

const response = await fetch(`https://blob.squarecloud.app/v1/objects?${params}`, {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
  body: form,
});
import requests

with open('myphone.png', 'rb') as f:
    response = requests.post(
        'https://blob.squarecloud.app/v1/objects',
        headers={'Authorization': 'YOUR_API_KEY'},
        params={'name': 'myfile', 'prefix': 'images', 'expire': 30},
        files={'file': ('myphone.png', f, 'image/png')},
    )
{
    "status": "success",
    "response": {
        "id": "3155597145698959364/images/test_lxch4k7y-07ee.png",
        "name": "test",
        "prefix": "images",
        "size": 416230,
        "url": "https://public-blob.squarecloud.dev/3155597145698959364/images/test_lxch4k7y-07ee.png"
    }
}

Fehlerbehebung

Objektbezogen

// The provided object name is invalid.
// Must adhere to the a to z, A to Z, 0 to 9, and _ pattern.
{
    "status": "error",
    "code": "INVALID_OBJECT_NAME"
}
// The provided object prefix is invalid.
// Must adhere to the a to z, A to Z, 0 to 9, and _ pattern.
{
    "status": "error",
    "code": "INVALID_OBJECT_PREFIX"
}
// The provided expiration value for the object is invalid.
// Must be a number ranging from 1 to 365. (value in days).
{
    "status": "error",
    "code": "INVALID_OBJECT_EXPIRE"
}
// The provided security hash boolean is invalid.
// Just set to true or false. 😅
{
    "status": "error",
    "code": "INVALID_OBJECT_SECURITY_HASH"
}
// The provided auto-download boolean is invalid.
// Just set to true or false. 😅
{
    "status": "error",
    "code": "INVALID_STORAGE_AUTO_DOWNLOAD"
}

Dateibezogen

Die aktuelle maximale Dateigröße beträgt 100MB. Zukünftig planen wir, sie auf 10GB zu erhöhen. Vorerst liegt das Limit aufgrund technischer und lastverteilungsbedingter Beschränkungen bei 100MB.
// The provided file is invalid.
{
    "status": "error",
    "code": "INVALID_FILE"
}
// The provided file type is invalid.
{
    "status": "error",
    "code": "INVALID_FILETYPE"
}
// The file size is too small (< 1kb).
{
    "status": "error",
    "code": "FILE_TOO_SMALL"
}