Sign inGet Started

Reclama tu primer buzón de agente

Esta guía completa una conversación bidireccional: reclama una bandeja de entrada en inbox.ai, recibe un mensaje en un hilo, léelo y responde. No necesitas verificar un dominio ni ejecutar un servidor de correo.

1. Crea una clave de API

En el panel, ve a Platform tools > API keys y crea una clave. En el grupo Email, activa los ámbitos mailbox y mailbox_management. Las claves tienen el formato bk_us1_... o bk_eu1_...; la región del prefijo determina el host de API.

Ejemplo de código
export BIRD_API_KEY="bk_us1_..."

Usa name para el nombre de remitente que ven los destinatarios. Define display_name si quieres que tu equipo vea una etiqueta de buzón distinta; si no, toma el valor de name.

2. Reclama un buzón

Crea un buzón en el dominio compartido inbox.ai. Si omites la parte local, Bird genera una dirección disponible. La política de recepción open acepta el correo salvo que una regla de recepción lo bloquee.

const mailbox = await bird.email.mailboxes.create({ name: "Support" });
console.log(mailbox.address); // "abc123@inbox.ai"

La respuesta incluye el id del buzón y la address reclamada para ti. Envía un correo a esa dirección desde cualquier cliente de correo para que el siguiente paso tenga algo que leer.

3. Lee el hilo

El correo entrante se convierte en un hilo del buzón. Lista los hilos y luego lee los mensajes del primero.

Un hilo de buzón en el panel de Bird que muestra un mensaje entrante y una respuesta en el ciclo de conversación bidireccional

for await (const thread of bird.email.threads.list({ mailbox_id: "mbx_01abc" })) {
  console.log(thread.id, thread.subject);
}

Después, lee los mensajes de ese hilo:

for await (const msg of bird.email.threads.messages.list("thr_01abc")) {
  console.log(msg.id, msg.direction);
}

Cada mensaje indica su dirección (inbound) y su id (un mensaje recibido lleva el prefijo rem_). Añade include=extracted_text para incluir el cuerpo sin citas: el contenido nuevo, sin el historial citado que, de lo contrario, el agente tendría que eliminar por su cuenta.

Para no tener que consultar periódicamente, suscríbete al webhook email_mailbox.message_received. Se activa cuando un mensaje entrante llega a la bandeja de entrada. Consulta la referencia de eventos.

4. Responder

Responde al mensaje recibido con el ID de rem_ del paso 3. La respuesta permanece en el mismo hilo y se envía desde la dirección de tu buzón:

const reply = await bird.email.threads.messages.reply("thr_01abc", "rem_01xyz", {
  text: "Thanks for reaching out!",
});
console.log(reply.id);

Ya puedes reservar un buzón, recibir, leer y responder. Para iniciar una conversación en lugar de responder a una, redacta un mensaje nuevo en el buzón (POST /v1/email/mailboxes/{id}/messages), lo que abre un hilo nuevo.

Siguientes pasos

  • Buzones de agente: cómo funcionan los hilos, las reglas de recepción, el envío y la retención.
  • Servidor MCP: ejecuta el mismo ciclo desde un agente de IA a través del servidor MCP.
  • CLI: bird email mailboxes y bird email threads para la terminal.
  • Guías de inicio rápido de SDK: recorridos de SDK en Go, Python y TypeScript.

Continúa con la documentación, guías y ejemplos de este tema.