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
}
}
Immagini
Ottieni una generazione di immagine
Ottieni stato, dimensioni e scadenza di un’immagine generata dall’account connesso.
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
}
}
Ottieni stato, dimensioni e scadenza di un’immagine generata dall’account connesso.
Autorizzazioni richieste:
POST https://api.voicecheap.ai/v1/actions/images_get
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:read.
È 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
obbligatorio
ID di generazione restituito da un’azione di generazione o della cronologia.Pattern:
^[A-Za-z0-9_-]{1,128}$.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": {
"generationId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,128}$",
"description": "Generation ID returned by a generation or history action."
}
},
"required": ["generationId"],
"additionalProperties": false
}
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_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)
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. I metadati pubblici dell’immagine dell’app di proprietà dell’utente, inclusi stato corrente, dimensioni e scadenza. I dati dell’immagine vengono recuperati separatamente.{
"data": {
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
}
Campi del risultato
| Campo | Descrizione |
|---|---|
data.generationId | Identificatore da passare invariato a images_get o images_download. |
data.status | pending, completed, failed o expired. La scadenza ha la precedenza sullo stato memorizzato. |
data.aspectRatio | square, landscape o portrait. |
data.width | Larghezza dell’output in pixel, oppure null finché le dimensioni non sono disponibili. |
data.height | Altezza dell’output in pixel, oppure null finché le dimensioni non sono disponibili. |
data.referenceImageCount | Numero di immagini di riferimento utilizzate: 0 o 1. |
data.createdAt | Ora di creazione in millisecondi Unix. |
data.updatedAt | Ora dell’ultimo aggiornamento in millisecondi Unix. |
data.expiresAt | Istante in millisecondi Unix dopo il quale l’immagine generata non può più essere scaricata. |
Note sull’operazione
- Richiede images:read. generationId deve contenere 1–128 lettere ASCII, cifre, trattini bassi o trattini.
- Questa azione usa le creazioni e i caricamenti di proprietà dell’utente connesso, anche quando la credenziale è connessa nel contesto di un team.
- Il record può riportare pending, completed, failed o expired. Larghezza e altezza sono null quando non sono disponibili. Un record può rimanere visibile come expired finché la pulizia non lo rimuove; un get riuscito non garantisce la disponibilità del download.
- Usa images_download per i byte PNG prima di expiresAt. Questa azione non restituisce previewDataUrl o un URL multimediale.
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 | CREDENTIAL_IN_QUERY | Le credenziali sono state fornite in un parametro di query access_token o api_key. Invia le credenziali negli header. |
| 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 | USER_NOT_FOUND | L’account associato alla credenziale non esiste più. |
| 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 | IMAGE_NOT_FOUND | La generazione non esiste, appartiene a un altro utente oppure non è un’immagine dell’app. |
| 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 | 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:read"]
}
}
Questa pagina è stata utile?