GET
/
files
/
{file_id}
curl --request GET \
  --url https://api.invaro.ai/api/v1/files/{file_id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "id": "72f574a0-b3d2-4a0f-8527-f542e6ea7500",
    "filename": "invoice.pdf",
    "file_id": "1234567890_invoice.pdf",
    "type": "invoice",
    "status": "completed",
    "size": 84898,
    "created_at": "2024-01-07T10:00:00Z",
    "completed_at": "2024-01-07T10:05:00Z",
    "processed_data": {}
  }
}

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

ParameterTypeRequiredDescription
file_idstringYesUnique identifier of the file

Request

curl "https://api.invaro.ai/api/v1/files/72f574a0-b3d2-4a0f-8527-f542e6ea7500" \
  -H "Authorization: Bearer your_api_key"

Response

{
  "success": true,
  "data": {
    "id": "72f574a0-b3d2-4a0f-8527-f542e6ea7500",
    "filename": "invoice.pdf",
    "file_id": "1234567890_invoice.pdf",
    "type": "invoice",
    "status": "completed",
    "size": 84898,
    "created_at": "2024-01-07T10:00:00Z",
    "completed_at": "2024-01-07T10:05:00Z",
    "processed_data": {
      // Extracted document data
    }
  }
}

Response Fields

FieldTypeDescription
idstringUnique file identifier
filenamestringOriginal filename
file_idstringInternal file storage identifier
typestringDocument type (auto-detected)
statusstringCurrent processing status
sizeintegerFile size in bytes
created_atstringUpload timestamp (ISO 8601)
completed_atstringProcessing completion timestamp
processed_dataobjectExtracted document data (when processing is complete)

Status Values

StatusDescription
pendingFile uploaded, waiting for processing
processingCurrently being processed
completedProcessing finished successfully
failedProcessing failed
deletedFile has been soft-deleted

Try It Out

Use the interactive playground above to test the get file information endpoint. You can:

  1. Add your API key in the Authorization header
  2. Enter a file ID in the path parameter (use a UUID from your uploaded files)
  3. Execute the request to see detailed file information

The response will include processing status and extracted data if available.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

file_id
string
required

Unique identifier of the file

Response

200 - application/json

File information retrieved successfully

The response is of type object.