Pobierz stan żądania akcji

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

​

Uwierzytelnianie i uprawnienia

​

Parametry

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

​

Przykłady żądań

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)

​

Odpowiedź

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

​

Zakończone żądanie z zapisanym wynikiem

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

​

Ukończone żądanie edycji segmentu

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

​

Zakończone żądanie bez zachowanego wyniku

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

​

Zapisane żądanie zakończone błędem

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

​

Przerwane zapisane żądanie

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

​

Uwagi do operacji

• Wywołaj jako POST /v1/actions/action_request_get z kluczem API lub wywołaj narzędzie MCP action_request_get. Punkt końcowy GET /v1/requests nie istnieje.
• Oba pola wejściowe są wymagane. requestId musi być UUID v4; operation to dokładna nazwa pierwotnej akcji o długości 1–100 znaków, pasująca do ^[a-z][a-z0-9_]+$. Dodatkowe pola są odrzucane.
• Dane uwierzytelniające muszą obecnie mieć wszystkie główne i dodatkowe uprawnienia wymagane przez oryginalną akcję. Podmiot inicjujący akcję oraz bieżący kontekst własności osobistej lub zespołowej muszą odpowiadać zapisanemu żądaniu.
• Tylko akcje modyfikujące dane mają zapisany stan żądania. Nazwy akcji tylko do odczytu zwracają ACTION_REQUEST_NOT_FOUND; nieznana operacja zwraca UNKNOWN_ACTION.
• REST zwraca HTTP 202, gdy data.status ma wartość running, oraz HTTP 200 dla stanów żądania completed, failed lub interrupted. Zapisany stan failed jest zwracany jako dane wraz z błędem, a nie zgłaszany ponownie jako wyjątek przez tę akcję sprawdzania stanu.
• Wartości statusu to running, completed, failed i interrupted. Żądanie w stanie running jest zgłaszane jako interrupted, gdy jego dzierżawa wykonania wygasła; nie jest automatycznie uruchamiane ponownie.
• Ukończone wyniki są przechowywane tylko wtedy, gdy nie zawierają kluczy wyniku sugerujących dane tajne, a zserializowany wynik nie przekracza 256 KiB. resultStored: false nie oznacza, że akcja się nie powiodła; użyj jej akcji history, get lub download.
• Sprawdzanie stanu nie zużywa miesięcznego wywołania integracji i pozostaje dostępne po wyczerpaniu miesięcznego limitu. Nadal obowiązują uwierzytelnianie, wymagania płatnego planu i współdzielone limity częstotliwości wywołań.
• Nie dodawaj nowego klucza idempotencji do sprawdzania stanu; requestId identyfikuje oryginalną operację modyfikującą. Wywołanie tylko do odczytu nie zwraca osobnego zewnętrznego requestId.
• Zakończona akcja może zwrócić zadanie przetwarzania multimediów zamiast gotowych multimediów. Jeśli zwrócony wynik wskazuje trwające przetwarzanie, kontynuuj za pomocą odpowiedniej akcji stanu lub historii dla danej domeny.
• webhooks_create_secret jest dostępne tylko przez REST i nie pojawia się w wykrywaniu MCP. Wywołanie lub odpytywanie przez MCP zwraca błąd narzędzia ACTION_NOT_AVAILABLE_IN_MCP. Sekrety podpisywania nie są wysyłane do asystentów.
• Zapisane wyniki i ponowienia używają tych samych publicznych pól odpowiedzi co nowy wynik działania. Błędy nieudanych żądań zawierają code, message, status i opcjonalnie requestId ze stałymi komunikatami VoiceCheap. Niesklasyfikowane zapisane błędy używają INTERNAL_ERROR dla status od 500 wzwyż, a w pozostałych przypadkach ACTION_FAILED.

​

Wykorzystanie

​

Błędy

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