Files and media
List files
Return the files stored in the File Center, newest first.
Returns the workspace File Center: images, documents, videos and audio the team uploaded for sending to customers or for the AI to attach, with each file purpose and description. Use it to find a file before attaching it to a message. Archived files are not listed. Read-only. Paginated: follow meta.pagination.nextCursor until hasMore is false.
query Parameters
limitRows to return, 1-100. Defaults to 25.
Rows to return, 1-100. Defaults to 25.
cursorThe meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
The meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
qMatch against the file name, case-insensitive.
Match against the file name, case-insensitive.
typeOnly this kind of file: image, document, video or audio.
Only this kind of file: image, document, video or audio.
List files › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successResolve a file to its URL
Return the public URL, type and name of one File Center file.
Looks up one file by id and returns the URL to attach to an outgoing message, plus its type, name and mime type. Use it after files.list to turn a file id into something the messages.* operations can send. Read-only; it sends nothing.
path Parameters
idFile id from files.list.
File id from files.list.
Resolve a file to its URL › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successArchive a file
Remove a file from the File Center.
Archives a File Center file so it disappears from files.list and can no longer be picked for new messages. Messages already sent are unaffected. There is no public operation to restore it, so confirm with the user first.
path Parameters
idFile id from files.list.
File id from files.list.
Archive a file › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successEdit file details
Rename a file or change its purpose and description.
Updates the name, purpose or description of a File Center file. The purpose text tells the AI when to attach the file, so editing it changes how the AI answers customers. Send only the fields to change; send null to clear purpose or description. It does not replace the file content and sends nothing.
path Parameters
idFile id from files.list.
File id from files.list.
Edit file details › Request Body optional
filenameNew file name, including its extension.
purposeWhen the AI should attach this file. null clears it.
descriptionFree-text note about the file. null clears it.
Edit file details › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successLook up WhatsApp media
Resolve a WhatsApp media id from an incoming message to its download details.
Asks WhatsApp for the temporary download URL and mime type of a media id that arrived in a message. Use it to read an image or document a customer sent. The URL expires within minutes and needs the workspace WhatsApp token to download, so most agents should read the media URL already on the message instead. Calls Meta, so it is rate limited as expensive. Read-only. Fails if no WhatsApp account is connected.
path Parameters
mediaIdWhatsApp media id taken from a message.
WhatsApp media id taken from a message.
Look up WhatsApp media › Responses
The API key is missing, malformed, expired, or its owner is inactive.
success