Status einer Aktionsanfrage abrufen

POST https://api.voicecheap.ai/v1/actions/action_request_get

​

Authentifizierung und Berechtigungen

​

Parameter

{
  "type": "object",
  "properties": {
    "requestId": {
      "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})$"
    },
    "operation": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[a-z][a-z0-9_]+$"
    }
  },
  "required": ["requestId", "operation"],
  "additionalProperties": false
}

​

Anfragebeispiele

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":"284a861a-4da8-4d67-ad48-8123e76c8e91","operation":"images_generate"}'

const input = {
  requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
  operation: 'images_generate',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/action_request_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/action_request_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "images_generate"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

​

Antwort

{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "images_generate",
    "status": "running",
    "createdAt": 1792152000000,
    "updatedAt": 1792152005000,
    "pollAfterSeconds": 5
  }
}

​

Abgeschlossene Anfrage mit gespeichertem Ergebnis

{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "images_generate",
    "createdAt": 1792152000000,
    "updatedAt": 1792152005000,
    "status": "completed",
    "resultStored": true,
    "result": {
      "generationId": "example-generation",
      "status": "completed"
    }
  }
}

​

Abgeschlossene Anfrage zur Segmentbearbeitung

{
  "data": {
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
    "operation": "segments_text_update",
    "createdAt": 1792152000000,
    "updatedAt": 1792152005000,
    "status": "completed",
    "resultStored": true,
    "result": {
      "status": "queued",
      "jobId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "queue": {
        "projectId": "project_launch_2026",
        "revision": 1,
        "items": [
          {
            "id": "41321bda-e243-4b6f-96a4-622cd047c991",
            "action": {
              "type": "text",
              "segmentIndex": 0,
              "source": "original"
            },
            "status": "queued",
            "createdAt": 1792152000000
          }
        ]
      }
    }
  }
}

​

Abgeschlossene Anfrage ohne gespeichertes Ergebnis

{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "images_generate",
    "createdAt": 1792152000000,
    "updatedAt": 1792152005000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  }
}

​

Fehlgeschlagene gespeicherte Anfrage

{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "images_generate",
    "createdAt": 1792152000000,
    "updatedAt": 1792152005000,
    "status": "failed",
    "error": {
      "code": "IMAGE_PROMPT_INVALID",
      "message": "The image prompt is invalid. Check its length and try again.",
      "status": 400,
      "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
    }
  }
}

​

Unterbrochene gespeicherte Anfrage

{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "images_generate",
    "createdAt": 1792152000000,
    "updatedAt": 1792152005000,
    "status": "interrupted",
    "message": "Execution was interrupted. Check the resource history before starting a new generation. This request will not be replayed automatically."
  }
}

​

Hinweise zur Operation

• Rufen Sie dies als POST /v1/actions/action_request_get mit einem API-Schlüssel auf oder verwenden Sie das MCP-Tool action_request_get. Es gibt keinen Endpunkt GET /v1/requests.
• Beide Eingabefelder sind erforderlich. requestId muss eine UUID v4 sein; operation ist der exakte ursprüngliche Aktionsname mit 1–100 Zeichen, passend zu ^[a-z][a-z0-9_]+$. Zusätzliche Felder werden abgelehnt.
• Die Zugangsdaten müssen aktuell jede primäre und zusätzliche Berechtigung besitzen, die von der ursprünglichen Aktion verlangt wird. Der ursprüngliche Akteur und der aktuelle persönliche bzw. Team-Eigentumskontext müssen mit der gespeicherten Anfrage übereinstimmen.
• Nur verändernde Aktionen haben einen gespeicherten Anfragestatus. Namen schreibgeschützter Aktionen geben ACTION_REQUEST_NOT_FOUND zurück; ein unbekannter Vorgang gibt UNKNOWN_ACTION zurück.
• REST gibt HTTP 202 zurück, solange data.status running ist, und HTTP 200 für die Anfragestatus completed, failed oder interrupted. Ein gespeicherter failed-Status wird mitsamt seinem Fehler als Daten zurückgegeben; diese Abfrageaktion wirft den Fehler nicht erneut.
• Die Statuswerte sind running, completed, failed und interrupted. Eine laufende Anfrage wird als interrupted gemeldet, wenn ihre Ausführungslease abgelaufen ist; sie wird nicht automatisch neu gestartet.
• Abgeschlossene Ausgaben werden nur aufbewahrt, wenn keine geheimnisähnlichen Ergebnisschlüssel vorhanden sind und das serialisierte Ergebnis höchstens 256 KiB groß ist. resultStored: false bedeutet nicht, dass die Aktion fehlgeschlagen ist; verwenden Sie ihre history-, get- oder download-Aktion.
• Wiederholte Statusabfragen verbrauchen keinen monatlichen Integrationsaufruf und bleiben nach Ausschöpfung des monatlichen Kontingents verfügbar. Authentifizierung, Anforderungen an kostenpflichtige Tarife und gemeinsame Ratenbegrenzungen gelten weiterhin.
• Fügen Sie für Statusabfragen keinen neuen Idempotenzschlüssel hinzu; requestId kennzeichnet die ursprüngliche Mutation. Ein reiner Leseaufruf gibt keine separate äußere requestId zurück.
• Eine abgeschlossene Aktion kann einen Medienverarbeitungsauftrag statt fertiger Medien zurückgeben. Fahren Sie mit der entsprechenden Status- oder Verlaufsaktion des jeweiligen Bereichs fort, wenn das zurückgegebene Ergebnis auf laufende Arbeit hinweist.
• webhooks_create_secret ist nur über REST verfügbar und wird nicht in der MCP-Tool-Erkennung aufgeführt. Ein Aufruf oder eine Statusabfrage über MCP gibt den Tool-Fehler ACTION_NOT_AVAILABLE_IN_MCP zurück. Signaturschlüssel werden nicht an Assistenten gesendet.
• Gespeicherte Ergebnisse und Wiederholungen verwenden dieselben öffentlichen Antwortfelder wie ein neues Aktionsergebnis. Fehler fehlgeschlagener Anfragen enthalten code, message, status und optional requestId mit festen VoiceCheap-Meldungen. Nicht klassifizierte gespeicherte Fehler verwenden bei status ab 500 INTERNAL_ERROR, sonst ACTION_FAILED.

​

Nutzung

​

Fehler

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": []
  }
}