List Files | Captain API Documentation

List all indexed files in a database.

Returns all files that have been indexed into the database (excludes soft-deleted files where is_deleted=true).

Headers:

Authorization: Bearer {api_key} - Captain API key for authentication
X-Organization-ID: Organization UUID

Args: database_name: Name of the database to list files from limit: Maximum number of files to return (default 100) offset: Offset for pagination (default 0)

Returns: List of file objects with file_id, file_name, created_at, updated_at

List all indexed files in a database. Returns all files that have been indexed into the database (excludes soft-deleted files where is_deleted=true). Headers: - Authorization: Bearer {api_key} - Captain API key for authentication - X-Organization-ID: Organization UUID Args: database_name: Name of the database to list files from limit: Maximum number of files to return (default 100) offset: Offset for pagination (default 0) Returns: List of file objects with file_id, file_name, created_at, updated_at

Headers

AuthorizationstringRequired

Captain API key for authentication

X-Organization-IDstringRequired

Organization UUID

Request

This endpoint expects an object.

database_namestringRequired

limitinteger or nullOptionalDefaults to 100

offsetinteger or nullOptionalDefaults to 0

Response

Successful Response

1	curl -X POST https://api.runcaptain.com/v1/list-files \
2	-H "Authorization: Bearer YOUR_API_KEY" \
3	-H "X-Organization-ID: YOUR_ORG_UUID" \
4	-H "Content-Type: application/x-www-form-urlencoded" \
5	-d "database_name=contracts_2024" \
6	-d "limit=50" \
7	-d "offset=0"

1	[
2	{
3	"file_id": "file_abc123",
4	"file_name": "Acme_Corp_Contract.pdf",
5	"chunk_id": "chunk_abc123",
6	"chunk_index": 0,
7	"created_at": "2024-01-15T10:30:00Z",
8	"updated_at": "2024-01-15T10:30:00Z"
9	}
10	]

Headers

Request

Response

Errors