> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Resend: Inboxes Get Agent

> Retrieve the agent settings for an inbox. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Retrieve the agent settings for an inbox.

> [!NOTE]
>
> Tool ID: `resend_inboxes_get_agent`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'resend_inboxes_get_agent',
  {
    "inbox_id": "inbox_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline run resend_inboxes_get_agent --input '{
  "inbox_id": "inbox_123"
}'
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "object": "example",
    "instructions": "example",
    "tone": "concise_professional",
    "actions": [
      "draft_reply"
    ]
  }
}
```

Use `deepline describe resend_inboxes_get_agent --json` for the latest machine-readable contract.

## Input reference

Returns the agent settings of the inbox. An inbox without a configured agent returns empty settings: `instructions` and `tone` are null and `actions` is an empty array.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.inbox_id` | `string` | Yes | — | The Inbox ID or the inbox email address, such as `support@acme.com`. A value that contains `@` must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox `name`. An address that matches no inbox returns a 404. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns the agent settings of the inbox. An inbox without a configured agent returns empty settings: `instructions` and `tone` are null and `actions` is an empty array.",
    "properties": {
      "inbox_id": {
        "type": "string",
        "description": "The Inbox ID or the inbox email address, such as `support@acme.com`. A value that contains `@` must be a valid email address, and any other value must be a UUID, or the request returns a 422. The address match is case-insensitive and never falls back to the inbox `name`. An address that matches no inbox returns a 404."
      }
    },
    "required": [
      "inbox_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.object` | `string` | Yes | — | The object type. Always `inbox_agent`. |
| `result.data.instructions` | `string \| null` | Yes | — | Instructions the agent follows when it handles the threads of the inbox. Null when no instructions are set. |
| `result.data.tone` | `"concise_professional" \| "concise_casual" \| "expanded_professional" \| "expanded_casual" \| null` | Yes | — | The tone the agent writes in. Null when no tone is set. Allowed: `concise_professional`, `concise_casual`, `expanded_professional`, `expanded_casual`, `null`. |
| `result.data.actions` | `array` | Yes | — | The actions the agent can take, in the order of the enum. Empty when no actions are enabled. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "object": {
            "type": "string",
            "description": "The object type. Always `inbox_agent`."
          },
          "instructions": {
            "type": [
              "string",
              "null"
            ],
            "description": "Instructions the agent follows when it handles the threads of the inbox. Null when no instructions are set."
          },
          "tone": {
            "type": [
              "string",
              "null"
            ],
            "description": "The tone the agent writes in. Null when no tone is set.",
            "enum": [
              "concise_professional",
              "concise_casual",
              "expanded_professional",
              "expanded_casual",
              null
            ]
          },
          "actions": {
            "type": "array",
            "description": "The actions the agent can take, in the order of the enum. Empty when no actions are enabled.",
            "items": {
              "type": "string",
              "enum": [
                "draft_reply",
                "forward_thread",
                "add_labels",
                "assign_thread",
                "mark_as_spam",
                "archive",
                "move_to_trash"
              ]
            }
          }
        },
        "required": [
          "object",
          "instructions",
          "tone",
          "actions"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Connect integrations](https://deepline.com/docs/integrations.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.