curl --request POST 'https://api.voicecheap.ai/v1/actions/images_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":20}'
const input = {
limit: 20,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 20},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"items": [
{
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
],
"nextCursor": null
}
}
Bilder
Generierte Bilder auflisten
Listen Sie die generierten Bilder des verbundenen Kontos auf, die neuesten zuerst. Enthält Status, Abmessungen und Ablaufzeit; verwenden Sie nextCursor für die nächste Seite.
POST
/
v1
/
actions
/
images_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":20}'
const input = {
limit: 20,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 20},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"items": [
{
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
],
"nextCursor": null
}
}
Listen Sie die generierten Bilder des verbundenen Kontos auf, die neuesten zuerst. Enthält Status, Abmessungen und Ablaufzeit; verwenden Sie nextCursor für die nächste Seite.
Erforderliche Berechtigungen:
POST https://api.voicecheap.ai/v1/actions/images_list
Authentifizierung und Berechtigungen
string
erforderlich
Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt.
OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.
images:read.
Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.
Parameter
integer
Ganzzahliger Wert.Minimum: 1. Maximum: 100. Standardwert: 20.
string
Der nextCursor der vorherigen Seite.Mindestlänge: 1. Höchstlänge: 512.
Vollständiges Eingabeschema
Vollständiges Eingabeschema
Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.
{
"type": "object",
"properties": {
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"cursor": {
"description": "The nextCursor from the previous page.",
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"additionalProperties": false
}
Anfragebeispiele
Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.curl --request POST 'https://api.voicecheap.ai/v1/actions/images_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":20}'
const input = {
limit: 20,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 20},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Antwort
Eine erfolgreiche erste Ausführung gibt HTTP 200 mit dem Ergebnis der Operation unter data zurück. Bei einer Wiederholung kann stattdessen der gespeicherte Anfragestatus zurückgegeben werden. Das Beispiel zeigt eine unterstützte Antwort, nicht alle optionalen Felder. Eine Seite der Metadaten der in der App generierten Bilder des verbundenen Benutzers, neueste zuerst. Ein leerer Verlauf gibt items: [] und nextCursor: null zurück.{
"data": {
"items": [
{
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
],
"nextCursor": null
}
}
Ergebnisfelder
| Feld | Beschreibung |
|---|---|
data.items | Array mit Bildmetadatenobjekten. |
data.items[].generationId | Kennung, die unverändert an images_get oder images_download übergeben wird. |
data.items[].status | pending, completed, failed oder expired. Der Ablauf hat Vorrang vor dem gespeicherten Status. |
data.items[].aspectRatio | square, landscape oder portrait. |
data.items[].width | Ausgabebreite in Pixeln oder null, bevor die Abmessungen verfügbar sind. |
data.items[].height | Ausgabehöhe in Pixeln oder null, solange keine Abmessungen verfügbar sind. |
data.items[].referenceImageCount | Anzahl der verwendeten Referenzbilder: 0 oder 1. |
data.items[].createdAt | Erstellungszeit in Unix-Millisekunden. |
data.items[].updatedAt | Zeitpunkt der letzten Aktualisierung in Unix-Millisekunden. |
data.items[].expiresAt | Zeitpunkt in Unix-Millisekunden, nach dem das generierte Bild nicht mehr heruntergeladen werden kann. |
data.nextCursor | Opaker Cursor für die nächste Seite oder null, wenn keine weitere Seite verfügbar ist. |
Hinweise zur Operation
- Erfordert images:read. limit ist standardmäßig 20 und muss eine Ganzzahl von 1 bis 100 sein. cursor ist optional und auf 512 Zeichen begrenzt.
- Übergeben Sie nextCursor unverändert als cursor für die nächste Seite. Am Ende ist nextCursor null; die Sortierung erfolgt absteigend nach Erstellungszeitpunkt und Generierungskennung.
- Diese Aktion verwendet die eigenen Erstellungen und Uploads des verbundenen Nutzers, auch wenn die Zugangsdaten im Teamkontext verbunden sind.
- Datensätze zeigen den Status pending, completed, failed oder expired. Bei unvollständigen oder fehlgeschlagenen Generierungen können die Abmessungen null sein. Die Metadaten können expired melden, bevor die Bereinigung einen Datensatz entfernt; dadurch wird das Bild nicht herunterladbar.
- Nur von der App generierte Bilder gehören zu diesem Verlauf. Verwenden Sie images_download für die Bilddaten; Verläufe betten weder Bildbytes noch Vorschau-URLs ein.
Nutzung
Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.Fehler
| HTTP-Status | Code | Bedeutung oder Behebung |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Zugangsdaten wurden in einem Abfrageparameter namens access_token oder api_key übergeben. Senden Sie Zugangsdaten in Headern. |
| 400 | INVALID_CURSOR | cursor ist kein gültiger Verlaufscursor; verwenden Sie den von der vorherigen Seite zurückgegebenen nextCursor. |
| 400 | VALIDATION_ERROR | Ein Argument fehlt, hat einen nicht unterstützten Wert, überschreitet seinen Grenzwert oder ist nicht Teil des strikten Eingabeschemas. |
| 401 | API_KEY_EXPIRED | Der API-Schlüssel ist abgelaufen. |
| 401 | INVALID_API_KEY | Geben Sie einen gültigen, nicht abgelaufenen API-Schlüssel an. |
| 401 | INVALID_CREDENTIAL | Der Authorization-Header ist fehlerhaft oder steht im Konflikt mit x-api-key. |
| 401 | MISSING_CREDENTIAL | Es wurde kein nutzbarer Berechtigungsnachweis im Header übergeben, oder er überschritt 4096 Zeichen. |
| 401 | USER_NOT_FOUND | Das Konto des Zugangsnachweises existiert nicht mehr. |
| 403 | AMBIGUOUS_TEAM_API_KEY | Der Benutzer des Berechtigungsnachweises gehört mehr als einem Team an, weshalb der Abrechnungskontext nicht eindeutig ist. |
| 403 | INSUFFICIENT_SCOPE | Erteilen Sie alle erforderlichen Berechtigungen oder verwenden Sie andere Zugangsdaten. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Die Integrationslimits des Kontos konnten nicht verifiziert werden. |
| 403 | SUBSCRIPTION_REQUIRED | Verwenden Sie ein aktives kostenpflichtiges Abonnement. |
| 403 | TEAM_OWNER_NOT_FOUND | Das maßgebliche Konto des Teaminhabers wurde nicht gefunden. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Warten Sie auf die monatliche Zurücksetzung oder wechseln Sie den Tarif. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Warten Sie gegebenenfalls die in Retry-After angegebene Zeit und verwenden Sie zunehmend längere Warteintervalle. |
| 500 | INTERNAL_ERROR | Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen. |
| 503 | SERVER_RESTARTING | Der Server wird neu gestartet. Versuchen Sie es in Kürze erneut und behalten Sie bei einer Mutation dieselbe Anfragekennung bei. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["images:read"]
}
}
War diese Seite hilfreich?

