curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_initialize' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"85d80887-5e1c-4a86-bbad-bb105487f7e4","filename":"reference.png","contentType":"image/png","fileSize":7340032}'
const input = {
requestId: '85d80887-5e1c-4a86-bbad-bb105487f7e4',
filename: 'reference.png',
contentType: 'image/png',
fileSize: 7340032,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_initialize', {
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_initialize",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "filename": "reference.png", "contentType": "image/png", "fileSize": 7340032},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a",
"key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"partSize": 5242880,
"maxConcurrency": 4
},
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
}
{
"data": {
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4",
"operation": "images_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
}
{
"data": {
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4",
"operation": "images_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
}
Images
Initialiser l’envoi d’une image de référence
Préparez l’envoi d’une référence JPG, PNG ou WebP de 8 MiB maximum. Utilisez images_upload_sign_parts pour obtenir les URL PUT, envoyez les octets, puis appelez images_upload_complete et utilisez son fileKey lors de la génération.
POST
/
v1
/
actions
/
images_upload_initialize
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_initialize' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"85d80887-5e1c-4a86-bbad-bb105487f7e4","filename":"reference.png","contentType":"image/png","fileSize":7340032}'
const input = {
requestId: '85d80887-5e1c-4a86-bbad-bb105487f7e4',
filename: 'reference.png',
contentType: 'image/png',
fileSize: 7340032,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_initialize', {
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_initialize",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "filename": "reference.png", "contentType": "image/png", "fileSize": 7340032},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a",
"key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"partSize": 5242880,
"maxConcurrency": 4
},
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
}
{
"data": {
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4",
"operation": "images_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
}
{
"data": {
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4",
"operation": "images_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
}
Préparez l’envoi d’une référence JPG, PNG ou WebP de 8 MiB maximum. Utilisez images_upload_sign_parts pour obtenir les URL PUT, envoyez les octets, puis appelez images_upload_complete et utilisez son fileKey lors de la génération.
Autorisations requises:
POST https://api.voicecheap.ai/v1/actions/images_upload_initialize
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
Le nom du fichier image, avec une extension correspondant à contentType.Longueur minimale: 1. Longueur maximale: 250. Motif:
\.(?:jpe?g|png|webp)$.string
requis
Valeur textuelle.Valeurs acceptées: “image/jpeg”, “image/png”, “image/webp”.
integer
requis
Taille exacte du fichier en octets, jusqu’à 8 MiB.Minimum: 1. Maximum: 8388608.
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}$"
},
"filename": {
"type": "string",
"minLength": 1,
"maxLength": 250,
"pattern": "\\.(?:jpe?g|png|webp)$",
"description": "The image filename, with an extension matching contentType."
},
"contentType": {
"type": "string",
"enum": ["image/jpeg", "image/png", "image/webp"]
},
"fileSize": {
"type": "integer",
"minimum": 1,
"maximum": 8388608,
"description": "Exact file size in bytes, up to 8 MiB."
}
},
"required": ["filename", "contentType", "fileSize"],
"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_initialize' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"85d80887-5e1c-4a86-bbad-bb105487f7e4","filename":"reference.png","contentType":"image/png","fileSize":7340032}'
const input = {
requestId: '85d80887-5e1c-4a86-bbad-bb105487f7e4',
filename: 'reference.png',
contentType: 'image/png',
fileSize: 7340032,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_initialize', {
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_initialize",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "filename": "reference.png", "contentType": "image/png", "fileSize": 7340032},
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. Une nouvelle session d’envoi multipartie d’image de référence, la future clé d’objet, la taille des parties en octets et le nombre maximal d’envois en parallèle. Cette action n’envoie aucun octet d’image et ne rend pas key prêt pour la génération.{
"data": {
"uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a",
"key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"partSize": 5242880,
"maxConcurrency": 4
},
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
}
{
"data": {
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4",
"operation": "images_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
}
{
"data": {
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4",
"operation": "images_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
}
Champs du résultat
| Champ | Description |
|---|---|
data.uploadId | UUID identifiant la session d’envoi active. Transmettez-le aux autres actions d’envoi. |
data.key | Future clé d’objet appartenant à l’utilisateur. Utilisez fileKey obtenu après une finalisation réussie comme référence de génération. |
data.partSize | Taille requise des parties en octets, à l’exception de la dernière qui contient les octets restants. |
data.maxConcurrency | Nombre maximal conseillé d’envois de parties en parallèle : 4. |
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":"85d80887-5e1c-4a86-bbad-bb105487f7e4","operation":"images_upload_initialize"}'
HTTP 200
{
"data": {
"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4",
"operation": "images_upload_initialize",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a",
"key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
"partSize": 5242880,
"maxConcurrency": 4
}
}
}
Notes de l’opération
- Nécessite images:write ; aucune autorisation d’envoi supplémentaire n’est nécessaire.
- Les espaces en début et en fin de filename sont supprimés ; sa longueur doit être de 1–250 caractères et il doit se terminer par .jpg, .jpeg, .png ou .webp. Son extension doit correspondre à contentType : image/jpeg, image/png ou image/webp. fileSize est le nombre entier exact d’octets, de 1 à 8,388,608.
- L’implémentation d’envoi partagée renvoie partSize 5 MiB (5,242,880 octets) pour ces références. Un fichier d’au plus 5 MiB utilise une partie ; un fichier plus volumineux, jusqu’à 8 MiB, en utilise deux. Demandez les URL PUT avec images_upload_sign_parts, envoyez les octets, puis appelez images_upload_complete.
- Utilisez le fileKey renvoyé par la finalisation comme referenceImageKey dans images_generate. Le résultat de initialize utilise key, et non fileKey. Ne transmettez pas key à la génération avant la finalisation.
- 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.
- 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.
- 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.
- Le nom du fichier dans la clé d’objet est assaini et peut être raccourci. Conservez exactement la clé et uploadId renvoyés ; ne les construisez pas vous-même. Les octets de l’image sont validés lors de la génération, en complément de la taille et du type déclarés lors de l’envoi.
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 | 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 | REFERENCE_IMAGE_INVALID | L’extension du nom de fichier ne correspond pas au contentType d’image déclaré. |
| 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 | 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. |
| 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 n’a pas pu être créée ou enregistrée. Réessayez avec le même identifiant de mutation et examinez son état enregistré. |
| 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 ?