> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel a thumbnail reference upload

> Cancel an unfinished image reference upload owned by the connected account.

Cancel an unfinished image reference upload owned by the connected account.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/thumbnails_upload_abort
```

## Authentication and permissions

<ParamField header="x-api-key" type="string" required>
  Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by
  MCP, not by this REST endpoint.
</ParamField>

Required permissions: `thumbnails:write`.

An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

## Parameters

<ParamField body="requestId" type="string">
  Optional at the transport boundary: the server injects an identifier before validation when omitted. Supply your own stable UUID v4 to recover safely from a lost response.

  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}$`.
</ParamField>

<ParamField body="uploadId" type="string" required>
  The uploadId returned by this domain’s upload\_initialize action.

  Format: "uuid". Pattern: `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`.
</ParamField>

<Accordion title="Complete input schema">
  The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "requestId": {
        "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
        "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}$"
      },
      "uploadId": {
        "type": "string",
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
        "description": "The uploadId returned by this domain’s upload_initialize action."
      }
    },
    "required": ["uploadId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Idempotency

Use a UUID v4 in requestId or the Idempotency-Key HTTP header for each mutation. Reuse the same identifier and identical arguments after a network failure. If both are supplied, they must match. Replaying a saved request does not repeat the operation or charge another monthly call. Failed or interrupted requests are not restarted automatically.

Every mutation can return HTTP 202 when a retry finds the same request still running, even when its first execution is normally synchronous. If execution completed but resultStored is false, a retry returns HTTP 200 with saved request state instead of the original result. Retrieve the output through its domain history, result, or download action.

## Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/thumbnails_upload_abort' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"requestId":"19ef3516-fafb-4c59-943d-09ecc8c89da8","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    requestId: '19ef3516-fafb-4c59-943d-09ecc8c89da8',
    uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/thumbnails_upload_abort', {
    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);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/thumbnails_upload_abort",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"requestId": "19ef3516-fafb-4c59-943d-09ecc8c89da8", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field.

success: true when the unfinished multipart upload was aborted, or when no active session exists for that uploadId.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "success": true
    },
    "requestId": "19ef3516-fafb-4c59-943d-09ecc8c89da8"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "19ef3516-fafb-4c59-943d-09ecc8c89da8",
      "operation": "thumbnails_upload_abort",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "19ef3516-fafb-4c59-943d-09ecc8c89da8"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "19ef3516-fafb-4c59-943d-09ecc8c89da8",
      "operation": "thumbnails_upload_abort",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "19ef3516-fafb-4c59-943d-09ecc8c89da8"
  }
  ```
</ResponseExample>

## Result fields

| Field | Description |
| - | - |
| `data.success` | Always true on a successful abort or when no active session exists. |

## Recover and poll this request

Use the same identifier even after a lost connection. If resultStored is false, retrieve the output through the corresponding history, result, or download action. Never start a second generation merely to check progress.

```bash theme={null}
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":"19ef3516-fafb-4c59-943d-09ecc8c89da8","operation":"thumbnails_upload_abort"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "19ef3516-fafb-4c59-943d-09ecc8c89da8",
    "operation": "thumbnails_upload_abort",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "success": true
    }
  }
}
```

## Operation notes

* Requires thumbnails:write; no additional upload scope is needed.
* uploadId must be a UUID. An active upload owned by the connected user is aborted and its session is removed. An unknown, expired, already aborted, or completed session returns success: true.
* This cancels an unfinished multipart upload. Once completion has removed its session, abort does not delete the completed reference file.
* Only an upload belonging to the connected user can be signed, completed, or aborted. These aliases accept only JPG, PNG, and WebP sessions of at most 8 MiB, even if the session was created through a different upload family.
* Use a UUID v4 requestId, or the HTTP Idempotency-Key header, and reuse it with identical inputs when retrying. The integration layer records each mutation and returns its recorded state or result without rerunning it. A failed or interrupted request is not automatically retried.
* Aborting a session owned by another user is denied while that session is active. This action does not return a file key or expiration time.

## Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply.

## Errors

| HTTP status | Code | Meaning or recovery |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. |
| 400 | `IDEMPOTENCY_CONFLICT` | The Idempotency-Key header and requestId body field must match. |
| 400 | `INVALID_REQUEST_ID` | requestId or Idempotency-Key is not a UUID v4. |
| 400 | `UPLOAD_TYPE_NOT_ALLOWED` | The active upload session is not a supported image type or exceeds 8 MiB. |
| 400 | `VALIDATION_ERROR` | An argument is missing, has an unsupported value, exceeds its limit, or is not part of the strict input schema. |
| 401 | `API_KEY_EXPIRED` | The API key has expired. |
| 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. |
| 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. |
| 401 | `UNAUTHORIZED` | The active upload session belongs to a different user. |
| 401 | `USER_NOT_FOUND` | The credential's account no longer exists. |
| 403 | `ACCOUNT_UNAVAILABLE` | The acting or billing account is unavailable or being deleted. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. |
| 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | This account already has 10 integration actions running. Poll an existing request before starting another. |
| 409 | `IDEMPOTENCY_CONFLICT` | The request identifier was already used with different arguments; a header/body identifier mismatch returns HTTP 400 with the same code. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. |
| 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | The action ran but its result could not be saved. Inspect saved request state and resource history before starting a new generation. |
| 503 | `INTERNAL_ERROR` | The active upload session could not be read. Retry the same mutation identifier and inspect its recorded state. |
| 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["thumbnails:write"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.