curl --request POST 'https://api.voicecheap.ai/v1/actions/images_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"generationId":"6224018c7635dcb933ce5c8f7804aea73738dd1c"}'
const input = {
generationId: '6224018c7635dcb933ce5c8f7804aea73738dd1c',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_download', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/images_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"mimeType": "image/png",
"data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAACXBIWXMAAAPoAAAD6AG1e1JrAAAADElEQVQImWP4+vUrAAXCAuD7W1s+AAAAAElFTkSuQmCC"
}
}
Images
Télécharger une image générée
Récupérez une image non expirée qui vous appartient. Renvoie un PNG en base64 dans data avec son mimeType, ou un contenu image natif via MCP. Les images jusqu’à 8 MiB sont prises en charge.
POST
/
v1
/
actions
/
images_download
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"generationId":"6224018c7635dcb933ce5c8f7804aea73738dd1c"}'
const input = {
generationId: '6224018c7635dcb933ce5c8f7804aea73738dd1c',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_download', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/images_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"mimeType": "image/png",
"data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAACXBIWXMAAAPoAAAD6AG1e1JrAAAADElEQVQImWP4+vUrAAXCAuD7W1s+AAAAAElFTkSuQmCC"
}
}
Récupérez une image non expirée qui vous appartient. Renvoie un PNG en base64 dans data avec son mimeType, ou un contenu image natif via MCP. Les images jusqu’à 8 MiB sont prises en charge.
Autorisations requises:
POST https://api.voicecheap.ai/v1/actions/images_download
Authentification et autorisations
string
requis
Envoyez une clé API VoiceCheap dans cet en-tête. Authorization: Bearer avec la même clé API est également accepté. Les jetons d’accès OAuth sont
acceptés uniquement par MCP, pas par cet endpoint REST.
images:read.
Un abonnement payant actif est requis. Les autorisations ne modifient ni les rôles dans l’équipe, ni la propriété des ressources, ni les crédits média, ni les limites du forfait.
Paramètres
string
requis
ID de génération renvoyé par une action de génération ou d’historique.Motif:
^[A-Za-z0-9_-]{1,128}$.Schéma d’entrée complet
Schéma d’entrée complet
Le JSON Schema ci-dessous conserve les noms de champs exacts, les types imbriqués, les valeurs par défaut, les limites et les valeurs acceptées exposés par la découverte. Les règles supplémentaires entre champs figurent dans les notes de l’opération.
{
"type": "object",
"properties": {
"generationId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,128}$",
"description": "Generation ID returned by a generation or history action."
}
},
"required": ["generationId"],
"additionalProperties": false
}
Exemples de requêtes
Remplacez les exemples d’identifiants de ressources et de clés média par des valeurs renvoyées pour votre compte. Conservez le même identifiant de requête lorsque vous réessayez la même mutation.curl --request POST 'https://api.voicecheap.ai/v1/actions/images_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"generationId":"6224018c7635dcb933ce5c8f7804aea73738dd1c"}'
const input = {
generationId: '6224018c7635dcb933ce5c8f7804aea73738dd1c',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_download', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/images_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Réponse
Une première exécution réussie renvoie HTTP 200 avec le résultat de l’opération sous data. Une nouvelle tentative peut renvoyer à la place l’état de la requête enregistrée. L’exemple présente une réponse possible, sans tous les champs facultatifs. Le PNG généré est renvoyé sous forme de chaîne base64 dans data, accompagné de generationId et mimeType. Il s’agit d’un objet JSON, et non d’un corps HTTP binaire ou d’une URL de téléchargement.{
"data": {
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"mimeType": "image/png",
"data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAACXBIWXMAAAPoAAAD6AG1e1JrAAAADElEQVQImWP4+vUrAAXCAuD7W1s+AAAAAElFTkSuQmCC"
}
}
Champs du résultat
| Champ | Description |
|---|---|
data.generationId | Identifiant de la génération téléchargée. |
data.mimeType | image/png. |
data.data | Octets PNG encodés en Base64 sans préfixe d’URL data:. |
Notes de l’opération
- Nécessite images:read. generationId doit contenir 1–128 lettres ASCII, chiffres, traits de soulignement ou traits d’union.
- Cette action utilise les créations et les envois de l’utilisateur connecté, y compris lorsque l’identifiant d’accès est connecté dans un contexte d’équipe.
- Seule une image de l’application terminée, appartenant à l’acteur, avec un fichier stocké et un expiresAt dans le futur peut être téléchargée. Les images du compte expirent sept jours après leur création.
- Le PNG décodé ne doit pas dépasser 8 MiB (8,388,608 octets). L’encodage Base64 rend la chaîne JSON plus volumineuse que le fichier binaire.
- Décodez data en base64 pour enregistrer le PNG. Il n’y a pas de préfixe d’URL data:. Via MCP, le serveur émet un contenu image natif et un bloc de texte contenant generationId à la place de ce résultat JSON habituel.
Utilisation
Chaque invocation réussie consomme un appel du quota mensuel API/MCP. Les crédits média et les quotas de génération propres à l’opération s’appliquent également.Erreurs
| Statut HTTP | Code | Signification ou solution |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Des identifiants ont été fournis dans un paramètre de requête access_token ou api_key. Envoyez les identifiants dans les en-têtes. |
| 400 | VALIDATION_ERROR | Un argument est manquant, contient une valeur non prise en charge, dépasse sa limite ou ne fait pas partie du schéma d’entrée strict. |
| 401 | API_KEY_EXPIRED | La clé API a expiré. |
| 401 | INVALID_API_KEY | Fournissez une clé API valide et non expirée. |
| 401 | INVALID_CREDENTIAL | L’en-tête Authorization est mal formé ou entre en conflit avec x-api-key. |
| 401 | MISSING_CREDENTIAL | Aucun identifiant d’authentification utilisable n’a été fourni dans les en-têtes, ou il dépassait 4096 caractères. |
| 401 | USER_NOT_FOUND | Le compte associé à l’identifiant d’accès n’existe plus. |
| 403 | AMBIGUOUS_TEAM_API_KEY | L’utilisateur associé aux identifiants d’authentification appartient à plusieurs équipes, ce qui rend le contexte de facturation ambigu. |
| 403 | INSUFFICIENT_SCOPE | Accordez toutes les autorisations requises ou choisissez d’autres identifiants d’accès. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Les limites d’intégration du compte n’ont pas pu être vérifiées. |
| 403 | SUBSCRIPTION_REQUIRED | Utilisez un abonnement payant actif. |
| 403 | TEAM_OWNER_NOT_FOUND | Le compte du propriétaire effectif de l’équipe est introuvable. |
| 404 | IMAGE_NOT_FOUND | L’image est manquante, n’appartient pas au compte, n’est pas terminée, a échoué, a expiré ou ne possède pas de fichier enregistré. |
| 413 | IMAGE_DOWNLOAD_TOO_LARGE | L’image générée dépasse la limite de téléchargement de l’intégration de 8 MiB. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Attendez la réinitialisation mensuelle ou changez de forfait. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Respectez Retry-After lorsqu’il est présent et espacez progressivement les nouvelles tentatives. |
| 500 | INTERNAL_ERROR | Vérifiez l’état de la requête enregistrée et l’historique de la ressource avant de décider de réessayer une mutation. |
| 503 | INTERNAL_ERROR | L’image enregistrée n’a pas pu être récupérée ou décodée. Réessayez le téléchargement plus tard. |
| 503 | SERVER_RESTARTING | Le serveur redémarre. Réessayez dans un instant en conservant le même identifiant de requête pour une mutation. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["images:read"]
}
}
Cette page vous a-t-elle été utile ?