GET · Bearer

GET /api/v1/inboxes/:id/wait

All endpoints · Markdown

Summary

Hold until unread mail is stored, then return it. If unread mail is already there, the response is immediate. Query wait is an integer from 0 to 55 and defaults to 25. The response is object inbox_wait with inbox_id, timed_out, and data. The server checks about once a second and stops at 55 seconds so the route can finish inside its 60 second limit. A key can hold at most 5 waits at once; the next returns HTTP 429 rate_limited. MCP: cooper_list_messages wait_seconds. GET /api/v1/events?wait= still caps at 25 seconds.

Request

This call has no JSON body.

Response

HTTP 200. Sample values illustrate the schema.

{
  "object": "inbox_wait",
  "inbox_id": "inb_example",
  "timed_out": false,
  "data": "string"
}

Errors

  • HTTP 429 rate_limited

Idempotency

This route does not document Idempotency-Key or client_id.