> ## 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.

# Iniciar la carga de una imagen de referencia

> Prepara la carga de una referencia JPG, PNG o WebP de hasta 8 MiB. Usa images_upload_sign_parts para obtener las URL PUT, carga los bytes y después llama a images_upload_complete y usa su fileKey al generar.

Prepara la carga de una referencia JPG, PNG o WebP de hasta 8 MiB. Usa images\_upload\_sign\_parts para obtener las URL PUT, carga los bytes y después llama a images\_upload\_complete y usa su fileKey al generar.

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

## Autenticación y permisos

<ParamField header="x-api-key" type="string" required>
  Envía una clave de API de VoiceCheap en esta cabecera. También se admite Authorization: Bearer con la misma clave de API. Los tokens de acceso OAuth
  solo se aceptan en MCP, no en este endpoint REST.
</ParamField>

Permisos necesarios: `images:write`.

Se requiere una suscripción de pago activa. Los permisos no cambian los roles del equipo, la propiedad de los recursos, los créditos multimedia ni los límites del plan.

## Parámetros

<ParamField body="requestId" type="string">
  Opcional en la capa de transporte: el servidor introduce un identificador antes de la validación si se omite. Proporciona tu propio UUID v4 estable para recuperar la solicitud de forma segura si se pierde la respuesta.

  Formato: "uuid". Patrón: `^[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="filename" type="string" required>
  El nombre de archivo de la imagen, con una extensión que coincida con contentType.

  Longitud mínima: 1. Longitud máxima: 250. Patrón: `\.(?:jpe?g|png|webp)$`.
</ParamField>

<ParamField body="contentType" type="string" required>
  Valor de texto.

  Valores permitidos: "image/jpeg", "image/png", "image/webp".
</ParamField>

<ParamField body="fileSize" type="integer" required>
  Tamaño exacto del archivo en bytes, hasta 8 MiB.

  Mínimo: 1. Máximo: 8388608.
</ParamField>

<Accordion title="Esquema completo de entrada">
  El JSON Schema siguiente conserva los nombres exactos de los campos, los tipos anidados, los valores predeterminados, los límites y los valores aceptados que expone el descubrimiento. Las reglas adicionales entre campos se indican en las notas de la operación.

  ```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}$"
      },
      "filename": {
        "type": "string",
        "minLength": 1,
        "maxLength": 250,
        "pattern": "\\.(?:jpe?g|png|webp)$",
        "description": "The image filename, with an extension matching contentType."
      },
      "contentType": {
        "type": "string",
        "enum": ["image/jpeg", "image/png", "image/webp"]
      },
      "fileSize": {
        "type": "integer",
        "minimum": 1,
        "maximum": 8388608,
        "description": "Exact file size in bytes, up to 8 MiB."
      }
    },
    "required": ["filename", "contentType", "fileSize"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Idempotencia

Usa un UUID v4 en requestId o en la cabecera HTTP Idempotency-Key para cada modificación. Reutiliza el mismo identificador y argumentos idénticos después de un fallo de red. Si proporcionas ambos, deben coincidir. Repetir una solicitud guardada no vuelve a ejecutar la operación ni consume otra llamada mensual. Las solicitudes fallidas o interrumpidas no se reinician automáticamente.

Toda modificación puede devolver HTTP 202 cuando un reintento encuentra la misma solicitud todavía en ejecución, incluso si su primera ejecución suele ser síncrona. Si la ejecución ha terminado pero resultStored es false, un reintento devuelve HTTP 200 con el estado de la solicitud guardada en lugar del resultado original. Recupera la salida mediante la acción de historial, resultado o descarga de su ámbito.

## Ejemplos de solicitud

Sustituye los identificadores de recursos y las claves multimedia de los ejemplos por valores devueltos para tu cuenta. Mantén el identificador de solicitud al reintentar la misma modificación.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_initialize' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"requestId":"85d80887-5e1c-4a86-bbad-bb105487f7e4","filename":"reference.png","contentType":"image/png","fileSize":7340032}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    requestId: '85d80887-5e1c-4a86-bbad-bb105487f7e4',
    filename: 'reference.png',
    contentType: 'image/png',
    fileSize: 7340032,
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_initialize', {
    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/images_upload_initialize",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "filename": "reference.png", "contentType": "image/png", "fileSize": 7340032},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Respuesta

Una primera ejecución correcta devuelve HTTP 200 con el resultado de la operación en data. Una repetición puede devolver el estado de la solicitud guardada en su lugar. El ejemplo muestra una respuesta admitida, no todos los campos opcionales.

Una nueva sesión de carga multiparte de una imagen de referencia, la futura clave del objeto, el tamaño de las partes en bytes y el número máximo de cargas paralelas. No carga ningún byte de imagen ni deja key listo para la generación.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a",
      "key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
      "partSize": 5242880,
      "maxConcurrency": 4
    },
    "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4",
      "operation": "images_upload_initialize",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4",
      "operation": "images_upload_initialize",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4"
  }
  ```
</ResponseExample>

## Campos del resultado

| Campo | Descripción |
| - | - |
| `data.uploadId` | UUID que identifica la sesión de subida activa. Pásalo a las demás acciones de subida. |
| `data.key` | Futura clave de objeto propio. Usa el fileKey de una finalización correcta como referencia de generación. |
| `data.partSize` | Tamaño requerido de cada parte en bytes, salvo la última parte, que contiene los bytes restantes. |
| `data.maxConcurrency` | Número máximo sugerido de subidas de partes en paralelo: 4. |

## Recuperar y consultar esta solicitud

Usa el mismo identificador incluso después de perder la conexión. Si resultStored es false, recupera la salida mediante la acción correspondiente de historial, resultado o descarga. Nunca inicies una segunda generación solo para comprobar el progreso.

```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":"85d80887-5e1c-4a86-bbad-bb105487f7e4","operation":"images_upload_initialize"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4",
    "operation": "images_upload_initialize",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a",
      "key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png",
      "partSize": 5242880,
      "maxConcurrency": 4
    }
  }
}
```

## Notas de la operación

* Requiere images:write; no se necesita un ámbito adicional de carga.
* Se eliminan los espacios al principio y al final de filename, que debe contener entre 1–250 caracteres y terminar en .jpg, .jpeg, .png o .webp. Su extensión debe coincidir con contentType: image/jpeg, image/png o image/webp. fileSize es el número entero exacto de bytes, de 1 a 8,388,608.
* La implementación compartida de carga devuelve partSize 5 MiB (5,242,880 bytes) para estas referencias. Un archivo de como máximo 5 MiB usa una parte; un archivo mayor, de hasta 8 MiB, usa dos. Solicita las URL PUT con images\_upload\_sign\_parts, carga los bytes y después llama a images\_upload\_complete.
* Usa el fileKey devuelto por la finalización como referenceImageKey en images\_generate. El resultado de initialize usa key, no fileKey. No envíes key a la generación antes de la finalización.
* La sesión de subida de producción caduca tras 24 horas. Las URL firmadas de las partes caducan tras una hora. La finalización y la anulación eliminan la sesión activa; después, sign-parts y complete devuelven Upload not found. Ninguna respuesta incluye un campo expiresAt.
* Esta acción usa las creaciones y cargas propias del usuario conectado, también cuando la credencial está conectada en un contexto de equipo.
* Usa un requestId UUID v4 o la cabecera HTTP Idempotency-Key, y reutilízalo con entradas idénticas al reintentar. La capa de integración registra cada modificación y devuelve su estado o resultado registrado sin volver a ejecutarla. Una solicitud fallida o interrumpida no se reintenta automáticamente.
* El nombre de archivo de la clave del objeto se sanea y puede acortarse. Conserva la clave exacta y el uploadId devueltos; no los construyas por tu cuenta. Durante la generación se validan los bytes de la imagen, además del tamaño y el tipo declarados durante la subida.

## Uso

Cada invocación correcta consume una llamada mensual de API/MCP. También se aplican los créditos multimedia y las cuotas de generación propias de la operación.

## Errores

| Estado HTTP | Código | Significado o solución |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Se han proporcionado credenciales en un parámetro de consulta access\_token o api\_key. Envía las credenciales en las cabeceras. |
| 400 | `IDEMPOTENCY_CONFLICT` | La cabecera Idempotency-Key y el campo requestId del cuerpo deben coincidir. |
| 400 | `INVALID_REQUEST_ID` | requestId o Idempotency-Key no es un UUID v4. |
| 400 | `REFERENCE_IMAGE_INVALID` | La extensión del archivo no coincide con el contentType de imagen declarado. |
| 400 | `VALIDATION_ERROR` | Falta un argumento, tiene un valor no compatible, supera su límite o no forma parte del esquema de entrada estricto. |
| 401 | `API_KEY_EXPIRED` | La clave API ha caducado. |
| 401 | `INVALID_API_KEY` | Proporciona una clave de API válida que no haya caducado. |
| 401 | `INVALID_CREDENTIAL` | La cabecera Authorization tiene un formato incorrecto o entra en conflicto con x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No se proporcionó ninguna credencial de cabecera utilizable o superaba 4096 caracteres. |
| 401 | `USER_NOT_FOUND` | La cuenta de la credencial ya no existe. |
| 403 | `ACCOUNT_UNAVAILABLE` | La cuenta que realiza la acción o la cuenta de facturación no está disponible o se está eliminando. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | El usuario de la credencial pertenece a más de un equipo, por lo que el contexto de facturación es ambiguo. |
| 403 | `INSUFFICIENT_SCOPE` | Concede todos los permisos necesarios o elige otra credencial. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | No se han podido verificar los límites de integración de la cuenta. |
| 403 | `SUBSCRIPTION_REQUIRED` | Usa una suscripción de pago activa. |
| 403 | `TEAM_OWNER_NOT_FOUND` | No se pudo encontrar la cuenta del propietario efectivo del equipo. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Esta cuenta ya tiene 10 acciones de integración en ejecución. Consulta una solicitud existente antes de iniciar otra. |
| 409 | `IDEMPOTENCY_CONFLICT` | El identificador de solicitud ya se ha usado con argumentos distintos; una discrepancia entre los identificadores del encabezado y del cuerpo devuelve HTTP 400 con el mismo código. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Espera al restablecimiento mensual o cambia de plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Espera el tiempo indicado en Retry-After cuando esté presente y aplica esperas progresivas. |
| 500 | `INTERNAL_ERROR` | Comprueba el estado de la solicitud guardada y el historial del recurso antes de decidir si reintentas una modificación. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | La acción se ejecutó, pero no se pudo guardar su resultado. Revisa el estado de la solicitud guardada y el historial del recurso antes de iniciar una nueva generación. |
| 503 | `INTERNAL_ERROR` | No se pudo crear o guardar la sesión de carga. Reintenta con el mismo identificador de mutación y consulta su estado registrado. |
| 503 | `SERVER_RESTARTING` | El servidor se está reiniciando. Reinténtalo en breve y conserva el mismo identificador de solicitud para una modificación. |

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


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