List Files

List files.

Authentication

AuthorizationBearer

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

Query parameters

nameContainsstringOptional

Filters files to only include those that contain the given string in the name.

Example: "invoice"

sortDirenumOptionalDefaults to desc

Sort in ascending or descending order. Ascending order means the earliest result is returned first.

Allowed values:

nextPageTokenstringOptional

The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.

Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.

maxPageSizeintegerOptional1-1000Defaults to 10

The maximum number of results to return in the response. You may receive less than this number if there are fewer results than the maximum.

Response

List of files

objectenum

Allowed values:

datalist of objects

nextPageTokenstring or null

The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.

Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.

1	import { ExtendClient, ExtendEnvironment } from "extend-ai";
2
3	async function main() {
4	const client = new ExtendClient({
5	environment: ExtendEnvironment.Production,
6	token: "YOUR_TOKEN_HERE",
7	});
8	await client.files.list({});
9	}
10	main();

1	{
2	"object": "list",
3	"data": [
4	{
5	"object": "file",
6	"id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
7	"name": "Invoices.pdf",
8	"type": "PDF",
9	"parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
10	"metadata": {
11	"pageCount": 30,
12	"parentSplit": {
13	"id": "string",
14	"type": "Invoice",
15	"identifier": "other_2_9",
16	"startPage": 1,
17	"endPage": 10
18	}
19	},
20	"createdAt": "2024-03-21T16:45:00Z",
21	"updatedAt": "2024-03-21T16:45:00Z"
22	}
23	],
24	"nextPageToken": "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
25	}

Authentication

Headers

Query parameters

Response

Errors