DeepFellow DOCS

Retrieve text from file

Return the text or Markdown of the specified file.

The file is converted on first use and the converted document is kept, so later calls - and any ingestion into a vector store or the knowledge graph - reuse it instead of converting again. Known limitation: once chunks.json has been cached (by a vector-store/graph ingestion, or a prior /text call), the document is never reconverted even to add image descriptions it's missing, since /fragment depends on the document and chunk list staying paired; a first image_mode=descriptions call is only guaranteed to include descriptions if it happens before anything else caches chunks for this file.

GET
/v1/files/{file_id}/text
Authorization[Bearer <token>]

In: header

Path Parameters

file_id[string]

The ID of the file to use for this request.

Match^[0-9a-fA-F]{24}$

Query Parameters

image_mode?["none" | "descriptions" | "embedded" | "referenced"]

How images are represented in the output.

Default"none"
Value in"none" | "descriptions" | "embedded" | "referenced"
output_format?["txt" | "md"]

Output format: plain text or Markdown.

Default"txt"
Value in"txt" | "md"

Header Parameters

OpenAI-Organization?[string | null]

Organization Id from OpenAi compatible endpoint. Required to organization access or project access (with OpenAI-Project header) when logged as User or Admin User.

OpenAI-Project?[string | null]

Project Id from OpenAi compatible endpoint. Required to project access for organization api key or User / Admin User access with OpenAI-Organization

Response Body

curl -X GET "https://deepfellow-server-host/v1/files/5eb7cf5a86d9755df3a6c593/text?image_mode=none&output_format=txt" \  -H "OpenAI-Organization: string" \  -H "OpenAI-Project: string"
"string"
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.