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"
}
Afbeeldingen
Een upload van een referentieafbeelding starten
Bereid een upload van een JPG-, PNG- of WebP-referentie tot 8 MiB voor. Gebruik images_upload_sign_parts om PUT-URL’s op te halen, upload de bytes, roep vervolgens images_upload_complete aan en gebruik de bijbehorende fileKey bij het genereren.
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"
}
Bereid een upload van een JPG-, PNG- of WebP-referentie tot 8 MiB voor. Gebruik images_upload_sign_parts om PUT-URL’s op te halen, upload de bytes, roep vervolgens images_upload_complete aan en gebruik de bijbehorende fileKey bij het genereren.
Vereiste machtigingen:
POST https://api.voicecheap.ai/v1/actions/images_upload_initialize
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 bestandsnaam van de afbeelding, met een extensie die overeenkomt met contentType.Minimale lengte: 1. Maximale lengte: 250. Patroon:
\.(?:jpe?g|png|webp)$.string
vereist
Tekstwaarde.Toegestane waarden: “image/jpeg”, “image/png”, “image/webp”.
integer
vereist
Exacte bestandsgrootte in bytes, tot 8 MiB.Minimum: 1. Maximum: 8388608.
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}$"
},
"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
}
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_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)
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. Een nieuwe meerdelige uploadsessie voor afbeeldingsreferenties, de toekomstige objectsleutel, de deelgrootte in bytes en het maximale aantal parallelle uploads. Dit uploadt geen afbeeldingsbytes en maakt key niet gereed voor generatie.{
"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"
}
Resultaatvelden
| Veld | Beschrijving |
|---|---|
data.uploadId | UUID die de actieve uploadsessie identificeert. Geef deze door aan de overige uploadacties. |
data.key | Toekomstige objectsleutel waarvan je eigenaar bent. Gebruik fileKey van een geslaagde voltooiing als generatiereferentie. |
data.partSize | Vereiste deelgrootte in bytes; het laatste deel bevat de resterende bytes. |
data.maxConcurrency | Aanbevolen maximumaantal gelijktijdige deeluploads: 4. |
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":"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
}
}
}
Opmerkingen bij de bewerking
- Vereist images:write; er is geen extra uploadscope nodig.
- Witruimte aan het begin en einde van filename wordt verwijderd. De waarde moet 1–250 tekens bevatten en eindigen op .jpg, .jpeg, .png of .webp. De extensie moet overeenkomen met contentType: image/jpeg, image/png of image/webp. fileSize is het exacte gehele aantal bytes, van 1 tot 8,388,608.
- De gedeelde uploadimplementatie retourneert partSize 5 MiB (5,242,880 bytes) voor deze referenties. Een bestand van maximaal 5 MiB gebruikt één onderdeel; een groter bestand tot 8 MiB gebruikt er twee. Vraag PUT-URL’s aan met images_upload_sign_parts, upload de bytes en roep daarna images_upload_complete aan.
- Gebruik de fileKey die bij voltooiing is geretourneerd als referenceImageKey in images_generate. Het initialize-resultaat gebruikt key, niet fileKey. Geef key niet door aan generatie voordat de voltooiing is afgerond.
- 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.
- Deze actie gebruikt de eigen creaties en uploads van de gekoppelde gebruiker, ook wanneer het toegangsmiddel in een teamcontext is gekoppeld.
- 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.
- De bestandsnaam in de objectsleutel wordt opgeschoond en kan worden ingekort. Bewaar de exact geretourneerde key en uploadId; stel deze niet zelf samen. Afbeeldingsbytes worden tijdens de generatie gevalideerd, naast de gedeclareerde grootte en het type tijdens de upload.
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 | 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 | REFERENCE_IMAGE_INVALID | De bestandsextensie komt niet overeen met het opgegeven contentType van de afbeelding. |
| 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 | 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. |
| 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 uploadsessie kon niet worden aangemaakt of opgeslagen. Probeer het opnieuw met dezelfde mutatie-ID en controleer de vastgelegde status. |
| 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?

