Skip to main content
Get File
curl --request GET \
  --url https://api-prod.extend.app/files/:id \
  --header 'Authorization: Bearer <token>'
{
  "object": "file",
  "id": "file_1234",
  "name": "example_file",
  "type": "PDF",
  "presignedUrl": "https://s3.example.com/file_1234.pdf",
  "parentFileId": "file_5678", // Optional, only set if this file is a derivative of another file
  "contents": {
    "rawText": "This is the raw text content of the file...",
    "pages": [
      {
        "pageNumber": 1,
        "markdown": "This is the markdown content of the page...",
      }
    ]
  },
  "metadata": {
    "parentSplit": { // Optional, only set if this file is a derivative of another file
      "id": "324kjlfsd",
      "type": "addendum",
      "identifier": "addendum_1",
      "startPage": 7,
      "endPage": 9
    }
  }
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.extend.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Path

​
id
string
The ID of the File to fetch. This is the ID returned when creating a new File or the value on fileId of a WorkflowRun object.

​
Query Parameters

You can add additional parameters to the request to modify the file contents returned. Currently only rawText is supported.
​
markdown
boolean
default:"false"
If set to true, the markdown content of the file will be included in the response. This is useful for indexing very clean content into RAG pipelines for files like PDFs, Word Documents, etc.*Only available for files with a type of PDF, IMG.*or .doc/.docx files that were auto-converted to PDFs.
​
rawText
boolean
default:"false"
If set to true, the raw text content of the file will be included in the response. This is useful for indexing text-based files like PDFs, Word Documents, etc.
​
html
boolean
default:"false"
If set to true, the html content of the file will be included in the response. This is useful for indexing html content into RAG pipelines for files like PDFs, Word Documents, etc.*Only available for files with a type of DOCX.

​
Response

​
success
boolean
A true or false value for whether the file was fetched successfully or not.
​
file
File
A File object representing the fetched file. See the File object for more details.
{
  "object": "file",
  "id": "file_1234",
  "name": "example_file",
  "type": "PDF",
  "presignedUrl": "https://s3.example.com/file_1234.pdf",
  "parentFileId": "file_5678", // Optional, only set if this file is a derivative of another file
  "contents": {
    "rawText": "This is the raw text content of the file...",
    "pages": [
      {
        "pageNumber": 1,
        "markdown": "This is the markdown content of the page...",
      }
    ]
  },
  "metadata": {
    "parentSplit": { // Optional, only set if this file is a derivative of another file
      "id": "324kjlfsd",
      "type": "addendum",
      "identifier": "addendum_1",
      "startPage": 7,
      "endPage": 9
    }
  }
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}