List Files

How do I list all my files?

To list all your files, use the /files/list endpoint. Other than the API key for authorization, there are no additional parameters needed with listing files.

If you want to also include your directories, include 'include_directories' as 'true' in the request.

For more information about an individual file's info in the response, see the file info request docs.

Example response:

		
{
	"success": true,
	"files": [{
		"id": "hmxp3",
		"created_at": 1686858114000,
		"file_size": 569417,
		"file_type": "pdf",
		"name": "attention is all you need.pdf",
		"page_count": 11,
		"processed_state": "processed"
	}, {
		"id": "hy4wa",
		"created_at": 1686009068000,
		"file_size": 549686,
		"file_type": "txt",
		"name": "oliver.txt",
		"page_count": 1,
		"processed_state": "processed"
	}, {
		"id": "h1bsk",
		"created_at": 1686007097000,
		"file_size": 2027,
		"file_type": "csv",
		"name": "invoices.csv",
		"page_count": 1,
		"processed_state": "processed"
	}, {
		"id": "hkdzn",
		"created_at": 1682445964000,
		"file_size": 228339,
		"file_type": "pdf",
		"name": "FRB Earnings Release Q1 2023.pdf",
		"page_count": 17,
		"processed_state": "processed"
	}]
}
		
		

Ruby code to list files:

			
require 'net/http'
require 'uri'

uri = URI.parse("https://api1.docalysis.com/api/v1/files/list")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer your_api_key_here"

req_options = {
  use_ssl: true,
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

puts response.body