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"
}
Afbeeldingen
Een upload van een referentieafbeelding voltooien
Voltooi een upload van een referentieafbeelding waarvan je eigenaar bent met de onderdeelnummers en ETags uit de PUT-aanvragen. Controleert de opgeslagen bestandsgrootte. Gebruik de geretourneerde fileKey als generatiereferentie.
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"
}
Voltooi een upload van een referentieafbeelding waarvan je eigenaar bent met de onderdeelnummers en ETags uit de PUT-aanvragen. Controleert de opgeslagen bestandsgrootte. Gebruik de geretourneerde fileKey als generatiereferentie.
Vereiste machtigingen:
POST https://api.voicecheap.ai/v1/actions/images_upload_complete
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:write.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
Parameters
string
Optioneel op transportniveau: als de identificatie ontbreekt, voegt de server deze vóór de validatie toe. Geef zelf een stabiele UUID v4 op om veilig te kunnen herstellen als een antwoord verloren gaat.Formaat: “uuid”. Patroon:
^[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
vereist
De uploadId die de upload_initialize-actie van dit domein retourneert.Formaat: “uuid”. Patroon:
^([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
vereist
Lijst met waarden. Zie het volledige invoerschema voor de structuur van de items.Minimaal aantal items: 1. Maximaal aantal items: 2.
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": {
"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
}
Idempotentie
Gebruik voor elke wijziging een UUID v4 in requestId of de HTTP-header Idempotency-Key. Gebruik na een netwerkfout dezelfde identificatie en identieke argumenten opnieuw. Als je beide opgeeft, moeten ze overeenkomen. Het opnieuw versturen van een opgeslagen aanvraag herhaalt de bewerking niet en verbruikt geen extra maandelijkse aanroep. Mislukte of onderbroken aanvragen worden niet automatisch opnieuw gestart. Elke wijziging kan HTTP 202 retourneren wanneer een nieuwe poging vaststelt dat dezelfde aanvraag nog loopt, ook wanneer de eerste uitvoering normaal synchroon is. Als de uitvoering is voltooid maar resultStored false is, retourneert een nieuwe poging HTTP 200 met de opgeslagen aanvraagstatus in plaats van het oorspronkelijke resultaat. Haal de uitvoer op via de geschiedenis-, resultaat- of downloadactie van het betreffende domein.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_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)
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 voltooide referentiesleutel die je bezit en de bijbehorende lees-URL, die alleen worden geretourneerd nadat de opgeslagen lengte in bytes exact overeenkomt met de opgegeven bestandsgrootte. Gebruik fileKey, niet readUrl, in de generatieargumenten.{
"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"
}
Resultaatvelden
| Veld | Beschrijving |
|---|---|
data.fileKey | Voltooide eigen objectsleutel om als generatiereferentie te gebruiken. |
data.readUrl | Lees-URL voor het geüploade referentieobject. Generatieacties accepteren fileKey, niet deze URL. |
Deze aanvraag herstellen en controleren
Gebruik dezelfde identificatie, ook nadat de verbinding is verbroken. Als resultStored false is, haal je de uitvoer op via de bijbehorende geschiedenis-, resultaat- of downloadactie. Start nooit een tweede generatie alleen om de voortgang te controleren.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"
}
}
}
Opmerkingen bij de bewerking
- Vereist images:write; er is geen extra uploadscope nodig.
- uploadId is de UUID uit initialize. parts bevat exact de 1–2 delen die de sessie vereist. Elk deel heeft een gehele partNumber van 1 tot 2 en een etag-string van 1–256 tekens uit het bijbehorende geslaagde PUT-antwoord.
- Alle deelnummers moeten aanwezig en uniek zijn. De delen worden vóór voltooiing gesorteerd; ETags worden genormaliseerd naar waarden tussen aanhalingstekens. Je kunt de ETag-aanhalingstekens behouden die de opslag retourneert.
- De werkelijke bytelengte van het voltooide object wordt gecontroleerd aan de hand van fileSize en de limiet van 8 MiB. Als de lengte ontbreekt, afwijkt of te groot is, worden het object en de actieve sessie verwijderd en wordt UPLOAD_SIZE_MISMATCH geretourneerd.
- Geef fileKey door als referenceImageKey in images_generate. Voltooide referentiebestanden kunnen worden hergebruikt voor volgende afbeeldings- of miniatuurgeneraties van dezelfde gebruiker; generatie verbruikt de referentie niet.
- Alleen een upload van de verbonden gebruiker kan worden ondertekend, voltooid of afgebroken. Deze aliassen accepteren alleen JPG-, PNG- en WebP-sessies van maximaal 8 MiB, zelfs als de sessie via een andere uploadfamilie is aangemaakt.
- De uploadsessie in productie verloopt na 24 uur. Ondertekende deel-URL’s verlopen na één uur. Voltooien en afbreken verwijderen de actieve sessie; sign-parts en complete retourneren daarna Upload not found. Geen van beide responsen bevat een expiresAt-veld.
- Gebruik een UUID v4 als requestId of de HTTP-header Idempotency-Key en hergebruik deze met identieke invoer wanneer je opnieuw probeert. De integratielaag legt elke wijziging vast en retourneert de vastgelegde status of het resultaat zonder deze opnieuw uit te voeren. Een mislukte of onderbroken aanvraag wordt niet automatisch opnieuw geprobeerd.
- Voltooiing sluit de multipart-sessie. Probeer de voltooiing opnieuw met de oorspronkelijke requestId om het vastgelegde resultaat op te halen; een nieuwe voltooiingsaanvraag voor die gesloten uploadId retourneert Upload not found. Deze actie retourneert geen vervaltijdstip voor het bewaren van de referentie.
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 | BAD_REQUEST | De lijst voor voltooiing bevat ontbrekende, dubbele of ongeldige deelnummers. |
| 400 | CREDENTIAL_IN_QUERY | Inloggegevens zijn opgegeven in een queryparameter access_token of api_key. Stuur inloggegevens in headers. |
| 400 | IDEMPOTENCY_CONFLICT | De header Idempotency-Key en het bodyveld requestId moeten overeenkomen. |
| 400 | INVALID_REQUEST_ID | requestId of Idempotency-Key is geen UUID v4. |
| 400 | UPLOAD_SIZE_MISMATCH | De opgeslagen grootte van het voltooide object is niet beschikbaar, wijkt af van fileSize of overschrijdt 8 MiB; het object en de sessie worden verwijderd. |
| 400 | UPLOAD_TYPE_NOT_ALLOWED | De uploadsessie heeft geen ondersteund afbeeldingstype of overschrijdt 8 MiB. |
| 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 | UNAUTHORIZED | De uploadsessie behoort tot een andere gebruiker. |
| 401 | USER_NOT_FOUND | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. |
| 403 | ACCOUNT_UNAVAILABLE | Het uitvoerende of factureringsaccount is niet beschikbaar of wordt verwijderd. |
| 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 | NOT_FOUND | De uploadsessie is onbekend, verlopen, al voltooid of afgebroken. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | Voor dit account worden al 10 integratieacties uitgevoerd. Controleer een bestaande aanvraag voordat je een nieuwe start. |
| 409 | IDEMPOTENCY_CONFLICT | De aanvraag-ID is al gebruikt met andere argumenten; een verschil tussen de ID in de header en die in de body retourneert HTTP 400 met dezelfde code. |
| 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 | ACTION_RESULT_UNAVAILABLE | De actie is uitgevoerd, maar het resultaat kon niet worden opgeslagen. Controleer de opgeslagen aanvraagstatus en resourcegeschiedenis voordat je een nieuwe generatie start. |
| 503 | INTERNAL_ERROR | De actieve uploadsessie kon niet worden gelezen. Controleer de aanvraagstatus voordat je de voltooiing opnieuw probeert. |
| 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:write"]
}
}
Was deze pagina nuttig?