Skip to content

Get Attachment

client.beta.attachments.get(stringattachmentName, AttachmentGetParams { source_id, organization_id, project_id } query, RequestOptionsoptions?): PresignedURL { expires_at, url, form_fields }
GET/api/v1/beta/attachments/{attachment_name}

Return a presigned download URL for a specific attachment.

ParametersExpand Collapse
attachmentName: string
query: AttachmentGetParams { source_id, organization_id, project_id }
source_id: string

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

organization_id?: string | null
project_id?: string | null
ReturnsExpand Collapse
PresignedURL { expires_at, url, form_fields }

Schema for a presigned URL.

expires_at: string

The time at which the presigned URL expires

formatdate-time
url: string

A presigned URL for IO operations against a private file

formaturi
minLength1
form_fields?: Record<string, string> | null

Form fields for a presigned POST request

Get Attachment

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
});

const presignedURL = await client.beta.attachments.get('attachment_name', {
  source_id: 'source_id',
});

console.log(presignedURL.expires_at);
{
  "expires_at": "2019-12-27T18:11:19.117Z",
  "url": "https://example.com",
  "form_fields": {
    "foo": "string"
  }
}
Returns Examples
{
  "expires_at": "2019-12-27T18:11:19.117Z",
  "url": "https://example.com",
  "form_fields": {
    "foo": "string"
  }
}
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/