Get File
Fetch a file by its ID.
Bearer authentication of the form Bearer <token>, where token is your auth token.
ID for the file. It will always start with "file_".
Example: "file_Xj8mK2pL9nR4vT7qY5wZ"
Deprecated: Use POST /parse_runs instead to parse file contents.
If set to true, the raw text content of the file will be included in the response.
Deprecated: Use POST /parse_runs instead to parse file contents.
If set to true, the markdown content of the file will be included in the response.
Only available for files with a type of PDF, IMG, or DOCX files that were auto-converted to PDFs.
Deprecated: Use POST /parse_runs instead to parse file contents.
If set to true, the html content of the file will be included in the response.
Only available for files with a type of DOCX.
The type of object. Will always be "file".
ID for the file.
Example: "file_xK9mLPqRtN3vS8wF5hB2cQ"
The name of the file
Example: "Invoices.pdf"
The type of the file.
Availability: Present when the file type could be determined.
A presigned URL to download the file. Expires after 15 minutes.
Availability: Present on GET /files/{id}. Not present on POST /files/upload or when the file is embedded in other resources (e.g., in run responses).
ID of the parent file.
Availability: Present for files created via a Splitter in a workflow.
The time (in UTC) at which the object was created. Will follow the RFC 3339 format.
Example: "2024-03-21T16:45:00Z"
The time (in UTC) at which the object was last updated. Will follow the RFC 3339 format.
Example: "2024-03-21T16:45:00Z"
Deprecated: Use the POST /parse_runs endpoint instead to parse and retrieve file contents. The parse runs endpoint provides more control over parsing configuration and better performance.
The parsed content of the file. This field will only contain data after the file has been parsed via a parse run, extract run, classify run, split run, edit run, or workflow run.
Availability: Only present and populated on GET /files/{id} when the file has been previously parsed and the corresponding query parameters are set to true. Will be null on POST /files/upload and for files that haven’t been parsed. The structure varies based on file type.
API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.
The workspace ID to target. Required when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See Authentication for details on API key scopes.