Passer au contenu principal
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
requis
La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.
file
file
requis
Utilisez FormData. (multipart/form-data)
name
string
requis
Une chaîne représentant le nom du fichier. (sans extension)
Doit respecter le motif a à z, A à Z, 0 à 9 et _. (3 à 32 caractères)
prefix
string
Une chaîne représentant le préfixe du fichier.
Doit respecter le motif a à z, A à Z, 0 à 9 et _. (3 à 32 caractères)
expire
number
Un nombre indiquant la période d’expiration du fichier, comprise entre 1 et 365 jours.
security_hash
boolean
Définissez sur true si un hash de sécurité est requis.
auto_download
boolean
Définissez sur true si le fichier doit être configuré pour un téléchargement automatique.

Limites de débit et concurrence

L’upload nécessite un plan payant.
  • Les plans Hobby et Standard sont limités à 1 upload par seconde.
  • Les plans Pro et Enterprise ne sont pas soumis à la limite par seconde — ils peuvent en revanche exécuter jusqu’à 4 uploads simultanés.
Sur l’ensemble des plans payants, un compte peut avoir au plus 4 uploads en cours simultanément. Démarrer un autre upload alors que 4 sont encore en cours renvoie TOO_MANY_CONCURRENT_UPLOADS (429).
Pour des raisons de sécurité, les fichiers .html et .svg sont toujours délivrés en tant que téléchargements (servis en application/octet-stream) au lieu d’être rendus en ligne.

Réponse

status
string
Indique si l’appel a réussi. “success” en cas de succès, “error” sinon.
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"
    }
}

Dépannage

Lié à l’objet

// 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"
}

Lié au fichier

La taille maximale actuelle des fichiers est de 100 Mo. À l’avenir, nous prévoyons de l’augmenter à 10 Go. Pour l’instant, la limite est de 100 Mo en raison de contraintes techniques et de répartition de charge.
// 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"
}