List files
Cursor paginated, never offset. A short page does not mean the end: items the key may not read are dropped after the page is read, so page until hasMore is false.
Authorizations
Workspace-scoped API key, sent as a bearer token. The recommended header. The workspace is implicit in the key and never appears in a URL.
Query Parameters
Maximum items in one page. A page may come back shorter; read hasMore, not the count.
1 <= x <= 1000A nextCursor from an earlier page. Opaque: store and echo it, never parse or construct one. A cursor belongs to the query that issued it, so changing a filter means starting again from the first page; reusing one across filters answers invalid_cursor rather than a page from the wrong collection.
Exact path to a file, so it ends in .md. Returns the collection holding zero or one file: a path naming nothing is an empty collection, not a 404, because the request named no resource to be missing.
"/support/policies/refunds.md"
Every file below this folder, recursively. A folder path, so it does not end in .md. A prefix naming no folder is an empty collection, for the same reason path is.
"/support"
Files directly inside this folder, one level only. Use path_prefix for a whole subtree. A folder id naming nothing is an empty collection.
"dir_9f2k1x8b3m7q0v"
Response
A page of files. Read hasMore before stopping.
Type discriminator. Always list.
list The collection this page came from, without the query that selected it.
"/v1/files"
Whether more items remain. A short page does not mean the end: unreadable items are dropped after the page is read. Page until this is false.
Opaque. Pass back as cursor. Present whenever hasMore is true, null on the last page.
"c_9f2k1x8b3m7q0v"
The files on this page.