Authentification
Créez une clé Direct API dans Studio, choisissez ses autorisations et ses limites de crédits, et envoyez-la avec chaque requête.
Chaque requête transporte une clé d’API d’organisation sous forme de jeton porteur.
Authorization: Bearer mor_live_9f2c…Une clé appartient à l’organisation, et non à la personne qui l’a créée. Tous les administrateurs de l’organisation peuvent la voir et la révoquer, et elle continue de fonctionner lorsque son créateur quitte l’équipe. Elle cesse de fonctionner lorsqu’elle est révoquée, lorsqu’elle expire, lorsque le compte de son créateur est suspendu, ou lorsque Morphic désactive la Direct API pour l’organisation.
Créer une clé
Les autorisations de la Direct API n’apparaissent qu’une fois que Morphic a activé la Direct API pour votre organisation. Voir Obtenir l’accès.
- Dans Morphic Studio, ouvrez le menu déroulant de l’organisation (le logo Morphic, en haut à gauche) et sélectionnez « Paramètres ».
- Dans la barre latérale gauche, cliquez sur « Clés d'API ». Seuls les administrateurs voient cet onglet.
- Cliquez sur « Nouvelle clé ».
- Saisissez un « Nom », choisissez les « Autorisations » dont la clé a besoin et, si elle ne doit pas durer indéfiniment, sa date d’« Expiration ».
- Sous « Limites de crédits », définissez le total que la clé pourra dépenser au cours de sa vie et, si vous le souhaitez, une limite quotidienne et une limite mensuelle.
- Cochez « J’accepte les Conditions d’utilisation de Morphic, y compris la section relative à l’API pour les développeurs ». Vous acceptez ainsi les Conditions d’utilisation au nom de l’organisation.
- Cliquez sur « Créer la clé », puis copiez le secret dans votre gestionnaire de secrets. Il n’est affiché qu’une seule fois.
Toute personne qui détient le secret peut dépenser les crédits de votre organisation jusqu’aux limites de la clé. Ne placez jamais une clé dans un navigateur, une application mobile ou un dépôt public.
Format de la clé
mor_live_<64 hex characters>Le préfixe vous indique, ainsi qu’aux outils de détection de secrets, à quel déploiement la clé est destinée.
Autorisations
Une clé n’accède qu’aux outils que ses autorisations permettent. Choisissez l’ensemble le plus restreint possible.
| Autorisation | Libellé dans Studio | Accorde |
|---|---|---|
projects:read | Lire les projets et leurs fichiers | lister les projets, les workflows et les timelines Compose |
assets:read | Rechercher et lire des assets | lister la bibliothèque, lire les générations et leur statut, les personnages |
assets:write | Importer des assets et les modifier | transmettre des médias par URL, créer des timelines Compose |
generations:write | Générer des images, des vidéos et de l’audio (consomme des crédits) | tous les outils qui lancent, modifient ou analysent des médias |
L’appel d’un outil hors des autorisations de la clé répond 403 insufficient_scope et indique l’autorisation manquante dans data.required_scopes. Les points de terminaison et les outils qui ne nécessitent aucune autorisation, comme list_voices et /me, sont ouverts à toutes les clés. Le catalogue d’outils indique l’autorisation requise par chaque outil.
Limites de crédits
Chaque clé porte des plafonds de dépense, définis à sa création. Un administrateur peut les modifier plus tard avec « Modifier les limites ».
| Limite | Obligatoire | Période |
|---|---|---|
total_credit_limit | oui | toute la durée de vie de la clé |
monthly_credit_limit | non | mois civil, UTC |
daily_credit_limit | non | jour civil, UTC |
- Un appel payant qui ferait dépasser une limite à la clé est refusé avec
402 api_key_credit_limit_reachedavant que quoi que ce soit ne démarre ;data.periodindique de quelle limite il s’agit. - Le solde de l’organisation s’applique en plus : un appel qu’elle ne peut pas payer est refusé avec
402 insufficient_credits. GET /v1/direct/merenvoie les limites de la clé et ses dépenses actuelles. Voir Crédits et consommation.
Renouveler une clé
- Créez la nouvelle clé.
- Déployez-la.
- Révoquez l’ancienne clé avec « Révoquer la clé ».
Une organisation peut détenir jusqu’à 10 clés actives, si bien qu’un renouvellement n’entraîne jamais d’interruption.
Si vous rencontrez le moindre problème ou si vous avez des questions, n’hésitez pas à nous contacter. Nous serons ravis de vous aider. Écrivez-nous à support@morphic.com.
Direct API
Générez, modifiez et gérez des images, des vidéos et de l’audio dans Morphic depuis votre propre backend, en HTTPS.
Appeler un outil
Appelez n’importe quel outil de la Direct API avec une seule forme de requête, lisez son résultat et sa facturation, et réessayez les appels payants sans risque grâce à un Idempotency-Key.