Files API (NEW)
Get File Information
Retrieve detailed information about a specific file
GET
Get File Information
GET /files/{file_id}
Retrieve detailed information about a specific file, including metadata, processing status, and validation results.
Features
- Complete file metadata
- Processing status tracking
- Validation results
- User ownership validation
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
file_id | string | Yes | Unique identifier of the file |
Request
Response
Response Fields
Field | Type | Description |
---|---|---|
id | string | Unique file identifier |
filename | string | Original filename |
file_id | string | Internal file storage identifier |
type | string | Document type (auto-detected) |
status | string | Current processing status |
size | integer | File size in bytes |
created_at | string | Upload timestamp (ISO 8601) |
completed_at | string | Processing completion timestamp |
processed_data | object | Extracted document data (when processing is complete) |
Status Values
Status | Description |
---|---|
pending | File uploaded, waiting for processing |
processing | Currently being processed |
completed | Processing finished successfully |
failed | Processing failed |
deleted | File has been soft-deleted |
Try It Out
Use the interactive playground above to test the get file information endpoint. You can:
- Add your API key in the Authorization header
- Enter a file ID in the path parameter (use a UUID from your uploaded files)
- Execute the request to see detailed file information
The response will include processing status and extracted data if available.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique identifier of the file
Response
200 - application/json
File information retrieved successfully
The response is of type object
.