Metadata

metadata acepta un objeto JSON opcional asociado a la invocación. Actualmente se registra junto con el consumo de la llamada para aportar trazabilidad técnica.

await client.responses.create({
  message: "Resume la oportunidad",
  metadata: {
    source: "crm",
    recordId: "lead_456",
    environment: "production",
  },
});

Uso recomendado

Utiliza campos breves y estables que permitan correlacionar la llamada con tu sistema:

• producto o servicio de origen;
• tipo de integración;
• identificador interno no sensible;
• entorno de ejecución;
• versión de tu integración.

Lo que metadata no hace actualmente

metadata no se incorpora al prompt, no modifica las instrucciones del agente y no sustituye al contenido de message. Si el agente necesita conocer un dato para responder, inclúyelo de forma explícita en el mensaje o en una fuente de Knowledge configurada.

Tipo TypeScript

metadata?: Record<string, unknown>;

Los valores deben poder serializarse como JSON. Evita objetos circulares, funciones, instancias complejas o estructuras innecesariamente grandes.

Validación

La API limita tamaño, número de claves, profundidad, listas y tipos admitidos. Los rechazos utilizan códigos como metadata_too_large, metadata_too_many_keys, metadata_too_deep, metadata_invalid_key, metadata_invalid_value y metadata_list_too_large.