Skip to main content
GET
Inspect one conversation message attachment

Authorizations

Authorization
string
header
required

Server-side tenant-scoped credential created from Build > API Keys.

Path Parameters

conversationId
string
required

Stored conversationId from list_conversations; keep the connected business and conversation unchanged for continuation reads.

Required string length: 1 - 200
messageId
string
required

Stored 24-character messageId from list_conversation_messages or get_message_request_status; never a provider externalMessageId or requestEventId.

Pattern: ^[a-fA-F0-9]{24}$
attachmentIndex
integer
required

media[].attachmentIndex from the selected message in list_conversation_messages; do not infer it from a display-card position.

Required range: 0 <= x <= 199

Query Parameters

includeContent
boolean
default:false

Default false returns metadata and stored extracted context. Set true only to inspect the bounded stored file or image pixels.

Response

Attachment metadata and optional bounded content

conversationId
string
required
messageId
string
required
attachmentIndex
integer
required
attachment
object
required
contentStatus
enum<string>
required
Available options:
not_requested,
pending,
failed,
timed_out,
unavailable,
ready,
too_large,
unsupported,
download_failed,
content_mismatch
transcriptTruncated
boolean
content
object