Get action request status

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

​

Authentication and permissions

​

Parameters

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

​

Request examples

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)

​

Response

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

​

Completed request with a saved result

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

​

Completed segment edit request

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

​

Completed request without a retained result

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

​

Failed saved request

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

​

Interrupted saved request

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

​

Operation notes

• Invoke this as POST /v1/actions/action_request_get with an API key, or call the action_request_get MCP tool. There is no GET /v1/requests endpoint.
• Both input fields are required. requestId must be a UUID v4; operation is the exact original action name, 1–100 characters, matching ^[a-z][a-z0-9_]+$. Extra fields are rejected.
• The credential must currently have every primary and additional permission required by the original action. The originating actor and current personal/team ownership context must match the saved request.
• Only mutating actions have saved request state. Read-only action names return ACTION_REQUEST_NOT_FOUND; an unknown operation returns UNKNOWN_ACTION.
• REST returns HTTP 202 while data.status is running and HTTP 200 for completed, failed, or interrupted request states. A saved failed state is returned as data with its error, not rethrown by this polling action.
• Status values are running, completed, failed, and interrupted. A running request is reported as interrupted when its execution lease has expired; it is not automatically restarted.
• Completed outputs are retained only when no secret-like result keys are present and the serialized result is at most 256 KiB. resultStored: false does not mean the action failed; use its history, get, or download action.
• Polling consumes no monthly integration call and remains available after the monthly allowance is exhausted. Authentication, paid-plan requirements, and shared rate limits still apply.
• Do not add a new idempotency key for polling; requestId identifies the original mutation. A read-only call does not return a separate outer requestId.
• A completed action can return a media-processing job rather than finished media. Continue with the relevant domain status/history action when the returned result identifies ongoing work.
• webhooks_create_secret is REST-only. It is excluded from MCP discovery; calling it or polling it through MCP returns the tool error ACTION_NOT_AVAILABLE_IN_MCP. Signing secrets are not sent to assistants.
• Saved results and replays follow the same public response fields as a fresh action result. Failed request errors contain code, message, status and optional requestId, with fixed VoiceCheap messages. Unclassified saved failures use INTERNAL_ERROR for status 500 or above, and ACTION_FAILED otherwise.

​

Usage

​

Errors

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