Retrieve Agent Settings

import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.inboxes.agent.get({
  inboxId: 'b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1',
});

curl -X GET 'https://api.resend.com/inboxes/b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1/agent' \
     -H 'Authorization: Bearer re_xxxxxxxxx'

resend inboxes agent get b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1

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

GET

inboxes

:inbox_id

agent

import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.inboxes.agent.get({
  inboxId: 'b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1',
});

curl -X GET 'https://api.resend.com/inboxes/b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1/agent' \
     -H 'Authorization: Bearer re_xxxxxxxxx'

resend inboxes agent get b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1

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

Inboxes are currently in private beta and only available to a limited number of users. The response shape might change before GA.Get early access if you’re interested in testing this feature.Once you have access, upgrade your Resend SDK to use the new methods:

npm install resend@6.33.0

npm install -g resend-cli@2.25.0

Path Parameters

Response Fields

string

Always inbox_agent.

string | null

Instructions the agent follows when handling the inbox’s threads. null when no instructions are set.

'concise_professional' | 'concise_casual' | 'expanded_professional' | 'expanded_casual' | null

Tone the agent writes in. null when no tone is set.

concise_professional: Brief responses in a professional tone.
concise_casual: Brief responses in a casual tone.
expanded_professional: Detailed responses in a professional tone.
expanded_casual: Detailed responses in a casual tone.

string[]

Actions the agent is allowed to take.

draft_reply: Draft a reply.
forward_thread: Forward a thread.
add_labels: Add labels to a thread.
assign_thread: Assign a thread.
mark_as_spam: Mark a thread as spam.
archive_thread: Archive a thread.
delete_thread: Delete a thread.

import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.inboxes.agent.get({
  inboxId: 'b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1',
});

curl -X GET 'https://api.resend.com/inboxes/b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1/agent' \
     -H 'Authorization: Bearer re_xxxxxxxxx'

resend inboxes agent get b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1

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

API Reference

Sending

Receiving

Inboxes

Inbox Labels

Inbox Threads

Inbox Drafts

Inbox Agent

Broadcasts

Automations

Events

Templates

Contacts

Contact Properties

Contact Imports

Segments

Topics

Audiences

Domains

Logs

Usage

API Keys

Suppressions

Authorized Apps

Webhooks

OAuth

Retrieve Agent Settings

Path Parameters

Response Fields

​Path Parameters

​Response Fields

Path Parameters

Response Fields