Ottieni lo stato di una richiesta di azione

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

​

Autenticazione e autorizzazioni

​

Parametri

{
  "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
}

​

Esempi di richiesta

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)

​

Risposta

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

​

Richiesta completata con risultato salvato

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

​

Richiesta di modifica del segmento completata

{
  "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
          }
        ]
      }
    }
  }
}

​

Richiesta completata senza risultato conservato

{
  "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."
  }
}

​

Richiesta salvata non riuscita

{
  "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"
    }
  }
}

​

Richiesta salvata interrotta

{
  "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."
  }
}

​

Note sull’operazione

• Invoca questa azione come POST /v1/actions/action_request_get con una chiave API oppure chiama lo strumento MCP action_request_get. Non esiste un endpoint GET /v1/requests.
• Entrambi i campi di input sono obbligatori. requestId deve essere un UUID v4; operation è il nome esatto dell’azione originale, di 1–100 caratteri, conforme a ^[a-z][a-z0-9_]+$. I campi aggiuntivi vengono rifiutati.
• La credenziale deve disporre attualmente di tutte le autorizzazioni principali e aggiuntive richieste dall’azione originale. L’utente chiamante originario e il contesto corrente di proprietà personale o del team devono corrispondere alla richiesta salvata.
• Solo le azioni che apportano modifiche hanno uno stato della richiesta salvato. I nomi delle azioni di sola lettura restituiscono ACTION_REQUEST_NOT_FOUND; un’operazione sconosciuta restituisce UNKNOWN_ACTION.
• REST restituisce HTTP 202 mentre data.status è running e HTTP 200 per gli stati della richiesta completed, failed o interrupted. Uno stato failed salvato viene restituito come data con il relativo errore, senza che questa azione di polling lo rilanci.
• I valori di stato sono running, completed, failed e interrupted. Una richiesta in stato running viene segnalata come interrupted quando la sua concessione temporanea di esecuzione è scaduta; non viene riavviata automaticamente.
• Gli output completati vengono conservati solo quando non sono presenti chiavi del risultato che sembrano contenere segreti e il risultato serializzato non supera 256 KiB. resultStored: false non significa che l’azione sia fallita; usa la relativa azione history, get o download.
• Le interrogazioni periodiche non consumano chiamate di integrazione mensili e rimangono disponibili dopo l’esaurimento della quota mensile. Restano applicabili l’autenticazione, i requisiti del piano a pagamento e i limiti di frequenza condivisi.
• Non aggiungere una nuova chiave di idempotenza per il polling; requestId identifica la modifica originale. Una chiamata in sola lettura non restituisce un requestId esterno separato.
• Un’azione completata può restituire un job di elaborazione multimediale invece di contenuti multimediali pronti. Prosegui con l’azione di stato o cronologia del dominio pertinente quando il risultato restituito indica un’elaborazione in corso.
• webhooks_create_secret è disponibile solo tramite REST ed è escluso dalla discovery MCP. L’esecuzione o il polling tramite MCP restituisce l’errore dello strumento ACTION_NOT_AVAILABLE_IN_MCP. I segreti di firma non vengono inviati agli assistenti.
• I risultati salvati e le ripetizioni usano gli stessi campi di risposta pubblici di un nuovo risultato dell’azione. Gli errori delle richieste fallite contengono code, message, status e requestId facoltativo, con messaggi fissi di VoiceCheap. Gli errori salvati non classificati usano INTERNAL_ERROR per status pari o superiore a 500 e ACTION_FAILED negli altri casi.

​

Utilizzo

​

Errori

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