The Files API allows you to list and delete files that have been uploaded to your team. Files are created by the Upload API and are referenced in process jobs. Deleting a file removes it from storage and cannot be undone.
Returns a paginated list of files belonging to your team.
Parameter Type Required Default Description pagenumber No 1 Page number (min: 1) limitnumber No 20 Items per page (min: 1, max: 100) sort_bystring No — Field to sort by (e.g. createdAt, filename) sort_orderstring No descSort direction: asc or desc searchstring No — Filter by filename created_afterstring No — ISO 8601 date — return files uploaded after this date created_beforestring No — ISO 8601 date — return files uploaded before this date fieldsstring No — Comma-separated list of fields to return includestring No — Related resources to include
curl -H "x-api-key: your_api_key_here" \
"https://api.exelensia.com/v1/files?page=1&limit=20"
{
"data" : [
{
"id" : "019760a0-0020-7000-8000-000000000020" ,
"filename" : "invoice_2024_01.pdf" ,
"mimetype" : "application/pdf" ,
"bytes" : 245760 ,
"status" : "READY" ,
"createdAt" : "2024-01-16T09:00:00.000Z" ,
"updatedAt" : "2024-01-16T09:00:15.000Z"
},
{
"id" : "019760a0-0021-7000-8000-000000000021" ,
"filename" : "contract_q1.docx" ,
"mimetype" : "application/vnd.openxmlformats-officedocument.wordprocessingml.document" ,
"bytes" : 87040 ,
"status" : "READY" ,
"createdAt" : "2024-01-16T08:30:00.000Z" ,
"updatedAt" : "2024-01-16T08:30:10.000Z"
}
],
"meta" : {
"page" : 1 ,
"limit" : 20 ,
"total" : 2 ,
"totalPages" : 1
}
}
Status Description PENDINGUpload initiated, waiting for confirmation READYFile uploaded successfully and available for processing FAILEDUpload failed
Status Description 200Success 401Missing or invalid authentication
Deletes a file by ID. This removes the file record and its stored content permanently. This action cannot be undone.
Warning: Deleting a file that has associated process jobs will not delete those jobs or their results. Existing results remain accessible.
Parameter Type Required Description idstring Yes File UUID
curl -X DELETE \
-H "x-api-key: your_api_key_here" \
"https://api.exelensia.com/v1/files/019760a0-0020-7000-8000-000000000020"
{
"message" : "File deleted successfully"
}
Status Description 200File deleted 401Missing or invalid authentication 404File not found