API multimodal OpenAI Responses

curl https://api.apimart.ai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
    "model": "gpt-5",
    "input": [
      {
        "role": "user",
        "content": [
          {
            "type": "input_text",
            "text": "What is in this image?"
          },
          {
            "type": "input_image",
            "image_url": "https://openai-documentation.vercel.app/images/cat_and_otter.png"
          }
        ]
      }
    ]
  }'

{
  "code": 200,
  "data": {
    "id": "resp-9876543210",
    "object": "response",
    "created": 1677652288,
    "model": "gpt-5",
    "choices": [
      {
        "index": 0,
        "message": {
          "role": "assistant",
          "content": "This image shows a cat and an otter. They appear to be interacting with each other in a very cute and heartwarming scene. The cat and otter seem to be getting along well."
        },
        "finish_reason": "stop"
      }
    ],
    "usage": {
      "prompt_tokens": 156,
      "completion_tokens": 45,
      "total_tokens": 201
    }
  }
}

POST

responses

curl https://api.apimart.ai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
    "model": "gpt-5",
    "input": [
      {
        "role": "user",
        "content": [
          {
            "type": "input_text",
            "text": "What is in this image?"
          },
          {
            "type": "input_image",
            "image_url": "https://openai-documentation.vercel.app/images/cat_and_otter.png"
          }
        ]
      }
    ]
  }'

{
  "code": 200,
  "data": {
    "id": "resp-9876543210",
    "object": "response",
    "created": 1677652288,
    "model": "gpt-5",
    "choices": [
      {
        "index": 0,
        "message": {
          "role": "assistant",
          "content": "This image shows a cat and an otter. They appear to be interacting with each other in a very cute and heartwarming scene. The cat and otter seem to be getting along well."
        },
        "finish_reason": "stop"
      }
    ],
    "usage": {
      "prompt_tokens": 156,
      "completion_tokens": 45,
      "total_tokens": 201
    }
  }
}

curl https://api.apimart.ai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
    "model": "gpt-5",
    "input": [
      {
        "role": "user",
        "content": [
          {
            "type": "input_text",
            "text": "What is in this image?"
          },
          {
            "type": "input_image",
            "image_url": "https://openai-documentation.vercel.app/images/cat_and_otter.png"
          }
        ]
      }
    ]
  }'

{
  "code": 200,
  "data": {
    "id": "resp-9876543210",
    "object": "response",
    "created": 1677652288,
    "model": "gpt-5",
    "choices": [
      {
        "index": 0,
        "message": {
          "role": "assistant",
          "content": "This image shows a cat and an otter. They appear to be interacting with each other in a very cute and heartwarming scene. The cat and otter seem to be getting along well."
        },
        "finish_reason": "stop"
      }
    ],
    "usage": {
      "prompt_tokens": 156,
      "completion_tokens": 45,
      "total_tokens": 201
    }
  }
}

Autorizaciones

Authorization

string

requerido

##Todas las APIs requieren autenticación mediante Bearer Token##Obtener API Key:Visite la página de gestión de API Keys para obtener su API KeyAñádala al encabezado de la solicitud:

Authorization: Bearer YOUR_API_KEY

Body

model

string

predeterminado:"gpt-5"

requerido

Nombre del modeloLos modelos admitidos incluyen:

gpt-5 - Modelo multimodal más reciente de OpenAI
GPT-4o-image - Modelo multimodal optimizado GPT-4
gpt-4-vision - Modelo GPT-4 con comprensión visual
Más modelos próximamente…

input

array

requerido

Lista de contenidos de entradaArray de entradas; cada elemento contiene los campos role y content.💡 Relleno rápido (área Try it):

Haga clic en ”+ Add an item” para agregar un elemento de entrada
Entrada de role: user (mensaje del usuario), assistant (respuesta de la IA) o system (prompt del sistema)
En content añada bloques de contenido (pueden incluir texto e imágenes)

Mostrar Detalles de los campos

role

string

predeterminado:"user"

requerido

Tipo de rolOpciones: user (mensaje del usuario), assistant (respuesta de la IA, para múltiples turnos), system (prompt del sistema, para definir el comportamiento de la IA)

content

array

requerido

Array de contenidosAdmite varios tipos de bloques de contenido, puede incluir texto e imágenes.

Mostrar Tipos de bloques de contenido

type

string

requerido

Tipo de contenidoOpciones:

input_text: Entrada de texto
input_image: Entrada de imagen

text

string

Contenido de textoSe utiliza cuando type es input_text; introduzca el contenido del texto

image_url

string

URL de la imagenSe utiliza cuando type es input_image; introduzca la URL de la imagen o la codificación base64Admite dos formatos:1. URL completa de la imagen

URL de imagen accesible públicamente (http:// o https://)
Ejemplo: https://example.com/image.jpg

2. Formato codificado en Base64

Debe usar el formato Data URI completo
Formato: data:image/{format};base64,{base64_data}
Formatos de imagen admitidos: jpeg, png, gif, webp

temperature

number

Controla la aleatoriedad de la salida, rango 0-2

Los valores más bajos (por ejemplo, 0.2) hacen la salida más determinística
Los valores más altos (por ejemplo, 1.8) hacen la salida más aleatoria

Valor por defecto: 1.0

max_tokens

integer

Número máximo de tokens a generarLos distintos modelos tienen límites máximos diferentes; consulte la documentación específica de cada modelo

stream

boolean

Si se debe usar salida en streaming

true: Respuesta en streaming (formato SSE)
false: Devuelve la respuesta completa de una sola vez

Valor por defecto: false

top_p

number

Parámetro de muestreo por núcleo (nucleus sampling), rango 0-1Controla la diversidad del texto generado; se recomienda usar este parámetro alternativamente con temperatureValor por defecto: 1.0

tools

array

Lista de herramientas para extender las capacidades del modeloTipos de herramientas admitidos:

Búsqueda web (web_search): Búsqueda de información en tiempo real en internet
Búsqueda de archivos (file_search): Buscar contenido en archivos cargados
Llamada a funciones (function): Llamar a funciones personalizadas
MCP remoto (remote_mcp): Conectarse a servicios remotos del Model Context Protocol

Ejemplo: [{"type": "web_search"}]

Respuesta

string

Identificador único de la respuesta

object

string

Tipo de objeto, fijado como response

created

integer

Timestamp de creación

model

string

Nombre del modelo realmente utilizado

choices

array

Lista de respuestas generadas

Mostrar Propiedades

index

integer

Índice de la elección

message

object

Contenido del mensaje

Mostrar Propiedades

role

string

Tipo de rol (assistant)

content

string

Contenido textual generado

finish_reason

string

Motivo de finalizaciónValores posibles:

stop - Finalización natural
length - Se alcanzó la longitud máxima
content_filter - Filtrado de contenido

usage

object

Estadísticas de uso de tokens

Mostrar Propiedades

prompt_tokens

integer

Número de tokens en la entrada

completion_tokens

integer

Número de tokens en la salida

total_tokens

integer

Número total de tokens

Ejemplos de uso

Entrada solo de texto

{
  "model": "gpt-5",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Hello, introduce artificial intelligence"
        }
      ]
    }
  ]
}

Uso de la herramienta de búsqueda web

{
  "model": "gpt-5",
  "tools": [{"type": "web_search"}],
  "input": "What positive news is there today?"
}

cURL Example

curl "https://api.apimart.ai/v1/responses" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>" \
    -d '{
        "model": "gpt-5",
        "tools": [{"type": "web_search"}],
        "input": "What positive news is there today?"
    }'

Comprensión de imágenes

{
  "model": "gpt-5",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Describe this image"
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/image.jpg"
        }
      ]
    }
  ]
}

Análisis de múltiples imágenes

{
  "model": "gpt-5",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Compare the similarities and differences of these two images"
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/image1.jpg"
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/image2.jpg"
        }
      ]
    }
  ]
}

Imagen codificada en Base64

{
  "model": "gpt-5",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Analyze this image"
        },
        {
          "type": "input_image",
          "image_url": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
        }
      ]
    }
  ]
}

Uso de la herramienta de búsqueda de archivos

{
  "model": "gpt-5",
  "tools": [{"type": "file_search"}],
  "input": "Based on uploaded documents, summarize the company's quarterly performance"
}

Uso de llamada a funciones

{
  "model": "gpt-5",
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "get_weather",
        "description": "Get weather information for a specified city",
        "parameters": {
          "type": "object",
          "properties": {
            "city": {
              "type": "string",
              "description": "City name, e.g.: Beijing"
            },
            "unit": {
              "type": "string",
              "enum": ["celsius", "fahrenheit"],
              "description": "Temperature unit"
            }
          },
          "required": ["city"]
        }
      }
    }
  ],
  "input": "What's the weather like in Beijing today?"
}

Uso de MCP remoto

{
  "model": "gpt-5",
  "tools": [
    {
      "type": "remote_mcp",
      "remote_mcp": {
        "url": "https://mcp.example.com/api",
        "auth_token": "your_mcp_token"
      }
    }
  ],
  "input": "Query user information in the database"
}

Combinando múltiples herramientas

{
  "model": "gpt-5",
  "tools": [
    {"type": "web_search"},
    {"type": "file_search"},
    {
      "type": "function",
      "function": {
        "name": "calculate",
        "description": "Perform mathematical calculations",
        "parameters": {
          "type": "object",
          "properties": {
            "expression": {
              "type": "string",
              "description": "Mathematical expression"
            }
          },
          "required": ["expression"]
        }
      }
    }
  ],
  "input": "Search for the latest Bitcoin price and calculate the total value of 100 Bitcoins"
}

Especificaciones de los tipos de contenido

input_text

Tipo de entrada de texto Propiedades:

type: Fijado como "input_text"
text: Contenido del texto (cadena)

input_image

Tipo de entrada de imagen Propiedades:

type: Fijado como "input_image"
image_url: URL de la imagen o data URI codificado en Base64

Formatos de imagen admitidos:

JPEG
PNG
GIF
WebP

Límites de tamaño de imagen:

Tamaño máximo de archivo: 20MB
aspect_ratio recomendada: No más de 2048x2048 píxeles

Detalles del uso de herramientas

Búsqueda web

La herramienta de búsqueda web permite al modelo acceder a información en tiempo real desde internet. Ejemplo de configuración:

{
  "tools": [{"type": "web_search"}]
}

Casos de uso:

Consultar las últimas noticias y eventos actuales
Obtener datos en tiempo real (acciones, clima, tipos de cambio, etc.)
Buscar la documentación técnica más reciente
Verificar información factual

Búsqueda de archivos

La herramienta de búsqueda de archivos permite al modelo buscar información relevante en los documentos cargados. Ejemplo de configuración:

{
  "tools": [{"type": "file_search"}]
}

Casos de uso:

Analizar documentos internos corporativos
Buscar especificaciones técnicas y manuales
Consultar contratos y documentos legales
Sistemas de preguntas y respuestas sobre bases de conocimiento

Llamada a funciones

Defina funciones personalizadas para permitir al modelo llamar a APIs externas o ejecutar operaciones específicas. Ejemplo completo de configuración:

{
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "get_stock_price",
        "description": "Get real-time stock price",
        "parameters": {
          "type": "object",
          "properties": {
            "symbol": {
              "type": "string",
              "description": "Stock symbol, e.g.: AAPL"
            },
            "currency": {
              "type": "string",
              "enum": ["USD", "CNY"],
              "description": "Currency unit",
              "default": "USD"
            }
          },
          "required": ["symbol"]
        }
      }
    }
  ]
}

Descripciones de los parámetros:

name: Nombre de la función (requerido)
description: Descripción de la función (requerido)
parameters: Definición de parámetros usando el formato JSON Schema
- type: Tipo del parámetro
- properties: Definiciones de las propiedades del parámetro
- required: Lista de parámetros requeridos

Casos de uso:

Llamar a APIs de terceros
Ejecutar consultas a bases de datos
Activar procesos de negocio
Integración con sistemas internos

MCP remoto

Conéctese a servicios remotos del Model Context Protocol (MCP) para ampliar las capacidades del modelo. Ejemplo de configuración:

{
  "tools": [
    {
      "type": "remote_mcp",
      "remote_mcp": {
        "url": "https://your-mcp-server.com/api",
        "auth_token": "your_auth_token",
        "timeout": 30
      }
    }
  ]
}

Descripciones de los parámetros:

url: Dirección del servidor MCP (requerido)
auth_token: Token de autenticación (opcional)
timeout: Tiempo de espera en segundos, por defecto 30 segundos

Casos de uso:

Conectarse a servicios de IA de nivel empresarial
Utilizar modelos específicos de un dominio
Acceder a fuentes de datos protegidas
Integración de sistemas de IA distribuidos

Formato de respuesta de las herramientas

Cuando el modelo utiliza herramientas, el formato de respuesta incluirá información sobre la llamada a la herramienta:

{
  "id": "resp-123456",
  "object": "response",
  "created": 1677652288,
  "model": "gpt-5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "call_abc123",
            "type": "function",
            "function": {
              "name": "get_weather",
              "arguments": "{\"city\": \"Beijing\"}"
            }
          }
        ]
      },
      "finish_reason": "tool_calls"
    }
  ]
}

Flujo de llamada a herramientas:

El modelo recibe la entrada del usuario
Analiza si se necesitan herramientas
Si es necesario, devuelve una solicitud de llamada a la herramienta
El cliente ejecuta la llamada a la herramienta
Devuelve los resultados de la herramienta al modelo
El modelo genera la respuesta final

Notas importantes

Requisitos para la URL de la imagen:
- Debe ser una URL accesible públicamente
- O utilizar el formato Data URI codificado en Base64
Facturación de tokens:
- Las imágenes consumen tokens en función de su aspect_ratio
- Las imágenes con aspect_ratio alta se redimensionan automáticamente para optimizar costos
- Las llamadas a herramientas también consumen tokens adicionales
Orden del contenido:
- El orden de los elementos en el array de content afecta la comprensión del modelo
- Se recomienda colocar primero las instrucciones de texto y después las imágenes
Combinaciones multimodales:
- Puede mezclar varios textos e imágenes en una sola solicitud
- Admite conversaciones de múltiples turnos con coherencia contextual
Limitaciones del uso de herramientas:
- Al usar varias herramientas simultáneamente, el modelo selecciona inteligentemente la más adecuada
- La llamada a funciones requiere definiciones claras de las funciones y descripciones de los parámetros
- Los resultados de la búsqueda web pueden estar limitados por región y tiempo
Compatibilidad de API:
- Totalmente compatible con el formato de la API OpenAI Responses
- Migre sin problemas el código existente de OpenAI
- Admite todas las funciones de extensión de herramientas de OpenAI

Formato nativo de Gemini Generación de imágenes con Gemini-3.1-Flash-Image-preview (Nano banana2)

Documentation Index

​Autorizaciones

​Body

​Respuesta

​Ejemplos de uso

​Entrada solo de texto

​Uso de la herramienta de búsqueda web

​Comprensión de imágenes

​Análisis de múltiples imágenes

​Imagen codificada en Base64

​Uso de la herramienta de búsqueda de archivos

​Uso de llamada a funciones

​Uso de MCP remoto

​Combinando múltiples herramientas

​Especificaciones de los tipos de contenido

​input_text

​input_image

​Detalles del uso de herramientas

​Búsqueda web

​Búsqueda de archivos

​Llamada a funciones

​MCP remoto

​Formato de respuesta de las herramientas

​Notas importantes

Autorizaciones

Body

Respuesta

Ejemplos de uso

Entrada solo de texto

Uso de la herramienta de búsqueda web

Comprensión de imágenes

Análisis de múltiples imágenes

Imagen codificada en Base64

Uso de la herramienta de búsqueda de archivos

Uso de llamada a funciones

Uso de MCP remoto

Combinando múltiples herramientas

Especificaciones de los tipos de contenido

input_text

input_image

Detalles del uso de herramientas

Búsqueda web

Búsqueda de archivos

Llamada a funciones

MCP remoto

Formato de respuesta de las herramientas

Notas importantes