curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_sign_parts' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"8d16d4dc-a1a1-45bc-8f9c-75612ea7561f","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","partNumbers":[1,2]}'
const input = {
requestId: '8d16d4dc-a1a1-45bc-8f9c-75612ea7561f',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
partNumbers: [1, 2],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_sign_parts', {
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_sign_parts",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "partNumbers": [1, 2]},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"presignedUrls": [
{
"partNumber": 1,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=1&uploadId=example-upload&signature=example-signature"
},
{
"partNumber": 2,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=2&uploadId=example-upload&signature=example-signature"
}
]
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
Immagini
Ottieni gli URL di caricamento dell'immagine di riferimento
Ottieni URL PUT firmati per il caricamento di un’immagine di riferimento di tua proprietà. Un’immagine da 8 MiB ha al massimo due parti. Salva l’ETag restituito da ogni PUT per upload_complete.
POST
/
v1
/
actions
/
images_upload_sign_parts
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_sign_parts' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"8d16d4dc-a1a1-45bc-8f9c-75612ea7561f","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","partNumbers":[1,2]}'
const input = {
requestId: '8d16d4dc-a1a1-45bc-8f9c-75612ea7561f',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
partNumbers: [1, 2],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_sign_parts', {
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_sign_parts",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "partNumbers": [1, 2]},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"presignedUrls": [
{
"partNumber": 1,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=1&uploadId=example-upload&signature=example-signature"
},
{
"partNumber": 2,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=2&uploadId=example-upload&signature=example-signature"
}
]
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
Ottieni URL PUT firmati per il caricamento di un’immagine di riferimento di tua proprietà. Un’immagine da 8 MiB ha al massimo due parti. Salva l’ETag restituito da ogni PUT per upload_complete.
Autorizzazioni richieste:
POST https://api.voicecheap.ai/v1/actions/images_upload_sign_parts
Autenticazione e autorizzazioni
string
obbligatorio
Invia una chiave API VoiceCheap in questa intestazione. È supportato anche Authorization: Bearer con la stessa chiave API. I token di accesso OAuth
sono accettati solo da MCP, non da questo endpoint REST.
images:write.
È necessario un abbonamento a pagamento attivo. Le autorizzazioni non modificano i ruoli del team, la proprietà delle risorse, i crediti multimediali o i limiti del piano.
Parametri
string
Facoltativo al livello di trasporto: se omesso, il server inserisce un identificatore prima della validazione. Fornisci un tuo UUID v4 stabile per recuperare in sicurezza una risposta persa.Formato: “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}$.string
obbligatorio
L’uploadId restituito dall’azione upload_initialize di questo dominio.Formato: “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)$.array
obbligatorio
Elenco di valori. Consulta lo schema di input completo per la struttura degli elementi.Numero minimo di elementi: 1. Numero massimo di elementi: 2.
Schema di input completo
Schema di input completo
Il JSON Schema seguente conserva i nomi esatti dei campi, i tipi annidati, i valori predefiniti, i limiti e i valori accettati esposti dalla discovery. Le ulteriori regole tra campi sono elencate nelle note sull’operazione.
{
"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."
},
"partNumbers": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 2
}
}
},
"required": ["uploadId", "partNumbers"],
"additionalProperties": false
}
Idempotenza
Usa un UUID v4 in requestId o nell’intestazione HTTP Idempotency-Key per ogni modifica. Riutilizza lo stesso identificatore e argomenti identici dopo un errore di rete. Se vengono forniti entrambi, devono coincidere. Ripetere una richiesta salvata non ripete l’operazione e non consuma un’altra chiamata mensile. Le richieste non riuscite o interrotte non vengono riavviate automaticamente. Ogni modifica può restituire HTTP 202 quando un nuovo tentativo trova la stessa richiesta ancora in esecuzione, anche se la prima esecuzione è normalmente sincrona. Se l’esecuzione è completata ma resultStored è false, un nuovo tentativo restituisce HTTP 200 con lo stato della richiesta salvata anziché il risultato originale. Recupera l’output tramite l’azione di cronologia, risultato o download del relativo dominio.Esempi di richiesta
Sostituisci gli identificatori delle risorse e le chiavi multimediali di esempio con i valori restituiti per il tuo account. Mantieni stabile l’identificatore della richiesta quando ripeti la stessa modifica.curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_sign_parts' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"8d16d4dc-a1a1-45bc-8f9c-75612ea7561f","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","partNumbers":[1,2]}'
const input = {
requestId: '8d16d4dc-a1a1-45bc-8f9c-75612ea7561f',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
partNumbers: [1, 2],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_sign_parts', {
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_sign_parts",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "partNumbers": [1, 2]},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Risposta
Una prima esecuzione riuscita restituisce HTTP 200 con il risultato dell’operazione in data. Una ripetizione può invece restituire lo stato della richiesta salvata. L’esempio mostra una risposta supportata, non tutti i campi facoltativi. Array di URL PUT firmati temporanei, uno per ogni numero di parte distinto richiesto. La risposta non contiene byte dell’immagine, ETags o campi di dimensione per parte.{
"data": {
"presignedUrls": [
{
"partNumber": 1,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=1&uploadId=example-upload&signature=example-signature"
},
{
"partNumber": 2,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=2&uploadId=example-upload&signature=example-signature"
}
]
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
Campi del risultato
| Campo | Descrizione |
|---|---|
data.presignedUrls | Array di destinazioni firmate per il caricamento delle parti. |
data.presignedUrls[].partNumber | Numero della parte per questo URL, con numerazione a partire da uno. |
data.presignedUrls[].url | URL PUT temporaneo valido per un’ora; usa l’esatto Content-Length firmato per quella parte. |
Recupera e monitora questa richiesta
Usa lo stesso identificatore anche dopo una connessione persa. Se resultStored è false, recupera l’output tramite la corrispondente azione di cronologia, risultato o download. Non avviare mai una seconda generazione solo per verificarne l’avanzamento.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":"8d16d4dc-a1a1-45bc-8f9c-75612ea7561f","operation":"images_upload_sign_parts"}'
HTTP 200
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"presignedUrls": [
{
"partNumber": 1,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=1&uploadId=example-upload&signature=example-signature"
},
{
"partNumber": 2,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=2&uploadId=example-upload&signature=example-signature"
}
]
}
}
}
Note sull’operazione
- Richiede images:write; non è necessario alcuno scope aggiuntivo per il caricamento.
- uploadId è l’UUID di initialize. partNumbers contiene 1–2 numeri interi, ciascuno compreso tra 1 e 2, e ogni parte deve esistere per il fileSize dichiarato di quella sessione. I numeri di parte richiesti duplicati vengono ricondotti a un solo URL.
- Invia con PUT i byte binari grezzi di ogni parte a ciascun URL restituito. Content-Length è firmato e deve corrispondere esattamente a min(partSize, fileSize - (partNumber - 1) × partSize). Nell’esempio da 7 MiB, la parte 1 è di 5,242,880 byte e la parte 2 è di 2,097,152 byte. Non inviare JSON, multipart/form-data o base64 all’URL firmato.
- Salva l’header di risposta ETag di ogni PUT riuscito e invia questi valori a images_upload_complete. Tratta gli URL firmati come autorizzazioni di caricamento temporanee e private.
- È possibile firmare, completare o interrompere solo un caricamento appartenente all’utente connesso. Questi alias accettano solo sessioni JPG, PNG e WebP di al massimo 8 MiB, anche se la sessione è stata creata tramite una famiglia di caricamento diversa.
- La sessione di caricamento in produzione scade dopo 24 ore. Gli URL firmati delle parti scadono dopo un’ora. Il completamento e l’interruzione rimuovono la sessione attiva; sign-parts e complete restituiscono quindi Upload not found. Nessuna delle due risposte include un campo expiresAt.
- Usa un requestId UUID v4 oppure l’header HTTP Idempotency-Key e riutilizzalo con input identici nei nuovi tentativi. Il livello di integrazione registra ogni modifica e ne restituisce lo stato o il risultato registrato senza eseguirla nuovamente. Una richiesta fallita o interrotta non viene ritentata automaticamente.
- Per ottenere nuovi URL dopo la loro scadenza di un’ora, mentre la sessione è ancora attiva, chiama sign-parts con un nuovo requestId. Riprovare con lo stesso requestId restituisce il risultato salvato, inclusi i vecchi URL.
Utilizzo
Ogni invocazione riuscita consuma una chiamata API/MCP mensile. Si applicano anche i crediti multimediali e le quote di generazione proprie dell’operazione.Errori
| Stato HTTP | Codice | Significato o risoluzione |
|---|---|---|
| 400 | BAD_REQUEST | Un numero di parte non esiste per la dimensione del file dichiarata. |
| 400 | CREDENTIAL_IN_QUERY | Le credenziali sono state fornite in un parametro di query access_token o api_key. Invia le credenziali negli header. |
| 400 | IDEMPOTENCY_CONFLICT | L’intestazione Idempotency-Key e il campo requestId del corpo devono coincidere. |
| 400 | INVALID_REQUEST_ID | requestId o Idempotency-Key non è un UUID v4. |
| 400 | UPLOAD_TYPE_NOT_ALLOWED | La sessione di caricamento non è di un tipo di immagine supportato o supera 8 MiB. |
| 400 | VALIDATION_ERROR | Un argomento è mancante, ha un valore non supportato, supera il proprio limite oppure non fa parte dello schema di input rigoroso. |
| 401 | API_KEY_EXPIRED | La chiave API è scaduta. |
| 401 | INVALID_API_KEY | Fornisci una chiave API valida e non scaduta. |
| 401 | INVALID_CREDENTIAL | L’header Authorization non è valido oppure è in conflitto con x-api-key. |
| 401 | MISSING_CREDENTIAL | Non è stata fornita alcuna credenziale utilizzabile negli header, oppure la credenziale superava 4096 caratteri. |
| 401 | UNAUTHORIZED | La sessione di caricamento appartiene a un altro utente. |
| 401 | USER_NOT_FOUND | L’account associato alla credenziale non esiste più. |
| 403 | ACCOUNT_UNAVAILABLE | L’account che esegue l’azione o quello di fatturazione non è disponibile o è in fase di eliminazione. |
| 403 | AMBIGUOUS_TEAM_API_KEY | L’utente della credenziale appartiene a più di un team, quindi il contesto di fatturazione è ambiguo. |
| 403 | INSUFFICIENT_SCOPE | Concedi tutte le autorizzazioni richieste o scegli un’altra credenziale. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Impossibile verificare i limiti di integrazione dell’account. |
| 403 | SUBSCRIPTION_REQUIRED | Usa un abbonamento a pagamento attivo. |
| 403 | TEAM_OWNER_NOT_FOUND | Non è stato possibile trovare l’account effettivo del proprietario del team. |
| 404 | NOT_FOUND | La sessione di caricamento è sconosciuta, scaduta, completata o interrotta. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | Questo account ha già 10 azioni di integrazione in esecuzione. Interroga una richiesta esistente prima di avviarne un’altra. |
| 409 | IDEMPOTENCY_CONFLICT | L’identificatore della richiesta è già stato utilizzato con argomenti diversi; una mancata corrispondenza tra l’identificatore nell’header e quello nel corpo restituisce HTTP 400 con lo stesso codice. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Attendi il ripristino mensile o cambia piano. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Rispetta Retry-After quando presente e applica attese crescenti tra i tentativi. |
| 500 | INTERNAL_ERROR | Controlla lo stato della richiesta salvata e la cronologia delle risorse prima di decidere se ripetere una modifica. |
| 503 | ACTION_RESULT_UNAVAILABLE | L’azione è stata eseguita ma non è stato possibile salvarne il risultato. Esamina lo stato della richiesta salvata e la cronologia delle risorse prima di avviare una nuova generazione. |
| 503 | INTERNAL_ERROR | Impossibile leggere la sessione di caricamento attiva. Riprova con lo stesso identificatore della modifica e controlla lo stato registrato. |
| 503 | SERVER_RESTARTING | Il server si sta riavviando. Riprova tra poco e mantieni lo stesso identificatore della richiesta per una modifica. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["images:write"]
}
}
Questa pagina è stata utile?

