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
}
}
Afbeeldingen
Een afbeeldingsgeneratie ophalen
Haal de status, afmetingen en vervaldatum op van een afbeelding die door het verbonden account is gegenereerd.
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
}
}
Haal de status, afmetingen en vervaldatum op van een afbeelding die door het verbonden account is gegenereerd.
Vereiste machtigingen:
POST https://api.voicecheap.ai/v1/actions/images_get
Authenticatie en machtigingen
string
vereist
Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens
worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
images:read.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
Parameters
string
vereist
Generatie-ID geretourneerd door een generatie- of geschiedenisactie.Patroon:
^[A-Za-z0-9_-]{1,128}$.Volledig invoerschema
Volledig invoerschema
Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.
{
"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
}
Voorbeeldaanvragen
Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.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)
Antwoord
Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. De openbare metadata van de app-afbeelding die je bezit, inclusief de huidige status, afmetingen en vervaltijdstip. De afbeeldingsgegevens worden afzonderlijk opgehaald.{
"data": {
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
}
Resultaatvelden
| Veld | Beschrijving |
|---|---|
data.generationId | ID die je ongewijzigd moet doorgeven aan images_get of images_download. |
data.status | pending, completed, failed of expired. De vervaltijd heeft voorrang op de opgeslagen status. |
data.aspectRatio | square, landscape of portrait. |
data.width | Uitvoerbreedte in pixels, of null voordat afmetingen beschikbaar zijn. |
data.height | Hoogte van de uitvoer in pixels, of null zolang de afmetingen niet beschikbaar zijn. |
data.referenceImageCount | Aantal gebruikte referentieafbeeldingen: 0 of 1. |
data.createdAt | Aanmaaktijdstip in Unix-milliseconden. |
data.updatedAt | Tijdstip van de laatste update in Unix-milliseconden. |
data.expiresAt | Tijdstip in Unix-milliseconden waarna de gegenereerde afbeelding niet meer kan worden gedownload. |
Opmerkingen bij de bewerking
- Vereist images:read. generationId moet 1–128 ASCII-letters, cijfers, underscores of koppeltekens bevatten.
- Deze actie gebruikt de eigen creaties en uploads van de gekoppelde gebruiker, ook wanneer het toegangsmiddel in een teamcontext is gekoppeld.
- Het record kan pending, completed, failed of expired vermelden. Breedte en hoogte zijn null als ze niet beschikbaar zijn. Een record kan als expired zichtbaar blijven totdat het wordt opgeruimd; een geslaagde get garandeert niet dat downloaden beschikbaar is.
- Gebruik images_download voor PNG-bytes vóór expiresAt. Deze actie retourneert geen previewDataUrl of media-URL.
Verbruik
Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.Fouten
| HTTP-status | Code | Betekenis of herstel |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Inloggegevens zijn opgegeven in een queryparameter access_token of api_key. Stuur inloggegevens in headers. |
| 400 | VALIDATION_ERROR | Een argument ontbreekt, heeft een niet-ondersteunde waarde, overschrijdt de limiet of maakt geen deel uit van het strikte invoerschema. |
| 401 | API_KEY_EXPIRED | De API-sleutel is verlopen. |
| 401 | INVALID_API_KEY | Geef een geldige, niet-verlopen API-sleutel op. |
| 401 | INVALID_CREDENTIAL | De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key. |
| 401 | MISSING_CREDENTIAL | Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens. |
| 401 | USER_NOT_FOUND | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. |
| 403 | AMBIGUOUS_TEAM_API_KEY | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. |
| 403 | INSUFFICIENT_SCOPE | Verleen alle vereiste machtigingen of kies andere toegangsgegevens. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | De integratielimieten van het account konden niet worden geverifieerd. |
| 403 | SUBSCRIPTION_REQUIRED | Gebruik een actief betaald abonnement. |
| 403 | TEAM_OWNER_NOT_FOUND | Het effectieve account van de teameigenaar kon niet worden gevonden. |
| 404 | IMAGE_NOT_FOUND | De generatie bestaat niet, is van een andere gebruiker of is geen app-afbeelding. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Wacht tot de maandelijkse reset of wijzig je abonnement. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen. |
| 500 | INTERNAL_ERROR | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. |
| 503 | SERVER_RESTARTING | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["images:read"]
}
}
Was deze pagina nuttig?

