Get inbox agent settings | Resend API (unofficial showcase)

1 parameter

inbox_idstringrequired

The UUID of the inbox whose agent settings to retrieve; an email address is not accepted.

1 status code

200Returns the agent settings, including `instructions`, `tone`, and the array of `enabled_actions`; unset settings are null or empty.

objectstringrequired

The object type. Always `inbox_agent`.

instructionsstringrequired

Instructions the agent follows when it handles the threads of the inbox. Null when no instructions are set.

tonestringrequired

The tone the agent writes in. Null when no tone is set.

Allowed:concise_professionalconcise_casualexpanded_professionalexpanded_casualnull

enabled_actionsarray<string>required

The actions the agent can take. Empty when no actions are enabled.

Error handling

The inbox_id path parameter must be a UUID identifying an inbox.

import { Client } from "@octridev/resend";

const client = new Client({
  baseUrl: "https://api.resend.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.agent.list({ inboxId: "c0a80123-4567-89ab-cdef-0123456789ab" });

{
  "object": "inbox_agent",
  "instructions": "Answer refund questions yourself. Escalate legal threats.",
  "tone": "concise_professional",
  "enabled_actions": [
    "draft_reply",
    "add_labels"
  ]
}

Request

Response

Errors