TypeScript SDK

npm install agentboxd

import { Agentboxd } from 'agentboxd';

const mr = new Agentboxd(); // or new Agentboxd({ apiKey: 'mr_...', baseUrl: 'https://api.agentboxd.com' })

import { Agentboxd } from 'agentboxd';

const mr = new Agentboxd();
const stop = new AbortController();
process.on('SIGTERM', () => stop.abort()); // finish running work, then exit

await mr.inboxes.consume(
  inboxId,
  async (message, ctx) => {
    await handleTicket(message, { signal: ctx.signal }); // acked when this returns, nacked if it throws
  },
  { concurrency: 4, enriched: true, signal: stop.signal },
);

// Who is this? Name, notes, metadata and labels, created from mail.
const c = await mr.contacts.byAddress('priya.n@gmail.com');
console.log(c.notes, c.metadata.crm_id); // "Wholesale…" "hs_48213"

// Link it to your CRM and remember something. Metadata merges; null deletes a key.
await mr.contacts.update(c.id, {
  notes: `${c.notes ?? ''}
Asked about order 1042 on 25 Sep.`,
  metadata: { crm_id: 'hs_48213', plan: 'wholesale' },
  add_labels: ['customer'],
});

// Find contacts by your own id.
const { data } = await mr.contacts.list({ metadata: { crm_id: 'hs_48213' } });

// Workspace-wide (no inbox_id) or for one inbox.
await mr.knowledge.create({
  title: 'Shipping times',
  body: '- Germany: 1–2 working days (DHL)
- EU: 3–5 working days',
  inbox_id: inbox.id,
});

// Ranked full-text search. With inbox_id, workspace-wide documents are included too.
const { data: hits } = await mr.knowledge.search('how long does shipping to France take', { inbox_id: inbox.id });
// [{ id, title: 'Shipping times', inbox_id, rank: 0.61, snippet: '…EU: 3–5 working days…' }]

import { AgentboxdError } from 'agentboxd';

try {
  await mr.messages.send(inbox.id, { to: 'x@example.com', subject: 'Hi', text: '…' });
} catch (e) {
  if (e instanceof AgentboxdError && e.code === 'daily_send_limit_exceeded') {
    // back off until 00:00 UTC
  }
}