https://api.nexscope.ai/ai/handheldProductMockupEjecutar esta API
Envía una solicitud JSON para ejecutar esta API y recibir los datos de respuesta documentados.
Endpoint
| Método | POST |
| Ruta | https://api.nexscope.ai/ai/handheldProductMockup |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
imageUrl | string | obligatorio | Público URL La imagen debe ser de 20 MB como máximo y entre 385 y 8192 píxeles en anchura y altura. Ejemplo: https://example.com/product.jpg |
targetOriginUrl | string | obligatorio | Público URL de la persona o de la mano que posan la imagen. Ejemplo: https://example.com/model-reference.jpg |
targetMaskUrl | string | obligatorio | Público URL de la máscara de área de mano en blanco y negro. Requerido porque API acepta imágenes de pose personalizadas en lugar de materiales de origen guardados. Ejemplo: https://example.com/mask.png |
outputNum | integer | opcional | Número de imágenes a generar, de 1 a 4. Por defecto a 1. Ejemplo: 1 |
Respuesta de ejemplo
Estructura de respuesta de la plataforma. code 0 indica éxito o aceptación; data contiene el resultado de negocio.
{
"code": 0,
"cost": "-1",
"data": {
"result": null,
"status": "PENDING",
"taskId": "example-task"
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Campos de respuesta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 means accepted or successful; nonzero is a platform error. |
cost | string | obligatorio | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | obligatorio | Valor de Data usado por esta operación de API. |
msg | string | null | obligatorio | Valor de Msg usado por esta operación de API. |
time | string | obligatorio | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Epoch milliseconds. |
Opción 1 de cualquier alternativa — requiere taskId, status, result
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.result | any | obligatorio | Valor de Result usado por esta operación de API. |
data.status | string | obligatorio | Valor de Status usado por esta operación de API. Permitidos: PENDING, RUNNING, SUCCEEDED, FAILED, TIMEOUT |
data.taskId | string | obligatorio | Valor de Task id usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result | object | obligatorio | Completed generation output retained from the task result. Fields vary by capability; generated resources use Nexscope-hosted URLs and any count represents charged Nexscope credits. This is the business output, not a task creation receipt. |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result | null | obligatorio | Valor de Result usado por esta operación de API. |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data | null | obligatorio | Valor de Data usado por esta operación de API. |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta HTTP predeterminada tanto para el éxito como para muchos errores de negocio. Solo el código JSON externo 0 indica éxito o aceptación asíncrona; consulta data para obtener el resultado. |
| 429 | Límite de admisión de ejecuciones; respeta Retry-After cuando esté presente. |
| 503 | La admisión de ejecuciones no está disponible temporalmente; respeta Retry-After cuando esté presente. |
| Opcional | X-Nexscope-Http-Status: semantic asigna estados HTTP a los errores de negocio gestionados por el controlador en las rutas de ejecución y tareas. Los fallos previos a la autenticación, como una clave API ausente o no válida (code 11209, incluida una copia incompleta o dañada) o una sesión web caducada (code 12001), pueden seguir devolviendo HTTP 200 antes de esta asignación. Comprueba siempre el código JSON externo; las solicitudes malformadas y los fallos de infraestructura también pueden devolver respuestas HTTP distintas de 200. |