Messages

Get attachment

200 with a fresh URL once ready, 202 while the media is pending or processing. A card index is invalidRequest.

get/messages/{messageId}/attachments/{index}

Request

  • Base URL: https://inboxapp.com/api/v2
  • URL: https://inboxapp.com/api/v2/messages/{messageId}/attachments/{index}
  • Auth: HTTP bearer

Path parameters

messageIdstring required
indexinteger required

Response

OK

indexinteger required

The attachment's stable position in attachments, which GET /messages/{messageId}/attachments/{index} takes.

kind'image' | 'gif' | 'video' | 'audio' | 'file' required
filenamestring nullable required
contentTypestring nullable required
status'ready' | 'pending' | 'processing' | 'failed' required

ready once url is usable. pending and processing while Inboxapp stores a copy: resolve the attachment again later. failed when Inboxapp gave up.

urlstring nullable required

Set exactly when status is ready.

expiresAtstring date-time nullable required

When url stops working. Null for URLs that don't expire. Get a fresh URL from GET /messages/{messageId}/attachments/{index}.

Example response

{
  "contentType": "image/jpeg",
  "expiresAt": "2026-09-14T10:32:00.000Z",
  "poster": {
    "expiresAt": "2026-09-14T10:32:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.