Read agent inbox
read_agent_inboxRead the mail that has arrived in an inbox from create_agent_inbox. Each message carries the sender, the subject, the arrival time in UTC, the cleaned text, any standalone 4 to 8 digit codes found in that text and any public http or https links. Attachments and raw headers are not stored. Set wait_seconds from 1 to 25 to wait for the next message, or zero to read immediately. An empty inbox is the ordinary answer before mail arrives and is not a failure. When truncated is true, at least one whole message was refused because the inbox had reached its 20 message cap or its 256 KiB total text cap. A code you are waiting for may then have been turned away rather than delayed. The reply names the public slug and never repeats the secret inbox_id. An unknown inbox_id and a wrong one fail in the same way, so neither can be told from the other, while an expired inbox says that it expired. No API key, account or sign up is required.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| inbox_id | Yes | The secret UUID that create_agent_inbox returned as inbox_id. Not the slug and not the address. | |
| wait_seconds | No | Wait up to this many seconds for new mail. Zero returns immediately. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| slug | Yes | ||
| address | Yes | ||
| messages | Yes | ||
| received | Yes | ||
| truncated | Yes | True once at least one whole message has been refused, by the 20 message cap or by the 256 KiB total text cap. Messages already stored are kept. | |
| wait_reason | Yes | ||
| waited_seconds | Yes | ||
| expire_timestamp | Yes | ||
| created_at_timestamp | Yes |