Skip to content

List Attachments

client.beta.attachments.list(AttachmentListParams { source_id, organization_id, page_size, 2 more } query, RequestOptionsoptions?): PaginatedCursor<AttachmentListResponse { name, size, last_modified } >
GET/api/v1/beta/attachments

List the attachments associated with a file (e.g. per-page screenshots).

ParametersExpand Collapse
query: AttachmentListParams { source_id, organization_id, page_size, 2 more }
source_id: string

File UUID or directory file ID (dfl-…).

organization_id?: string | null
page_size?: number | null
page_token?: string | null
project_id?: string | null
ReturnsExpand Collapse
AttachmentListResponse { name, size, last_modified }

Metadata for a single file attachment.

name: string

Name of the attachment

size: number

Size of the attachment in bytes

minimum0
last_modified?: string | null

When the attachment was last modified

formatdate-time

List Attachments

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const attachmentListResponse of client.beta.attachments.list({
  source_id: 'source_id',
})) {
  console.log(attachmentListResponse.name);
}
{
  "items": [
    {
      "name": "name",
      "size": 0,
      "last_modified": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Returns Examples
{
  "items": [
    {
      "name": "name",
      "size": 0,
      "last_modified": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/for-agents/mcp/ - Other LlamaIndex tooling for agents — the LlamaParse Platform MCP server, agent skills and plugins, and the n8n node — is mapped at https://developers.llamaindex.ai/for-agents/