Télécharger une ressource dans la bibliothèque multimédia

Utilisez cet endpoint pour ajouter une ressource à la bibliothèque multimédia de Braze à l’aide d’une URL hébergée en externe (asset_url) ou de données de fichier binaire envoyées dans le corps de la requête (asset_file). Cet endpoint prend en charge les images et les fichiers ZIP contenant des images.

Conseil

Vous pouvez également appeler cet endpoint via le serveur MCP de Braze en utilisant la fonction create_media_library_asset. Cela permet à des outils d’intelligence artificielle comme Claude et Cursor de télécharger des ressources dans votre bibliothèque multimédia via des instructions en langage naturel.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation media_library.create.

Limite de débit

La limite de débit par défaut de Braze de 250 000 requêtes par heure s’applique à cet endpoint, comme documenté dans Limites de débit de l’API.

Corps de la requête

Lorsque vous incluez asset_url, l’endpoint télécharge le fichier à partir de l’URL. Lorsque vous incluez asset_file, l’endpoint utilise les données binaires dans le corps de la requête.

Exemple de corps de requête pour asset_url :

1
2
3
4
{
  "asset_url": "https://cdn.example.com/assets/cat.jpg",
  "name": "Cat Graphic"
}

Exemple de corps de requête pour asset_file :

1
2
3
4
{
  "asset_file": <BINARY FILE DATA>,
  "name": "Cat Graphic"
}

Le corps de la requête comprend les paramètres suivants :

Important

asset_url et asset_file sont mutuellement exclusifs : vous devez n’inclure qu’un seul d’entre eux dans votre requête API.

Noms des fichiers téléchargés

Cette section explique comment l’endpoint attribue des noms aux fichiers téléchargés selon que vous incluez ou non le paramètre name.

Téléchargements de fichiers individuels

Téléchargements de fichiers ZIP

Exemple de requête

Cette section comprend deux exemples de requêtes curl, l’une pour ajouter une ressource à l’aide d’une URL et l’autre à l’aide de données de fichier binaire.

Cette requête illustre l’ajout d’une ressource à la bibliothèque multimédia à l’aide d’un asset_url.

1
2
3
4
curl -X POST --location 'https://rest.iad-01.braze.com/media_library/create' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--header 'Content-Type: application/json' \
--data '{"asset_url": "https://cdn.example.com/assets/cat.jpg", "name": "Cat Graphic"}'

Cette requête illustre l’ajout d’une ressource à la bibliothèque multimédia à l’aide d’un asset_file.

1
2
3
4
curl -X POST --location 'https://rest.iad-01.braze.com/media_library/create' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--header 'Content-Type: application/json' \
--data '{"asset_file":<BINARY FILE DATA>, "name":"Cat Graphic"}'

Réponses d’erreur

Cette section répertorie les erreurs potentielles ainsi que les messages et descriptions correspondants.

Erreurs de validation

Les erreurs de validation renvoient une structure telle que celle-ci :

1
2
3
{
  "message": (String) Human-readable error description
}

Ce tableau répertorie les erreurs de validation possibles.

Erreurs de traitement

Les erreurs de traitement renvoient une réponse différente avec des codes d’erreur :

1
2
3
4
5
{
  "message": (String) Human-readable error description,
  "error_code": (String) error code,
  "meta": { }
}

Ce tableau répertorie les erreurs de traitement possibles.

Réponse

Il existe cinq codes de statut de réponse pour cet endpoint : 200, 400, 403, 429 et 500.

Le JSON suivant présente la forme attendue de la réponse.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "new_assets": [
        {
            "name": (String) the name of the asset,
            "size": (Integer) the byte size of the asset,
            "url": (String) the URL to access the asset,
            "ext": (String) the file extension (e.g., "png", "jpg", "gif")
        }
    ],
    "errors": [
        {
            "name": (String) the name of the asset,
            "size": (Integer) the byte size of the asset,
            "ext": (String) the file extension (e.g., "png", "jpg", "gif"),
            "error": (String) the error that occurred
        }
    ],
    "dashboard_url": (String) the URL to view this asset in the Braze dashboard
}