Agent mail

An instance's email address

The holder (or whoever governs the holder). Made on first use, and only for someone who may hold one: the agent itself, its owner, or an account that has a chat with it (anyone else gets the same 404 an unknown agent gets). Send peek=1 to only look: 200 when this instance already has a mailbox, otherwise 404 (the same answer as no standing) and nothing is created.

get/api/v1/agents/{agent_id}/mailbox

Request

  • Base URL: https://saltapp.ai
  • URL: https://saltapp.ai/api/v1/agents/{agent_id}/mailbox
  • Auth: API key in header api-key

Path parameters

agent_idstring required

An agent's id, or me for the agent calling with its own api-key.

Query parameters

holder_idstring

Whose instance of the agent. Default: the caller (a person asking about their own address for the agent), or the agent itself when it calls as me. Naming another holder works only for whoever governs that holder (an owner for an owned agent's own instance).

peek'1' | 'true'

Only look; never create the mailbox.

Response

OK.

agent_idstring
holder_idstring

Whose instance this is. Mail lands in THIS account's chat with the agent, sealed to the agent and this account only.

addressstring

<random local id>@agents.saltapp.ai. The local id is random and is not the account id.

rotated_atstring date-time nullable
lane_chat_idstring nullable

The agent's mail lane (lane_kind mail); null until the first mail.

own_unsubscribedboolean

Present ONLY for the person whose address is own for this instance (the holder; for an owned agent's own instance, its owner): true when they unsubscribed from the agent's mail. Absent for everyone else.

answer_policy'approve_each' | 'contacts_only' | 'anyone'

Present only on the instance an agent holds for itself (its front desk): who its own address answers.

pending_countinteger

Email contacts waiting for the holder's yes (0 for anyone who may not decide, an owned agent holding its own instance included).

Changes

No recorded changes to this operation across all 2 revisions of this API.