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

# Obtener una generación de imagen

> Obtén el estado, las dimensiones y la caducidad de una imagen generada por la cuenta conectada.

Obtén el estado, las dimensiones y la caducidad de una imagen generada por la cuenta conectada.

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

## 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:read`.

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="generationId" type="string" required>
  ID de generación devuelto por una acción de generación o de historial.

  Patrón: `^[A-Za-z0-9_-]{1,128}$`.
</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": {
      "generationId": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]{1,128}$",
        "description": "Generation ID returned by a generation or history action."
      }
    },
    "required": ["generationId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 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_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"generationId":"6224018c7635dcb933ce5c8f7804aea73738dd1c"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    generationId: '6224018c7635dcb933ce5c8f7804aea73738dd1c',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/images_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);
  ```

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

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/images_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c"},
      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.

Los metadatos públicos de la imagen de la aplicación perteneciente al usuario, incluidos el estado actual, las dimensiones y la caducidad. Los datos de la imagen se recuperan por separado.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
      "status": "completed",
      "aspectRatio": "square",
      "width": 1024,
      "height": 1024,
      "referenceImageCount": 1,
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "expiresAt": 1792749600000
    }
  }
  ```
</ResponseExample>

## Campos del resultado

| Campo | Descripción |
| - | - |
| `data.generationId` | Identificador que se debe pasar sin cambios a images\_get o images\_download. |
| `data.status` | pending, completed, failed o expired. La caducidad tiene prioridad sobre el estado guardado. |
| `data.aspectRatio` | square, landscape o portrait. |
| `data.width` | Ancho de salida en píxeles, o null antes de que las dimensiones estén disponibles. |
| `data.height` | Altura de salida en píxeles, o null antes de que las dimensiones estén disponibles. |
| `data.referenceImageCount` | Número de imágenes de referencia usadas: 0 o 1. |
| `data.createdAt` | Hora de creación en milisegundos Unix. |
| `data.updatedAt` | Hora de la última actualización en milisegundos Unix. |
| `data.expiresAt` | Tiempo en milisegundos Unix a partir del cual no se puede descargar la imagen generada. |

## Notas de la operación

* Requiere images:read. generationId debe contener entre 1–128 letras ASCII, dígitos, guiones bajos o guiones.
* Esta acción usa las creaciones y cargas propias del usuario conectado, también cuando la credencial está conectada en un contexto de equipo.
* El registro puede indicar pending, completed, failed o expired. El ancho y el alto son null cuando no están disponibles. Un registro puede seguir visible como expired hasta que la limpieza lo elimine; una consulta get correcta no garantiza que la descarga esté disponible.
* Usa images\_download para obtener los bytes PNG antes de expiresAt. Esta acción no devuelve previewDataUrl ni una URL multimedia.

## 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 | `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 | `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. |
| 404 | `IMAGE_NOT_FOUND` | La generación no existe, pertenece a otro usuario o no es una imagen de la aplicación. |
| 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 | `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:read"]
  }
}
```


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