Skip to main content
GET
Get attachment

Path Parameters

messageId
string
required
Pattern: ^[0-9a-z]+$
index
integer
required
Required range: x >= 0

Response

An image, GIF, video, audio clip or file. Its url expires, so fetch it again when needed.

An image, GIF, video, audio clip or file. Its url expires, so fetch it again when needed.

index
integer
required

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

kind
enum<string>
required
Available options:
image,
gif,
video,
audio,
file
filename
string | null
required
contentType
string | null
required
Example:

"image/jpeg"

sizeBytes
required
width
required
height
required
aspectRatio
required

Width divided by height.

durationSeconds
required

Video and audio only.

status
enum<string>
required

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

Available options:
ready,
pending,
processing,
failed
url
string | null
required

Set exactly when status is ready.

expiresAt
string<date-time> | null
required

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

Example:

"2026-09-14T10:32:00.000Z"

poster
object | null
required

The still frame shown before a video plays. Video only, and only once usable.