Skip to main content
GET
get_file_metadata

Authorizations

X-API-Key
string
header
required

Path Parameters

file_id
string<uuid>
required
workspace_id
string<uuid>
required

Workspace identifier.

Response

Successful Response

Ingestion-derived metadata for a source file.

representations answers "is this file actually searchable right now", which ingestion_status alone cannot: a file can be ingested while its graph generation is still building.

outputs lists every live derivation (retired_at IS NULL) so a caller knows exactly what exists at each instant without racing against a re-ingestion in progress.

file
File · object
required

A source file. The derived tree is platform-owned and has no CRUD surface.

lane
string
required

Which ingestion lane processed this file.

documents
FileDocumentMetadata · object[]
duration_ms
integer | null

For audio/video; null for document formats.

extracted_fields
ExtractedField · object[]
keywords
string[]

Lane-level keywords extracted during ingestion.

last_error
Error · object | null

The most recent ingestion error, if any.

media
FileMediaMetadata · object | null
outputs
ArtifactOutputRef · object[]
page_count
integer | null

For document formats; null for spreadsheets and media.

representations
RepresentationState · object

Whether each representation is current for a file.

Answers "is this file actually searchable right now", which ingestion_status alone cannot: a file can be ingested while its graph generation is still building.

sheet_names
string[] | null

For workbook formats; null for everything else.

sheets
FileSheetMetadata · object[]
summary
string | null

Lane-level summary extracted during ingestion.