curl --request POST 'https://api.voicecheap.ai/v1/actions/images_get' \
--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_get', {
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_get",
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",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
}
Images
Consulter une génération d’image
Consultez le statut, les dimensions et la date d’expiration d’une image générée par le compte connecté.
POST
/
v1
/
actions
/
images_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_get' \
--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_get', {
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_get",
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",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
}
Consultez le statut, les dimensions et la date d’expiration d’une image générée par le compte connecté.
Autorisations requises:
POST https://api.voicecheap.ai/v1/actions/images_get
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_get' \
--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_get', {
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_get",
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. Les métadonnées publiques de l’image de l’application vous appartenant, y compris son statut actuel, ses dimensions et son expiration. Les données de l’image sont récupérées séparément.{
"data": {
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
}
Champs du résultat
| Champ | Description |
|---|---|
data.generationId | Identifiant à transmettre tel quel à images_get ou images_download. |
data.status | pending, completed, failed ou expired. L’expiration prévaut sur le statut enregistré. |
data.aspectRatio | square, landscape ou portrait. |
data.width | Largeur de sortie en pixels, ou null tant que les dimensions ne sont pas disponibles. |
data.height | Hauteur de sortie en pixels, ou null tant que les dimensions ne sont pas disponibles. |
data.referenceImageCount | Nombre d’images de référence utilisées : 0 ou 1. |
data.createdAt | Date de création en millisecondes Unix. |
data.updatedAt | Date de dernière mise à jour en millisecondes Unix. |
data.expiresAt | Instant en millisecondes Unix après lequel l’image générée ne peut plus être téléchargée. |
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.
- L’enregistrement peut indiquer pending, completed, failed ou expired. La largeur et la hauteur valent null lorsqu’elles ne sont pas disponibles. Un enregistrement peut rester visible comme expired jusqu’à sa suppression par le nettoyage ; un appel get réussi ne garantit pas la disponibilité du téléchargement.
- Utilisez images_download pour obtenir les octets PNG avant expiresAt. Cette action ne renvoie ni previewDataUrl ni URL média.
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 | La génération n’existe pas, appartient à un autre utilisateur ou n’est pas une image de l’application. |
| 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 | 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 ?