Get File | Extend Documentation

{
  "success": true,
  "file": {
    "object": "file",
    "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
    "name": "Invoices.pdf",
    "metadata": {
      "pageCount": 30,
      "parentSplit": {
        "id": "string",
        "type": "Invoice",
        "identifier": "other_2_9",
        "startPage": 1,
        "endPage": 10
      }
    },
    "createdAt": "2024-03-21T15:30:00Z",
    "updatedAt": "2024-03-21T16:45:00Z",
    "type": "PDF",
    "presignedUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
    "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
    "contents": {
      "rawText": "string",
      "markdown": "string",
      "pages": [
        {
          "pageNumber": 1,
          "pageHeight": 10,
          "pageWidth": 10,
          "rawText": "This is the raw text of the page.",
          "markdown": "# Heading\n\nThis is a paragraph with **bold** and *italic* text.\n\n- List item 1\n- List item 2\n\n> This is a blockquote",
          "html": "<div>This is the html of the page.</div>"
        }
      ],
      "sheets": [
        {
          "sheetName": "Sheet1",
          "rawText": "This is the raw text of the sheet."
        }
      ]
    },
    "usage": {
      "credits": 10
    }
  }
}

Fetch a file by its ID to obtain additional details and the raw file content.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Extend’s ID for the file. It will always start with "file_". This ID is returned when creating a new File, or the value on the fileId field in a WorkflowRun.

Example: "file_Xj8mK2pL9nR4vT7qY5wZ"

Query parameters

rawTextbooleanOptionalDefaults to 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.

markdownbooleanOptionalDefaults to 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.

htmlbooleanOptionalDefaults to 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.

Only available for files with a type of DOCX.

Response

Successfully retrieved file

successboolean

fileobject

Errors

401

Unauthorized Error

404

Not Found Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors