POST
https://api.nexscope.ai/ai/imageCaptioningEjecutar 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/imageCaptioning |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
type | integer | obligatorio | Tipo de análisis. Valores compatibles: 5 (imperio de imagen similar), 13 (imperio de escena), 30 (análisis imagen-vídeo), 69 (puntos de venta de la plataforma), 71 (puntos de venta de productos), 73 (señal de venta de vídeo), 89 (imperio de vídeo-reclón). Ejemplo: 71 |
imageUrlList | array | obligatorio | URLs de imagen pública utilizadas para el análisis. No proporcionar más de 6 imágenes para modos que aceptan múltiples imágenes. Ejemplo: [
"https://example.com/product.jpg"
] |
keyword | string | opcional | Contexto opcional de palabras clave. Ejemplo: phone case |
provider | string | opcional | Proveedor de análisis. Valores compatibles: API_PRE_POINT (por defecto), API_LAYOUT_DESC. Ejemplo: API_PRE_POINT |
refVideoUrl | string | condicional | Vídeo de referencia URL. Requerido cuando el tipo es 89. Ejemplo: https://example.com/reference-video.mp4 |
saleCountry | string | opcional | Código de país de venta objetivo. Ejemplo: US |
targetLanguage | string | opcional | Lenguaje de destino para el texto generado. Utilizado por el análisis de vídeo-reclone. Ejemplo: English |
duration | integer | opcional | Duración del objetivo en segundos. Utilizado por el análisis de vídeo-reclon. Ejemplo: 15 |
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 significa aceptado o exitoso; no cero es un error de plataforma. |
cost | string | obligatorio | Se pasó milisegundos, nunca créditos; -1 peticiones externas de la web. |
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 | Hora local del servidor: aaaa-mm-dd HH:mm:ss. |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Epoch milisegundos. |
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 | Producción de generación completa retenida del resultado de la tarea. Los campos varían según la capacidad; uso de recursos generados Nexscope-organiza URLs y cualquier cuenta representa carga Nexscope créditos. Este es el resultado del negocio, no un recibo de creación de tareas. |
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 la ausencia de una clave API (code 11209), 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. |