IngestedFileListItem

A file as a partition’s file listing returns it: everything about the file and how far it has got through processing, without the extracted text (which can be megabytes). Read GET /files/by-id/{id} for that.

Kind: an object, used in responses.

Fields

Every field is present in a response; empty ones are null.

Field	Type	Description
`id`	`uuid`	The file’s id.
`tenantId`	`uuid`	The tenant that owns the file.
`userCreatedById`	`uuid`	The user who uploaded the file.
`partitionId`	`uuid`	The partition the file belongs to.
`name`	`string`	The file’s name.
`contentType`	`string`	The file’s MIME type.
`size`	`integer`	The file’s size, in bytes.
`type`	`IngestedFileType`	What kind of document it is.
`version`	`integer`	The file’s version: 1 on upload, and one more each time its content is replaced with something different.
`dateCreated`	`datetime`	When the file was uploaded (UTC).
`dateUpdated`	`datetime`	When the file last changed (UTC), including progress through processing.
`isImageDescriptionRequired`	`boolean`	True while an image is waiting to be described in words, so it can be searched.
`imageDescriptionTime`	`datetime \| null`	When the image was described (UTC). Null for other files, and until it has been.
`isTrainingDataGenerated`	`boolean`	Not used: always false.
`trainingDataTime`	`datetime \| null`	Not used: always null.
`isVectorGenerated`	`boolean`	True once the file has been embedded and can be found by search.
`vectorGenerationTime`	`datetime \| null`	When the file was last embedded (UTC). Null until it has been.
`indexingFailure`	`IngestedFileIndexingFailure\| null`	Why the file cannot be indexed until someone acts (see `IngestedFile.IndexingFailure`).
`isChunkingRequired`	`boolean`	True while the file is waiting to be split into chunks before it is embedded.
`chunkGenerationTime`	`datetime \| null`	When the file was split into chunks (UTC). Null until it has been, or if it did not need to be.
`isTemporary`	`boolean`	True for a temporary partition’s file: never indexed, and removed at `expiresAt`.
`expiresAt`	`datetime \| null`	When a temporary file is removed (UTC). Null on every file of an ordinary partition.
`webSource`	`IngestedFileWebSource\| null`	Where a web download came from; null for an uploaded file.

Example

{
  "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "tenantId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "userCreatedById": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "partitionId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "name": "...",
  "contentType": "...",
  "size": 0,
  "type": "WordDocument",
  "version": 0,
  "dateCreated": "2026-10-26T12:00:00.0000000Z",
  "dateUpdated": "2026-10-26T12:00:00.0000000Z",
  "isImageDescriptionRequired": false,
  "imageDescriptionTime": "2026-10-26T12:00:00.0000000Z",
  "isTrainingDataGenerated": false,
  "trainingDataTime": "2026-10-26T12:00:00.0000000Z",
  "isVectorGenerated": false,
  "vectorGenerationTime": "2026-10-26T12:00:00.0000000Z",
  "indexingFailure": {
    "code": "...",
    "message": "...",
    "dateFailed": "2026-10-26T12:00:00.0000000Z"
  },
  "isChunkingRequired": false,
  "chunkGenerationTime": "2026-10-26T12:00:00.0000000Z",
  "isTemporary": false,
  "expiresAt": "2026-10-26T12:00:00.0000000Z",
  "webSource": {
    "url": "...",
    "finalUrl": "...",
    "title": "...",
    "kind": "Page",
    "route": "Datacenter",
    "processType": "App",
    "processId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
    "agentName": "...",
    "isTextCapped": false
  }
}

Where it’s used

Inside IngestedFilePage