curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"b7d73225-716b-45ec-ae43-559cfb3b6412","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","parts":[{"partNumber":1,"etag":"\"d41d8cd98f00b204e9800998ecf8427e\""},{"partNumber":2,"etag":"\"0cc175b9c0f1b6a831c399e269772661\""}]}'
const input = {
requestId: 'b7d73225-716b-45ec-ae43-559cfb3b6412',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
parts: [
{
partNumber: 1,
etag: '"d41d8cd98f00b204e9800998ecf8427e"',
},
{
partNumber: 2,
etag: '"0cc175b9c0f1b6a831c399e269772661"',
},
],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_complete', {
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_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "parts": [{"partNumber": 1, "etag": "\"d41d8cd98f00b204e9800998ecf8427e\""}, {"partNumber": 2, "etag": "\"0cc175b9c0f1b6a831c399e269772661\""}]},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"fileKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"readUrl": "https://media.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
Images
Finaliser l’envoi d’une image de référence
Finalisez un envoi d’image de référence qui vous appartient à l’aide des numéros de parties et des ETags des requêtes PUT. Vérifie la taille du fichier stocké. Utilisez le fileKey renvoyé comme référence pour la génération.
POST
/
v1
/
actions
/
images_upload_complete
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"b7d73225-716b-45ec-ae43-559cfb3b6412","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","parts":[{"partNumber":1,"etag":"\"d41d8cd98f00b204e9800998ecf8427e\""},{"partNumber":2,"etag":"\"0cc175b9c0f1b6a831c399e269772661\""}]}'
const input = {
requestId: 'b7d73225-716b-45ec-ae43-559cfb3b6412',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
parts: [
{
partNumber: 1,
etag: '"d41d8cd98f00b204e9800998ecf8427e"',
},
{
partNumber: 2,
etag: '"0cc175b9c0f1b6a831c399e269772661"',
},
],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_complete', {
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_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "parts": [{"partNumber": 1, "etag": "\"d41d8cd98f00b204e9800998ecf8427e\""}, {"partNumber": 2, "etag": "\"0cc175b9c0f1b6a831c399e269772661\""}]},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"fileKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"readUrl": "https://media.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
Finalisez un envoi d’image de référence qui vous appartient à l’aide des numéros de parties et des ETags des requêtes PUT. Vérifie la taille du fichier stocké. Utilisez le fileKey renvoyé comme référence pour la génération.
Autorisations requises:
POST https://api.voicecheap.ai/v1/actions/images_upload_complete
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:write.
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
Facultatif au niveau du transport : le serveur injecte un identifiant avant la validation si ce champ est omis. Fournissez votre propre UUID v4 stable pour récupérer le résultat en toute sécurité si la réponse est perdue.Format: “uuid”. Motif:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.string
requis
L’uploadId renvoyé par l’action upload_initialize de ce domaine.Format: “uuid”. Motif:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.array
requis
Liste de valeurs. Consultez le schéma d’entrée complet pour connaître la structure de ses éléments.Nombre minimal d’éléments: 1. Nombre maximal d’éléments: 2.
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": {
"requestId": {
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
"type": "string",
"format": "uuid",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"uploadId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The uploadId returned by this domain’s upload_initialize action."
},
"parts": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"type": "object",
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1,
"maximum": 2
},
"etag": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": ["partNumber", "etag"],
"additionalProperties": false
}
}
},
"required": ["uploadId", "parts"],
"additionalProperties": false
}
Idempotence
Utilisez un UUID v4 dans requestId ou dans l’en-tête HTTP Idempotency-Key pour chaque mutation. Après une erreur réseau, réutilisez le même identifiant avec des arguments identiques. Si les deux sont fournis, ils doivent correspondre. Rejouer une requête enregistrée ne répète pas l’opération et ne décompte pas un nouvel appel mensuel. Les requêtes en échec ou interrompues ne sont pas relancées automatiquement. Toute mutation peut renvoyer HTTP 202 lorsqu’une nouvelle tentative retrouve la même requête encore en cours, même si sa première exécution est habituellement synchrone. Si l’exécution est terminée mais que resultStored vaut false, une nouvelle tentative renvoie HTTP 200 avec l’état de la requête enregistrée, au lieu du résultat d’origine. Récupérez le résultat avec l’action d’historique, de résultat ou de téléchargement de son domaine.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_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"b7d73225-716b-45ec-ae43-559cfb3b6412","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","parts":[{"partNumber":1,"etag":"\"d41d8cd98f00b204e9800998ecf8427e\""},{"partNumber":2,"etag":"\"0cc175b9c0f1b6a831c399e269772661\""}]}'
const input = {
requestId: 'b7d73225-716b-45ec-ae43-559cfb3b6412',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
parts: [
{
partNumber: 1,
etag: '"d41d8cd98f00b204e9800998ecf8427e"',
},
{
partNumber: 2,
etag: '"0cc175b9c0f1b6a831c399e269772661"',
},
],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_complete', {
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_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "parts": [{"partNumber": 1, "etag": "\"d41d8cd98f00b204e9800998ecf8427e\""}, {"partNumber": 2, "etag": "\"0cc175b9c0f1b6a831c399e269772661\""}]},
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. La clé de référence finalisée vous appartenant et son URL de lecture, renvoyées uniquement lorsque le nombre d’octets stockés correspond exactement à la taille de fichier déclarée. Utilisez fileKey, et non readUrl, dans les arguments de génération.{
"data": {
"fileKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"readUrl": "https://media.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412"
}
Champs du résultat
| Champ | Description |
|---|---|
data.fileKey | Clé d’objet finalisé appartenant à l’acteur, à utiliser comme référence de génération. |
data.readUrl | URL de lecture de l’objet de référence envoyé. Les actions de génération acceptent fileKey, et non cette URL. |
Récupérer et suivre cette requête
Utilisez le même identifiant, même après une perte de connexion. Si resultStored vaut false, récupérez le résultat avec l’action d’historique, de résultat ou de téléchargement correspondante. Ne lancez jamais une seconde génération uniquement pour vérifier l’avancement.curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"b7d73225-716b-45ec-ae43-559cfb3b6412","operation":"images_upload_complete"}'
HTTP 200
{
"data": {
"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412",
"operation": "images_upload_complete",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"fileKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"readUrl": "https://media.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"
}
}
}
Notes de l’opération
- Nécessite images:write ; aucune autorisation d’envoi supplémentaire n’est nécessaire.
- uploadId est l’UUID provenant de initialize. parts contient exactement les 1–2 parties exigées par la session. Chaque partie possède un entier partNumber de 1 à 2 et une chaîne etag de 1–256 caractères issue de sa réponse PUT réussie.
- Tous les numéros de partie doivent être présents et uniques. Les parties sont triées avant la finalisation ; les ETags sont normalisés en valeurs entre guillemets. Vous pouvez conserver les guillemets des ETag renvoyés par le stockage.
- La taille réelle de l’objet finalisé en octets est vérifiée par rapport à fileSize et à la limite de 8 MiB. Une taille absente, différente ou excessive entraîne la suppression de l’objet et de la session active, et renvoie UPLOAD_SIZE_MISMATCH.
- Transmettez fileKey dans referenceImageKey pour images_generate. Les fichiers de référence finalisés peuvent être réutilisés pour les générations suivantes d’images ou de miniatures du même utilisateur ; la génération ne consomme pas la référence.
- Seul un envoi appartenant à l’utilisateur connecté peut être signé, finalisé ou annulé. Ces alias acceptent uniquement les sessions JPG, PNG et WebP de 8 MiB maximum, même si la session a été créée via une autre famille d’envois.
- La session d’envoi de production expire après 24 heures. Les URL signées des parties expirent après une heure. La finalisation et l’annulation suppriment la session active ; sign-parts et complete renvoient ensuite Upload not found. Aucune des deux réponses ne contient de champ expiresAt.
- Utilisez un requestId UUID v4 ou l’en-tête HTTP Idempotency-Key, et réutilisez-le avec des entrées identiques lors des nouvelles tentatives. La couche d’intégration enregistre chaque modification et renvoie son état ou son résultat enregistré sans la réexécuter. Une requête échouée ou interrompue n’est pas automatiquement relancée.
- La finalisation ferme la session multipartie. Réessayez la finalisation avec le requestId d’origine pour récupérer le résultat enregistré ; une nouvelle requête de finalisation pour cet uploadId fermé renvoie Upload not found. Cette action ne renvoie aucune échéance de conservation de la référence.
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 | BAD_REQUEST | La liste de finalisation contient des numéros de parties manquants, en double ou invalides. |
| 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 | IDEMPOTENCY_CONFLICT | L’en-tête Idempotency-Key et le champ requestId du corps doivent correspondre. |
| 400 | INVALID_REQUEST_ID | requestId ou Idempotency-Key n’est pas un UUID v4. |
| 400 | UPLOAD_SIZE_MISMATCH | La taille enregistrée de l’objet finalisé est indisponible, diffère de fileSize ou dépasse 8 MiB ; l’objet et la session sont supprimés. |
| 400 | UPLOAD_TYPE_NOT_ALLOWED | La session d’envoi n’est pas d’un type d’image pris en charge ou dépasse 8 MiB. |
| 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 | UNAUTHORIZED | La session d’envoi appartient à un autre utilisateur. |
| 401 | USER_NOT_FOUND | Le compte associé à l’identifiant d’accès n’existe plus. |
| 403 | ACCOUNT_UNAVAILABLE | Le compte à l’origine de l’action ou le compte de facturation est indisponible ou en cours de suppression. |
| 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 | NOT_FOUND | La session d’envoi est inconnue, expirée, déjà finalisée ou annulée. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | Ce compte a déjà 10 actions d’intégration en cours. Suivez une requête existante avant d’en démarrer une autre. |
| 409 | IDEMPOTENCY_CONFLICT | L’identifiant de requête a déjà été utilisé avec des arguments différents ; une divergence entre les identifiants de l’en-tête et du corps renvoie HTTP 400 avec le même code. |
| 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 | ACTION_RESULT_UNAVAILABLE | L’action a été exécutée, mais son résultat n’a pas pu être enregistré. Consultez l’état de la requête enregistrée et l’historique de la ressource avant de lancer une nouvelle génération. |
| 503 | INTERNAL_ERROR | La session d’envoi active n’a pas pu être lue. Consultez l’état de la requête avant une nouvelle tentative de finalisation. |
| 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:write"]
}
}
Cette page vous a-t-elle été utile ?